Properties
Methods
Events
Config Options
Direct Link
DragDropDD
| Package: | Ext.tree |
| Defined In: | TreeDragZone.js |
| Class: | TreeDragZone |
| Extends: | DragZone |
| Config Options | Defined By | |
|---|---|---|
|
containerScroll : Boolean
True to register this container with the Scrollmanager for auto scrolling during drag operations.
|
DragZone | |
|
ddGroup : String A named drag drop group to which this object belongs. If a group is specified, then this object will only interact wi...
A named drag drop group to which this object belongs. If a group is specified, then this object will only interact with other drag drop objects in the same group (defaults to 'TreeDD').
|
TreeDragZone | |
|
dropAllowed : String
The CSS class returned to the drag source when drop is allowed (defaults to "x-dd-drop-ok").
|
DragSource | |
|
dropNotAllowed : String
The CSS class returned to the drag source when drop is not allowed (defaults to "x-dd-drop-nodrop").
|
DragSource | |
|
hlColor : String The color to use when visually highlighting the drag source in the afterRepair method after a failed drop (defaults t...
The color to use when visually highlighting the drag source in the afterRepair method after a failed drop (defaults to "c3daf9" - light blue)
|
DragZone | |
| Property | Defined By | |
|---|---|---|
|
available : boolean
The availabe property is false until the linked dom element is accessible.
|
DragDrop | |
|
centerFrame : boolean By default the frame is positioned exactly where the drag element is, so
we use the cursor offset provided by Ext.dd....
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.
|
DDProxy | |
|
config : object
Configuration attributes passed into the constructor
|
DragDrop | |
|
groups : object The group defines a logical collection of DragDrop objects that are
related. Instances only get events when interact...
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.
|
DragDrop | |
|
hasOuterHandles : boolean By default, drags can only be initiated if the mousedown occurs in the
region the linked element is. This is done in...
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.
|
DragDrop | |
|
id : String The id of the element associated with this object. This is what we
refer to as the "linked element" because the size...
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.
|
DragDrop | |
|
invalidHandleClasses : string[]
An indexted array of css class names for elements that will be ignored
if clicked.
|
DragDrop | |
|
invalidHandleIds : string:
An associative array of ids for elements that will be ignored if clicked
|
DragDrop | |
|
invalidHandleTypes : string:
An associative array of HTML tags that will be ignored if clicked.
|
DragDrop | |
|
isTarget : boolean
By default, all insances can be a drop target. This can be disabled by
setting isTarget to false.
|
DragDrop | |
|
maintainOffset : boolean Maintain offsets when we resetconstraints. Set to true when you want
the position of the element relative to its par...
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
|
DragDrop | |
|
onStartDrag : Object An empty function by default, but provided so that you can perform a custom action once the initial
drag event has be...
An empty function by default, but provided so that you can perform a custom action once the initial
drag event has begun. The drag cannot be canceled from this function.
|
DragSource | |
|
padding : int[]
The padding configured for this drag and drop object for calculating
the drop zone intersection with this object.
|
DragDrop | |
|
primaryButtonOnly : boolean By default the drag and drop instance will only respond to the primary
button click (left button for a right-handed m...
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
|
DragDrop | |
|
resizeFrame : boolean 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...
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.
|
DDProxy | |
|
scroll : boolean When set to true, the utility automatically tries to scroll the browser
window wehn a drag and drop element is dragge...
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.
|
DD | |
|
tree : Ext.tree.TreePanel
The TreePanel for this drag zone
|
TreeDragZone | |
|
xTicks : int[] Array of pixel locations the element will snap to if we specified a
horizontal graduation/interval. This array is ge...
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.
|
DragDrop | |
|
yTicks : int[] Array of pixel locations the element will snap to if we specified a
vertical graduation/interval. This array is gene...
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.
|
DragDrop | |
| Method | Defined By | |
|---|---|---|
TreeDragZone( String/HTMLElement/Element tree, Object config )
Parameters:
|
TreeDragZone | |
addInvalidHandleClass( string cssClass ) : void Lets you specify a css class of elements that will not initiate a drag
Lets you specify a css class of elements that will not initiate a drag
Parameters:
|
DragDrop | |
addInvalidHandleId( string id ) : void Lets you to specify an element id for a child of a drag handle
that should not initiate a drag
Lets you to specify an element id for a child of a drag handle
that should not initiate a drag
Parameters:
|
DragDrop | |
addInvalidHandleType( string tagName ) : void Allows you to specify a tag name that should not start a drag operation
when clicked. This is designed to facilitate...
Allows you to specify a tag name that should not start a drag operation
when clicked. This is designed to facilitate embedding links within a
drag handle that do something other than start the drag.
Parameters:
|
DragDrop | |
addToGroup( sGroup {string} ) : void Add this instance to a group of related drag/drop objects. All
instances belong to at least one group, and can belon...
Add this instance to a group of related drag/drop objects. All
instances belong to at least one group, and can belong to as many
groups as needed.
Parameters:
|
DragDrop | |
afterDragDrop( Ext.dd.DragDrop target, Event e, String id ) : void An empty function by default, but provided so that you can perform a custom action
after a valid drag drop has occurr...
An empty function by default, but provided so that you can perform a custom action
after a valid drag drop has occurred by providing an implementation.
Parameters:
|
DragSource | |
afterDragEnter( Ext.dd.DragDrop target, Event e, String id ) : void An empty function by default, but provided so that you can perform a custom action
when the dragged item enters the d...
An empty function by default, but provided so that you can perform a custom action
when the dragged item enters the drop target by providing an implementation.
Parameters:
|
DragSource | |
afterDragOut( Ext.dd.DragDrop target, Event e, String id ) : void An empty function by default, but provided so that you can perform a custom action
after the dragged item is dragged ...
An empty function by default, but provided so that you can perform a custom action
after the dragged item is dragged out of the target without dropping.
Parameters:
|
DragSource | |
afterDragOver( Ext.dd.DragDrop target, Event e, String id ) : void An empty function by default, but provided so that you can perform a custom action
while the dragged item is over the...
An empty function by default, but provided so that you can perform a custom action
while the dragged item is over the drop target by providing an implementation.
Parameters:
|
DragSource | |
afterInvalidDrop( Event e, String id ) : void An empty function by default, but provided so that you can perform a custom action
after an invalid drop has occurred...
An empty function by default, but provided so that you can perform a custom action
after an invalid drop has occurred by providing an implementation.
Parameters:
|
DragSource | |
|
afterRepair() : void Called after a repair of an invalid drop. By default, highlights this.dragData.ddel
Called after a repair of an invalid drop. By default, highlights this.dragData.ddel
Parameters:
|
DragZone | |
alignElWithMouse( HTMLElement el, int iPageX, int iPageY ) : void Sets the element to the location of the mousedown or click event,
maintaining the cursor location relative to the loc...
Sets the element to the location of the mousedown or click event,
maintaining the cursor location relative to the location on the element
that was clicked. Override this if you want to place the element in a
location other than where the cursor is.
Parameters:
|
DD | |
|
applyConfig() : void Applies the configuration parameters that were passed into the constructor.
This is supposed to happen at each level ...
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.
Parameters:
|
DragDrop | |
autoOffset( int iPageX, int iPageY ) : void Sets the pointer offset to the distance between the linked element's top
left corner and the location the element was...
Sets the pointer offset to the distance between the linked element's top
left corner and the location the element was clicked
Parameters:
|
DD | |
beforeDragDrop( Ext.dd.DragDrop target, Event e, String id ) : Boolean An empty function by default, but provided so that you can perform a custom action before the dragged
item is dropped...
An empty function by default, but provided so that you can perform a custom action before the dragged
item is dropped onto the target and optionally cancel the onDragDrop.
Parameters:
|
DragSource | |
beforeDragEnter( Ext.dd.DragDrop target, Event e, String id ) : Boolean An empty function by default, but provided so that you can perform a custom action
before the dragged item enters the...
An empty function by default, but provided so that you can perform a custom action
before the dragged item enters the drop target and optionally cancel the onDragEnter.
Parameters:
|
DragSource | |
beforeDragOut( Ext.dd.DragDrop target, Event e, String id ) : Boolean An empty function by default, but provided so that you can perform a custom action before the dragged
item is dragged...
An empty function by default, but provided so that you can perform a custom action before the dragged
item is dragged out of the target without dropping, and optionally cancel the onDragOut.
Parameters:
|
DragSource | |
beforeDragOver( Ext.dd.DragDrop target, Event e, String id ) : Boolean An empty function by default, but provided so that you can perform a custom action
while the dragged item is over the...
An empty function by default, but provided so that you can perform a custom action
while the dragged item is over the drop target and optionally cancel the onDragOver.
Parameters:
|
DragSource | |
beforeInvalidDrop( Ext.dd.DragDrop target, Event e, String id ) : Boolean An empty function by default, but provided so that you can perform a custom action after an invalid
drop has occurred.
An empty function by default, but provided so that you can perform a custom action after an invalid
drop has occurred.
Parameters:
|
DragSource | |
cachePosition( iPageX the, iPageY the ) : void Saves the most recent position so that we can reset the constraints and
tick marks on-demand. We need to know this s...
Saves the most recent position so that we can reset the constraints and
tick marks on-demand. We need to know this so that we can calculate the
number of pixels the element is offset from its original position.
Parameters:
|
DD | |
|
clearConstraints() : void Clears any constraints applied to this instance. Also clears ticks
since they can't exist independent of a constrain...
Clears any constraints applied to this instance. Also clears ticks
since they can't exist independent of a constraint at this time.
Parameters:
|
DragDrop | |
|
clearTicks() : void Clears any tick interval defined for this instance
Clears any tick interval defined for this instance
Parameters:
|
DragDrop | |
|
createFrame() : void Creates the proxy element if it does not yet exist
Creates the proxy element if it does not yet exist
Parameters:
|
DDProxy | |
endDrag( Event e ) : void Fired when we are done dragging the object
Fired when we are done dragging the object
Parameters:
|
DragDrop | |
|
getDragData() : Object Returns the data object associated with this drag source
Returns the data object associated with this drag source
Parameters:
|
DragSource | |
|
getDragEl() : HTMLElement Returns a reference to the actual element to drag. By default this is
the same as the html element, but it can be as...
Returns a reference to the actual element to drag. By default this is
the same as the html element, but it can be assigned to another
element. An example of this can be found in Ext.dd.DDProxy
Parameters:
|
DragDrop | |
|
getEl() : HTMLElement Returns a reference to the linked element
Returns a reference to the linked element
Parameters:
|
DragDrop | |
|
getProxy() : Ext.dd.StatusProxy Returns the drag source's underlying Ext.dd.StatusProxy
Returns the drag source's underlying Ext.dd.StatusProxy
Parameters:
|
DragSource | |
getRepairXY( EventObject e ) : Array Called before a repair of an invalid drop to get the XY to animate to. By default returns
the XY of this.dragData.ddel
Called before a repair of an invalid drop to get the XY to animate to. By default returns
the XY of this.dragData.ddel
Parameters:
|
DragZone | |
|
hideProxy() : void Hides the drag source's Ext.dd.StatusProxy
Hides the drag source's Ext.dd.StatusProxy
Parameters:
|
DragSource | |
init( id the, String sGroup, object config ) : void Sets up the DragDrop object. Must be called in the constructor of any
Ext.dd.DragDrop subclass
Sets up the DragDrop object. Must be called in the constructor of any
Ext.dd.DragDrop subclass
Parameters:
|
DragDrop | |
|
initFrame() : void Initialization for the drag frame element. Must be called in the
constructor of all subclasses
Initialization for the drag frame element. Must be called in the
constructor of all subclasses
Parameters:
|
DDProxy | |
initTarget( id the, String sGroup, object config ) : void Initializes Targeting functionality only... the object does not
get a mousedown handler.
Initializes Targeting functionality only... the object does not
get a mousedown handler.
Parameters:
|
DragDrop | |
|
isLocked() : boolean Returns true if this instance is locked, or the drag drop mgr is locked
(meaning that all drag/drop is disabled on th...
Returns true if this instance is locked, or the drag drop mgr is locked
(meaning that all drag/drop is disabled on the page.)
Parameters:
|
DragDrop | |
isValidHandleChild( HTMLElement node ) : boolean Checks the tag exclusion list to see if this click should be ignored
Checks the tag exclusion list to see if this click should be ignored
Parameters:
|
DragDrop | |
|
lock() : void Lock this instance
Lock this instance
Parameters:
|
DragDrop | |
|
onAvailable() : void Override the onAvailable method to do what is needed after the initial
position was determined.
Override the onAvailable method to do what is needed after the initial
position was determined.
Parameters:
|
DragDrop | |
onBeforeDrag( Object data, Event e ) : Boolean An empty function by default, but provided so that you can perform a custom action before the initial
drag event begi...
An empty function by default, but provided so that you can perform a custom action before the initial
drag event begins and optionally cancel it.
Parameters:
|
DragSource | |
onDrag( Event e ) : void Abstract method called during the onMouseMove event while dragging an
object.
Abstract method called during the onMouseMove event while dragging an
object.
Parameters:
|
DragDrop | |
onDragDrop( Event e, String|DragDrop[] id ) : void Abstract method called when this item is dropped on another DragDrop
obj
Abstract method called when this item is dropped on another DragDrop
obj
Parameters:
|
DragDrop | |
onDragEnter( Event e, String|DragDrop[] id ) : void Abstract method called when this element fist begins hovering over
another DragDrop obj
Abstract method called when this element fist begins hovering over
another DragDrop obj
Parameters:
|
DragDrop | |
onDragOut( Event e, String|DragDrop[] id ) : void Abstract method called when we are no longer hovering over an element
Abstract method called when we are no longer hovering over an element
Parameters:
|
DragDrop | |
onDragOver( Event e, String|DragDrop[] id ) : void Abstract method called when this element is hovering over another
DragDrop obj
Abstract method called when this element is hovering over another
DragDrop obj
Parameters:
|
DragDrop | |
onInitDrag( Number x, Number y ) : Boolean Called once drag threshold has been reached to initialize the proxy element. By default, it clones the
this.dragData....
Called once drag threshold has been reached to initialize the proxy element. By default, it clones the
this.dragData.ddel
Parameters:
|
DragZone | |
onInvalidDrop( Event e ) : void Abstract method called when this item is dropped on an area with no
drop target
Abstract method called when this item is dropped on an area with no
drop target
Parameters:
|
DragDrop | |
onMouseDown( Event e ) : void Event handler that fires when a drag/drop obj gets a mousedown
Event handler that fires when a drag/drop obj gets a mousedown
Parameters:
|
DragDrop | |
onMouseUp( Event e ) : void Event handler that fires when a drag/drop obj gets a mouseup
Event handler that fires when a drag/drop obj gets a mouseup
Parameters:
|
DragDrop | |
removeFromGroup( string sGroup ) : void Remove's this instance from the supplied interaction group
Remove's this instance from the supplied interaction group
Parameters:
|
DragDrop | |
removeInvalidHandleClass( string cssClass ) : void Unsets an invalid css class
Unsets an invalid css class
Parameters:
|
DragDrop | |
removeInvalidHandleId( string id ) : void Unsets an invalid handle id
Unsets an invalid handle id
Parameters:
|
DragDrop | |
removeInvalidHandleType( string tagName ) : void Unsets an excluded tag name set by addInvalidHandleType
Unsets an excluded tag name set by addInvalidHandleType
Parameters:
|
DragDrop | |
resetConstraints( boolean maintainOffset ) : void resetConstraints must be called if you manually reposition a dd element.
resetConstraints must be called if you manually reposition a dd element.
Parameters:
|
DragDrop | |
setDelta( int iDeltaX, int iDeltaY ) : void Sets the pointer offset. You can call this directly to force the
offset to be in a particular location (e.g., pass i...
Sets the pointer offset. You can call this directly to force the
offset to be in a particular location (e.g., pass in 0,0 to set it
to the center of the object)
Parameters:
|
DD | |
setDragElId( id {string} ) : void Allows you to specify that an element other than the linked element
will be moved with the cursor during a drag
Allows you to specify that an element other than the linked element
will be moved with the cursor during a drag
Parameters:
|
DragDrop | |
setDragElPos( int iPageX, int iPageY ) : void Sets the drag element to the location of the mousedown or click event,
maintaining the cursor location relative to th...
Sets the drag element to the location of the mousedown or click event,
maintaining the cursor location relative to the location on the element
that was clicked. Override this if you want to place the element in a
location other than where the cursor is.
Parameters:
|
DD | |
setHandleElId( id {string} ) : void Allows you to specify a child of the linked element that should be
used to initiate the drag operation. An example o...
Allows you to specify a child of the linked element that should be
used to initiate the drag operation. An example of this would be if
you have a content div with text and links. Clicking anywhere in the
content area would normally start the drag operation. Use this method
to specify that an element inside of the content div is the element
that starts the drag operation.
Parameters:
|
DragDrop | |
setInitialPosition( int diffX, int diffY ) : void Stores the initial placement of the linked element.
Stores the initial placement of the linked element.
Parameters:
|
DragDrop | |
setOuterHandleElId( id the ) : void Allows you to set an element outside of the linked element as a drag
handle
Allows you to set an element outside of the linked element as a drag
handle
Parameters:
|
DragDrop | |
setPadding( int iTop, int iRight, int iBot, int iLeft ) : void Configures the padding for the target zone in px. Effectively expands
(or reduces) the virtual object size for targe...
Configures the padding for the target zone in px. Effectively expands
(or reduces) the virtual object size for targeting calculations.
Supports css-style shorthand; if only one parameter is passed, all sides
will have that padding, and if only two are passed, the top and bottom
will have the first param, the left and right the second.
Parameters:
|
DragDrop | |
setXConstraint( int iLeft, int iRight, int iTickSize ) : void By default, the element can be dragged any place on the screen. Use
this method to limit the horizontal travel of th...
By default, the element can be dragged any place on the screen. Use
this method to limit the horizontal travel of the element. Pass in
0,0 for the parameters if you want to lock the drag to the y axis.
Parameters:
|
DragDrop | |
setYConstraint( int iUp, int iDown, int iTickSize ) : void By default, the element can be dragged any place on the screen. Set
this to limit the vertical travel of the element...
By default, the element can be dragged any place on the screen. Set
this to limit the vertical travel of the element. Pass in 0,0 for the
parameters if you want to lock the drag to the x axis.
Parameters:
|
DragDrop | |
startDrag( int X, int Y ) : void Abstract method called after a drag/drop object is clicked
and the drag or mousedown time thresholds have beeen met.
Abstract method called after a drag/drop object is clicked
and the drag or mousedown time thresholds have beeen met.
Parameters:
|
DragDrop | |
|
toString() : string toString method
toString method
Parameters:
|
DragDrop | |
|
unlock() : void Unlock this instace
Unlock this instace
Parameters:
|
DragDrop | |
|
unreg() : void Remove all drag and drop hooks for this element
Remove all drag and drop hooks for this element
Parameters:
|
DragDrop | |