Package: | Ext.dd |
Defined In: | DropTarget.js |
Class: | DropTarget |
Subclasses: | DropZone |
Extends: | DDTarget |
Config Options | Defined By | |
---|---|---|
ddGroup : String A named drag drop group to which this object belongs. If a group is specified, then this object will only
interact ... 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 undefined). | DropTarget | |
dropAllowed : String The CSS class returned to the drag source when drop is allowed (defaults to "x-dd-drop-ok"). | DropTarget | |
dropNotAllowed : String The CSS class returned to the drag source when drop is not allowed (defaults to "x-dd-drop-nodrop"). | DropTarget | |
overClass : String The CSS class applied to the drop target element while the drag source is over it (defaults to ""). | DropTarget |
Property | Defined By | |
---|---|---|
Only : Object The drag and drop utility provides a framework for building drag and drop
applications. In addition to enabling drag... The drag and drop utility provides a framework for building drag and drop
applications. In addition to enabling drag and drop for specific elements,
the drag and drop elements are tracked by the manager class, and the
interactions between the various elements are tracked during the drag and
the implementing code is notified about these important moments. | DragDrop | |
available : boolean The availabe property is false until the linked dom element is accessible. | DragDrop | |
config : object Configuration attributes passed into the constructor | DragDrop | |
defaultPadding : Object Provides default constraint padding to "constrainTo" elements (defaults to {left: 0, right:0, top:0, bottom:0}). | DragDrop | |
groups : object An object in the format {'group1':true, 'group2':true 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 | |
ignoreSelf : Boolean Set to false to enable a DragDrop object to fire drag events while dragging
over its own Element. Defaults to true - ... Set to false to enable a DragDrop object to fire drag events while dragging
over its own Element. Defaults to true - DragDrop objects do not by default
fire drag events to themselves. | DragDrop | |
invalidHandleClasses : Array An Array of CSS class names for elements to be considered in valid as drag handles. | DragDrop | |
invalidHandleIds : Object An object who's property names identify the IDs of elements to be considered invalid as drag handles.
A non-null prop... An object who's property names identify the IDs of elements to be considered invalid as drag handles.
A non-null property value identifies the ID as invalid. For example, to prevent
dragging from being initiated on element ID "foo", use:
| DragDrop | |
invalidHandleTypes : Object An object who's property names identify HTML tags to be considered invalid as drag handles.
A non-null property value... An object who's property names identify HTML tags to be considered invalid as drag handles.
A non-null property value identifies the tag as invalid. Defaults to the
following value which prevents drag operations from being initiated by <a> elements:
| DragDrop | |
isTarget : boolean By default, all instances 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 | |
moveOnly : boolean When set to true, other DD objects in cooperating DDGroups do not receive
notification events when this DD object is ... When set to true, other DD objects in cooperating DDGroups do not receive
notification events when this DD object is dragged over them. Defaults to false. | DragDrop | |
padding : int[] An array containing the 4 padding values: [top, right, bottom, left] 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 | |
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 | |
---|---|---|
DropTarget( Mixed el , Object config )
Parameters:
| DropTarget | |
addInvalidHandleClass( string cssClass )
:
voidLets 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 )
:
voidLets 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 )
:
voidAllows 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} )
:
voidAdd 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 | |
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 | |
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 | |
constrainTo( Mixed constrainTo , [Object/Number pad ], [Boolean inContent ] )
:
voidInitializes the drag drop object's constraints to restrict movement to a certain element.
Usage:
var dd = new Ext.dd... Initializes the drag drop object's constraints to restrict movement to a certain element.
Usage:
Or you can initalize it using the Ext.Element object:
Parameters:
| DragDrop | |
endDrag( Event e )
:
voidFired when we are done dragging the object Fired when we are done dragging the object Parameters:
| DragDrop | |
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 | |
init( id the , String sGroup , object config )
:
voidSets 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 | |
initTarget( id the , String sGroup , object config )
:
voidInitializes 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 )
:
booleanChecks 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 | |
notifyDrop( Ext.dd.DragSource source , Event e , Object data )
:
BooleanThe function a Ext.dd.DragSource calls once to notify this drop target that the dragged item has
been dropped on it.... The function a Ext.dd.DragSource calls once to notify this drop target that the dragged item has
been dropped on it. This method has no default implementation and returns false, so you must provide an
implementation that does something to process the drop event and returns true so that the drag source's
repair action does not run. Parameters:
| DropTarget | |
notifyEnter( Ext.dd.DragSource source , Event e , Object data )
:
StringThe function a Ext.dd.DragSource calls once to notify this drop target that the source is now over the
target. This... The function a Ext.dd.DragSource calls once to notify this drop target that the source is now over the
target. This default implementation adds the CSS class specified by overClass (if any) to the drop element
and returns the dropAllowed config value. This method should be overridden if drop validation is required. Parameters:
| DropTarget | |
notifyOut( Ext.dd.DragSource source , Event e , Object data )
:
voidThe function a Ext.dd.DragSource calls once to notify this drop target that the source has been dragged
out of the t... The function a Ext.dd.DragSource calls once to notify this drop target that the source has been dragged
out of the target without dropping. This default implementation simply removes the CSS class specified by
overClass (if any) from the drop element. Parameters:
| DropTarget | |
notifyOver( Ext.dd.DragSource source , Event e , Object data )
:
StringThe function a Ext.dd.DragSource calls continuously while it is being dragged over the target.
This method will be c... The function a Ext.dd.DragSource calls continuously while it is being dragged over the target.
This method will be called on every mouse movement while the drag source is over the drop target.
This default implementation simply returns the dropAllowed config value. Parameters:
| DropTarget | |
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 | |
onDrag( Event e )
:
voidAbstract 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 )
:
voidAbstract 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 )
:
voidAbstract 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 )
:
voidAbstract 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 )
:
voidAbstract 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 | |
onInvalidDrop( Event e )
:
voidAbstract 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 )
:
voidEvent 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 )
:
voidEvent 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 )
:
voidRemove's this instance from the supplied interaction group Remove's this instance from the supplied interaction group Parameters:
| DragDrop | |
removeInvalidHandleClass( string cssClass )
:
voidUnsets an invalid css class Unsets an invalid css class Parameters:
| DragDrop | |
removeInvalidHandleId( string id )
:
voidUnsets an invalid handle id Unsets an invalid handle id Parameters:
| DragDrop | |
removeInvalidHandleType( string tagName )
:
voidUnsets an excluded tag name set by addInvalidHandleType Unsets an excluded tag name set by addInvalidHandleType Parameters:
| DragDrop | |
resetConstraints( boolean maintainOffset )
:
voidresetConstraints must be called if you manually reposition a dd element. resetConstraints must be called if you manually reposition a dd element. Parameters:
| DragDrop | |
setDragElId( id {string} )
:
voidAllows 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 | |
setHandleElId( id {string} )
:
voidAllows 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 | |
setInitPosition( int diffX , int diffY )
:
voidStores the initial placement of the linked element. Stores the initial placement of the linked element. Parameters:
| DragDrop | |
setOuterHandleElId( id the )
:
voidAllows 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 )
:
voidConfigures 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 )
:
voidBy 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 )
:
voidBy 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 )
:
voidAbstract 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 |