Classes

Files

Class YAHOO.util.DDProxy

Object
   |
   +--YAHOO.util.DragDrop
         |
         +--YAHOO.util.DD
               |
               +--YAHOO.util.DDProxy
class YAHOO.util.DDProxy
extends YAHOO.util.DD
Quick Links:  Field Summary | Constructor Summary | Method Summary | Method Details

Field Summary [top]

boolean centerFrame
By default the frame is positioned exactly where the drag element is, so we use the cursor offset provided by YAHOO.util.DD. 
boolean resizeFrame
By default we resize the drag frame to be the same size as the element we want to drag (this is to get the frame effect). 
String dragElId
The default drag frame div id 

Fields inherited from class YAHOO.util.DD [top]

scroll

Fields inherited from class YAHOO.util.DragDrop [top]

id, config, invalidHandleTypes, invalidHandleIds, invalidHandleClasses, groups, isTarget, padding, maintainOffset, xTicks, yTicks, primaryButtonOnly, available

Constructor Summary [top]

YAHOO.util.DDProxy
A DragDrop implementation that inserts an empty, bordered div into the document that follows the cursor during drag operations. 

Method Summary [top]

void _resizeProxy ()
 
void applyConfig ()
Applies the configuration parameters that were passed into the constructor. 
void b4EndDrag (e)
 
void b4MouseDown (e)
Event that fires prior to the onMouseDown event. 
void b4StartDrag (x, y)
 
void createFrame ()
Create the drag frame if needed 
void endDrag (<Event> e)
Fired when we are done dragging the object 
void initFrame ()
Initialization for the drag frame element. 
Object toString ()
toString method 

Methods inherited from class YAHOO.util.DD

autoOffset, setDelta, setDragElPos, alignElWithMouse, cachePosition, b4Drag

Methods inherited from class YAHOO.util.DragDrop

lock, unlock, startDrag, onDrag, onDragEnter, onDragOver, onDragOut, onDragDrop, onMouseDown, onMouseUp, onAvailable, getEl, getDragEl, init, initTarget, setPadding, setInitPosition, addToGroup, removeFromGroup, setDragElId, setHandleElId, setOuterHandleElId, unreg, isLocked, addInvalidHandleType, addInvalidHandleId, addInvalidHandleClass, removeInvalidHandleType, removeInvalidHandleId, removeInvalidHandleClass, isValidHandleChild, setXConstraint, clearConstraints, clearTicks, setYConstraint, resetConstraints

Field Detail [top]

centerFrame

boolean   centerFrame
By default the frame is positioned exactly where the drag element is, so we use the cursor offset provided by YAHOO.util.DD. Another option that works only if you do not have constraints on the obj is to have the drag frame centered around the cursor. Set centerFrame to true for this effect.

resizeFrame

boolean   resizeFrame
By default we resize the drag frame to be the same size as the element we want to drag (this is to get the frame effect). We can turn it off if we want a different behavior.

dragElId

String   dragElId
The default drag frame div id

Constructor Detail [top]

YAHOO.util.DDProxy

YAHOO.util.DDProxy ()
A DragDrop implementation that inserts an empty, bordered div into the document that follows the cursor during drag operations. At the time of the click, the frame div is resized to the dimensions of the linked html element, and moved to the exact location of the linked element. References to the "frame" element refer to the single proxy element that was created to be dragged in place of all DDProxy elements on the page.
Parameters:
id - the id of the linked html element
sGroup - the group of related DragDrop objects
config - an object containing configurable attributes Valid properties for DDProxy in addition to those in DragDrop: resizeFrame, centerFrame, dragElId

Method Detail [top]

_resizeProxy

void _resizeProxy ()

applyConfig

void applyConfig ()
Applies the configuration parameters that were passed into the constructor. This is supposed to happen at each level through the inheritance chain. So a DDProxy implentation will execute apply config on DDProxy, DD, and DragDrop in order to get all of the parameters that are available in each object.

b4EndDrag

void b4EndDrag (e)

b4MouseDown

void b4MouseDown (e)
Event that fires prior to the onMouseDown event. Overrides YAHOO.util.DragDrop.

b4StartDrag

void b4StartDrag (x, y)

createFrame

void createFrame ()
Create the drag frame if needed

endDrag

void endDrag (<Event> e)
Fired when we are done dragging the object
Parameters:
e -

initFrame

void initFrame ()
Initialization for the drag frame element. Must be called in the constructor of all subclasses

toString

Object toString ()
toString method
Returns:
string representation of the dd obj