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.
|
DDProxy.dragElId : String |
DDProxy |
<static> The default drag frame div id |
|
available : boolean |
DragDrop |
The availabe property is false until the linked dom element is accessible. |
|
centerFrame : boolean |
DDProxy |
By default the frame is positioned exactly where the drag element is, so
we use the cursor offset provided by Ext.dd.... |
|
config : object |
DragDrop |
Configuration attributes passed into the constructor |
|
groups : string: |
DragDrop |
The group defines a logical collection of DragDrop objects that are
related. Instances only get events when interact... |
|
hasOuterHandles : boolean |
DragDrop |
By default, drags can only be initiated if the mousedown occurs in the
region the linked element is. This is done in... |
|
id : String |
DragDrop |
The id of the element associated with this object. This is what we
refer to as the "linked element" because the size... |
|
invalidHandleClasses : string[] |
DragDrop |
An indexted array of css class names for elements that will be ignored
if clicked. |
|
invalidHandleIds : string: |
DragDrop |
An associative array of ids for elements that will be ignored if clicked |
|
invalidHandleTypes : string: |
DragDrop |
An associative array of HTML tags that will be ignored if clicked. |
|
maintainOffset : boolean |
DragDrop |
Maintain offsets when we resetconstraints. Set to true when you want
the position of the element relative to its par... |
|
primaryButtonOnly : boolean |
DragDrop |
By default the drag and drop instance will only respond to the primary
button click (left button for a right-handed m... |
|
resizeFrame : boolean |
DDProxy |
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 effe... |
|
scroll : boolean |
DD |
When set to true, the utility automatically tries to scroll the browser
window wehn a drag and drop element is dragge... |
|
xTicks : int[] |
DragDrop |
Array of pixel locations the element will snap to if we specified a
horizontal graduation/interval. This array is ge... |
|
yTicks : int[] |
DragDrop |
Array of pixel locations the element will snap to if we specified a
vertical graduation/interval. This array is gene... |
|
DDProxy( String id , String sGroup , object config ) |
DDProxy |
|
|
addInvalidHandleClass( string cssClass ) : void |
DragDrop |
Lets you specify a css class of elements that will not initiate a drag |
|
addInvalidHandleId( string id ) : void |
DragDrop |
Lets you to specify an element id for a child of a drag handle
that should not initiate a drag |
|
addInvalidHandleType( string tagName ) : void |
DragDrop |
Allows you to specify a tag name that should not start a drag operation
when clicked. This is designed to facilitate... |
|
addToGroup( sGroup {string} ) : void |
DragDrop |
Add this instance to a group of related drag/drop objects. All
instances belong to at least one group, and can belon... |
|
alignElWithMouse( HTMLElement el , int iPageX , int iPageY ) : void |
DD |
Sets the element to the location of the mousedown or click event,
maintaining the cursor location relative to the loc... |
|
applyConfig() : void |
DragDrop |
Applies the configuration parameters that were passed into the constructor.
This is supposed to happen at each level ... |
|
autoOffset( int iPageX , int iPageY ) : void |
DD |
Sets the pointer offset to the distance between the linked element's top
left corner and the location the element was... |
|
cachePosition( iPageX the , iPageY the ) : void |
DD |
Saves the most recent position so that we can reset the constraints and
tick marks on-demand. We need to know this s... |
|
clearConstraints() : void |
DragDrop |
Clears any constraints applied to this instance. Also clears ticks
since they can't exist independent of a constrain... |
|
clearTicks() : void |
DragDrop |
Clears any tick interval defined for this instance |
|
createFrame() : void |
DDProxy |
Creates the proxy element if it does not yet exist |
|
endDrag( Event e ) : void |
DragDrop |
Fired when we are done dragging the object |
|
getDragEl() : HTMLElement |
DragDrop |
Returns a reference to the actual element to drag. By default this is
the same as the html element, but it can be as... |
|
getEl() : HTMLElement |
DragDrop |
Returns a reference to the linked element |
|
init( id the , String sGroup , object config ) : void |
DragDrop |
Sets up the DragDrop object. Must be called in the constructor of any
Ext.dd.DragDrop subclass |
|
initFrame() : void |
DDProxy |
Initialization for the drag frame element. Must be called in the
constructor of all subclasses |
|
initTarget( id the , String sGroup , object config ) : void |
DragDrop |
Initializes Targeting functionality only... the object does not
get a mousedown handler. |
|
isLocked() : boolean |
DragDrop |
Returns true if this instance is locked, or the drag drop mgr is locked
(meaning that all drag/drop is disabled on th... |
|
isTarget() : void |
DragDrop |
By default, all insances can be a drop target. This can be disabled by
setting isTarget to false. |
|
isValidHandleChild( HTMLElement node ) : boolean |
DragDrop |
Checks the tag exclusion list to see if this click should be ignored |
|
lock() : void |
DragDrop |
Lock this instance |
|
onAvailable() : void |
DragDrop |
Override the onAvailable method to do what is needed after the initial
position was determined. |
|
onDrag( Event e ) : void |
DragDrop |
Abstract method called during the onMouseMove event while dragging an
object. |
|
onDragDrop( Event e , String|DragDrop[] id ) : void |
DragDrop |
Abstract method called when this item is dropped on another DragDrop
obj |
|
onDragEnter( Event e , String|DragDrop[] id ) : void |
DragDrop |
Abstract method called when this element fist begins hovering over
another DragDrop obj |
|
onDragOut( Event e , String|DragDrop[] id ) : void |
DragDrop |
Abstract method called when we are no longer hovering over an element |
|
onDragOver( Event e , String|DragDrop[] id ) : void |
DragDrop |
Abstract method called when this element is hovering over another
DragDrop obj |
|
onInvalidDrop( Event e ) : void |
DragDrop |
Abstract method called when this item is dropped on an area with no
drop target |
|
onMouseDown( Event e ) : void |
DragDrop |
Event handler that fires when a drag/drop obj gets a mousedown |
|
onMouseUp( Event e ) : void |
DragDrop |
Event handler that fires when a drag/drop obj gets a mouseup |
|
padding() : void |
DragDrop |
The padding configured for this drag and drop object for calculating
the drop zone intersection with this object. |
|
removeFromGroup( string sGroup ) : void |
DragDrop |
Remove's this instance from the supplied interaction group |
|
removeInvalidHandleClass( string cssClass ) : void |
DragDrop |
Unsets an invalid css class |
|
removeInvalidHandleId( string id ) : void |
DragDrop |
Unsets an invalid handle id |
|
removeInvalidHandleType( string tagName ) : void |
DragDrop |
Unsets an excluded tag name set by addInvalidHandleType |
|
resetConstraints( boolean maintainOffset ) : void |
DragDrop |
resetConstraints must be called if you manually reposition a dd element. |
|
setDelta( int iDeltaX , int iDeltaY ) : void |
DD |
Sets the pointer offset. You can call this directly to force the
offset to be in a particular location (e.g., pass i... |
|
setDragElId( id {string} ) : void |
DragDrop |
Allows you to specify that an element other than the linked element
will be moved with the cursor during a drag |
|
setDragElPos( int iPageX , int iPageY ) : void |
DD |
Sets the drag element to the location of the mousedown or click event,
maintaining the cursor location relative to th... |
|
setHandleElId( id {string} ) : void |
DragDrop |
Allows you to specify a child of the linked element that should be
used to initiate the drag operation. An example o... |
|
setInitialPosition( int diffX , int diffY ) : void |
DragDrop |
Stores the initial placement of the linked element. |
|
setOuterHandleElId( id the ) : void |
DragDrop |
Allows you to set an element outside of the linked element as a drag
handle |
|
setPadding( int iTop , int iRight , int iBot , int iLeft ) : void |
DragDrop |
Configures the padding for the target zone in px. Effectively expands
(or reduces) the virtual object size for targe... |
|
setXConstraint( int iLeft , int iRight , int iTickSize ) : void |
DragDrop |
By default, the element can be dragged any place on the screen. Use
this method to limit the horizontal travel of th... |
|
setYConstraint( int iUp , int iDown , int iTickSize ) : void |
DragDrop |
By default, the element can be dragged any place on the screen. Set
this to limit the vertical travel of the element... |
|
startDrag( int X , int Y ) : void |
DragDrop |
Abstract method called after a drag/drop object is clicked
and the drag or mousedown time thresholds have beeen met. |
|
toString() : string |
DragDrop |
toString method |
|
unlock() : void |
DragDrop |
Unlock this instace |
|
unreg() : void |
DragDrop |
Remove all drag and drop hooks for this element |
This class has no public events.
DDProxy.dragElId
public String DDProxy.dragElId
<static> The default drag frame div id
This property is defined by DDProxy.
available
public boolean available
The availabe property is false until the linked dom element is accessible.
centerFrame
public boolean centerFrame
By default the frame is positioned exactly where the drag element is, so
we use the cursor offset provided by Ext.dd.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.
This property is defined by DDProxy.
config
public object config
Configuration attributes passed into the constructor
groups
public string: groups
The group defines a logical collection of DragDrop objects that are
related. Instances only get events when interacting with other
DragDrop object in the same group. This lets us define multiple
groups using a single DragDrop subclass if we want.
hasOuterHandles
public boolean hasOuterHandles
By default, drags can only be initiated if the mousedown occurs in the
region the linked element is. This is done in part to work around a
bug in some browsers that mis-report the mousedown if the previous
mouseup happened outside of the window. This property is set to true
if outer handles are defined.
id
public String id
The id of the element associated with this object. This is what we
refer to as the "linked element" because the size and position of
this element is used to determine when the drag and drop objects have
interacted.
invalidHandleClasses
public string[] invalidHandleClasses
An indexted array of css class names for elements that will be ignored
if clicked.
invalidHandleIds
public string: invalidHandleIds
An associative array of ids for elements that will be ignored if clicked
invalidHandleTypes
public string: invalidHandleTypes
An associative array of HTML tags that will be ignored if clicked.
maintainOffset
public boolean maintainOffset
Maintain offsets when we resetconstraints. Set to true when you want
the position of the element relative to its parent to stay the same
when the page changes
primaryButtonOnly
public boolean primaryButtonOnly
By default the drag and drop instance will only respond to the primary
button click (left button for a right-handed mouse). Set to true to
allow drag and drop to start with any mouse click that is propogated
by the browser
resizeFrame
public 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.
This property is defined by DDProxy.
scroll
public boolean scroll
When set to true, the utility automatically tries to scroll the browser
window wehn a drag and drop element is dragged near the viewport boundary.
Defaults to true.
This property is defined by
DD.
xTicks
public int[] xTicks
Array of pixel locations the element will snap to if we specified a
horizontal graduation/interval. This array is generated automatically
when you define a tick interval.
yTicks
public int[] yTicks
Array of pixel locations the element will snap to if we specified a
vertical graduation/interval. This array is generated automatically
when you define a tick interval.