Print Friendly

Class Ext.dd.DropTarget

Package:Ext.dd
Class:DropTarget
Extends:DDTarget
Subclasses:DropZone
Defined In:DropTarget.js
A simple class that provides the basic implementation needed to make any element a drop target that can have draggable items dropped onto it. The drop has no effect until an implementation of notifyDrop is provided.

Properties   -  Methods   -  Events   -  Config Options

Public Properties

Property Defined By
  available : boolean DragDrop
The availabe property is false until the linked dom element is accessible.
  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...
  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...

Public Methods

Method Defined By
  DropTarget( String/HTMLElement/Element el, Object config ) DropTarget
  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...
  applyConfig() : void DragDrop
Applies the configuration parameters that were passed into the constructor. This is supposed to happen at each level ...
  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
  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
  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
  notifyDrop( Ext.dd.DragSource source, Event e, Object data ) : Boolean DropTarget
The function a Ext.dd.DragSource calls once to notify this drop target that the dragged item has been dropped on it. ...
  notifyEnter( Ext.dd.DragSource source, Event e, Object data ) : String DropTarget
The function a Ext.dd.DragSource calls once to notify this drop target that the source is now over the target. This ...
  notifyOut( Ext.dd.DragSource source, Event e, Object data ) : void DropTarget
The function a Ext.dd.DragSource calls once to notify this drop target that the source has been dragged out of the ta...
  notifyOver( Ext.dd.DragSource source, Event e, Object data ) : String DropTarget
The function a Ext.dd.DragSource calls continuously while it is being dragged over the target. This method will be ca...
  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.
  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
  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

Public Events

This class has no public events.

Config Options

Config Options Defined By
  dropAllowed : String DropTarget
The CSS class returned to the drag source when drop is allowed (defaults to "x-dd-drop-ok").
  dropNotAllowed : String DropTarget
The CSS class returned to the drag source when drop is not allowed (defaults to "x-dd-drop-nodrop").
  overClass : String DropTarget
The CSS class applied to the drop target element while the drag source is over it (defaults to "").

Property Details

available

public boolean available
The availabe property is false until the linked dom element is accessible.
This property is defined by DragDrop.

config

public object config
Configuration attributes passed into the constructor
This property is defined by DragDrop.

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.
This property is defined by DragDrop.

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.
This property is defined by DragDrop.

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.
This property is defined by DragDrop.

invalidHandleClasses

public string[] invalidHandleClasses
An indexted array of css class names for elements that will be ignored if clicked.
This property is defined by DragDrop.

invalidHandleIds

public string: invalidHandleIds
An associative array of ids for elements that will be ignored if clicked
This property is defined by DragDrop.

invalidHandleTypes

public string: invalidHandleTypes
An associative array of HTML tags that will be ignored if clicked.
This property is defined by DragDrop.

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
This property is defined by DragDrop.

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
This property is defined by DragDrop.

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.
This property is defined by DragDrop.

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.
This property is defined by DragDrop.

Constructor Details

DropTarget

public function DropTarget( String/HTMLElement/Element el, Object config )
Parameters:
  • el : String/HTMLElement/Element
    The container element
  • config : Object

Method Details

addInvalidHandleClass

public function addInvalidHandleClass( string cssClass )
Lets you specify a css class of elements that will not initiate a drag
Parameters:
  • cssClass : string
    the class of the elements you wish to ignore
Returns:
  • void
This method is defined by DragDrop.

addInvalidHandleId

public function addInvalidHandleId( string id )
Lets you to specify an element id for a child of a drag handle that should not initiate a drag
Parameters:
  • id : string
    the element id of the element you wish to ignore
Returns:
  • void
This method is defined by DragDrop.

addInvalidHandleType

public function addInvalidHandleType( string tagName )
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:
  • tagName : string
    the type of element to exclude
Returns:
  • void
This method is defined by DragDrop.

addToGroup

public function addToGroup( sGroup {string} )
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:
  • {string} : sGroup
    the name of the group
Returns:
  • void
This method is defined by DragDrop.

applyConfig

public function 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.
Parameters:
  • None.
Returns:
  • void
This method is defined by DragDrop.

clearConstraints

public function clearConstraints()
Clears any constraints applied to this instance. Also clears ticks since they can't exist independent of a constraint at this time.
Parameters:
  • None.
Returns:
  • void
This method is defined by DragDrop.

clearTicks

public function clearTicks()
Clears any tick interval defined for this instance
Parameters:
  • None.
Returns:
  • void
This method is defined by DragDrop.

endDrag

public function endDrag( Event e )
Fired when we are done dragging the object
Parameters:
  • e : Event
    the mouseup event
Returns:
  • void
This method is defined by DragDrop.

getDragEl

public function getDragEl()
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:
  • None.
Returns:
  • HTMLElement
    the html element
This method is defined by DragDrop.

getEl

public function getEl()
Returns a reference to the linked element
Parameters:
  • None.
Returns:
  • HTMLElement
    the html element
This method is defined by DragDrop.

init

public function init( id the, String sGroup, object config )
Sets up the DragDrop object. Must be called in the constructor of any Ext.dd.DragDrop subclass
Parameters:
  • the : id
    id of the linked element
  • sGroup : String
    the group of related items
  • config : object
    configuration attributes
Returns:
  • void
This method is defined by DragDrop.

initTarget

public function initTarget( id the, String sGroup, object config )
Initializes Targeting functionality only... the object does not get a mousedown handler.
Parameters:
  • the : id
    id of the linked element
  • sGroup : String
    the group of related items
  • config : object
    configuration attributes
Returns:
  • void
This method is defined by DragDrop.

isLocked

public function isLocked()
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:
  • None.
Returns:
  • boolean
    true if this obj or all drag/drop is locked, else false
This method is defined by DragDrop.

isTarget

public function isTarget()
By default, all insances can be a drop target. This can be disabled by setting isTarget to false.
Parameters:
  • None.
Returns:
  • void
This method is defined by DragDrop.

isValidHandleChild

public function isValidHandleChild( HTMLElement node )
Checks the tag exclusion list to see if this click should be ignored
Parameters:
  • node : HTMLElement
    the HTMLElement to evaluate
Returns:
  • boolean
    true if this is a valid tag type, false if not
This method is defined by DragDrop.

lock

public function lock()
Lock this instance
Parameters:
  • None.
Returns:
  • void
This method is defined by DragDrop.

notifyDrop

public function notifyDrop( Ext.dd.DragSource source, Event e, Object data )
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:
  • source : Ext.dd.DragSource
    The drag source that was dragged over this drop target
  • e : Event
    The event
  • data : Object
    An object containing arbitrary data supplied by the drag source
Returns:
  • Boolean
    True if the drop was valid, else false
This method is defined by DropTarget.

notifyEnter

public function notifyEnter( Ext.dd.DragSource source, Event e, Object data )
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:
  • source : Ext.dd.DragSource
    The drag source that was dragged over this drop target
  • e : Event
    The event
  • data : Object
    An object containing arbitrary data supplied by the drag source
Returns:
  • String
    status The CSS class that communicates the drop status back to the source so that the underlying {@link Ext.dd.StatusProxy} can be updated
This method is defined by DropTarget.

notifyOut

public function notifyOut( Ext.dd.DragSource source, Event e, Object data )
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:
  • source : Ext.dd.DragSource
    The drag source that was dragged over this drop target
  • e : Event
    The event
  • data : Object
    An object containing arbitrary data supplied by the drag source
Returns:
  • void
This method is defined by DropTarget.

notifyOver

public function notifyOver( Ext.dd.DragSource source, Event e, Object data )
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:
  • source : Ext.dd.DragSource
    The drag source that was dragged over this drop target
  • e : Event
    The event
  • data : Object
    An object containing arbitrary data supplied by the drag source
Returns:
  • String
    status The CSS class that communicates the drop status back to the source so that the underlying {@link Ext.dd.StatusProxy} can be updated
This method is defined by DropTarget.

onAvailable

public function onAvailable()
Override the onAvailable method to do what is needed after the initial position was determined.
Parameters:
  • None.
Returns:
  • void
This method is defined by DragDrop.

onDrag

public function onDrag( Event e )
Abstract method called during the onMouseMove event while dragging an object.
Parameters:
  • e : Event
    the mousemove event
Returns:
  • void
This method is defined by DragDrop.

onDragDrop

public function onDragDrop( Event e, String|DragDrop[] id )
Abstract method called when this item is dropped on another DragDrop obj
Parameters:
  • e : Event
    the mouseup event
  • id : String|DragDrop[]
    In POINT mode, the element id this was dropped on. In INTERSECT mode, an array of dd items this was dropped on.
Returns:
  • void
This method is defined by DragDrop.

onDragEnter

public function onDragEnter( Event e, String|DragDrop[] id )
Abstract method called when this element fist begins hovering over another DragDrop obj
Parameters:
  • e : Event
    the mousemove event
  • id : String|DragDrop[]
    In POINT mode, the element id this is hovering over. In INTERSECT mode, an array of one or more dragdrop items being hovered over.
Returns:
  • void
This method is defined by DragDrop.

onDragOut

public function onDragOut( Event e, String|DragDrop[] id )
Abstract method called when we are no longer hovering over an element
Parameters:
  • e : Event
    the mousemove event
  • id : String|DragDrop[]
    In POINT mode, the element id this was hovering over. In INTERSECT mode, an array of dd items that the mouse is no longer over.
Returns:
  • void
This method is defined by DragDrop.

onDragOver

public function onDragOver( Event e, String|DragDrop[] id )
Abstract method called when this element is hovering over another DragDrop obj
Parameters:
  • e : Event
    the mousemove event
  • id : String|DragDrop[]
    In POINT mode, the element id this is hovering over. In INTERSECT mode, an array of dd items being hovered over.
Returns:
  • void
This method is defined by DragDrop.

onInvalidDrop

public function onInvalidDrop( Event e )
Abstract method called when this item is dropped on an area with no drop target
Parameters:
  • e : Event
    the mouseup event
Returns:
  • void
This method is defined by DragDrop.

onMouseDown

public function onMouseDown( Event e )
Event handler that fires when a drag/drop obj gets a mousedown
Parameters:
  • e : Event
    the mousedown event
Returns:
  • void
This method is defined by DragDrop.

onMouseUp

public function onMouseUp( Event e )
Event handler that fires when a drag/drop obj gets a mouseup
Parameters:
  • e : Event
    the mouseup event
Returns:
  • void
This method is defined by DragDrop.

padding

public function padding()
The padding configured for this drag and drop object for calculating the drop zone intersection with this object.
Parameters:
  • None.
Returns:
  • void
This method is defined by DragDrop.

removeFromGroup

public function removeFromGroup( string sGroup )
Remove's this instance from the supplied interaction group
Parameters:
  • sGroup : string
    The group to drop
Returns:
  • void
This method is defined by DragDrop.

removeInvalidHandleClass

public function removeInvalidHandleClass( string cssClass )
Unsets an invalid css class
Parameters:
  • cssClass : string
    the class of the element(s) you wish to re-enable
Returns:
  • void
This method is defined by DragDrop.

removeInvalidHandleId

public function removeInvalidHandleId( string id )
Unsets an invalid handle id
Parameters:
  • id : string
    the id of the element to re-enable
Returns:
  • void
This method is defined by DragDrop.

removeInvalidHandleType

public function removeInvalidHandleType( string tagName )
Unsets an excluded tag name set by addInvalidHandleType
Parameters:
  • tagName : string
    the type of element to unexclude
Returns:
  • void
This method is defined by DragDrop.

resetConstraints

public function resetConstraints( boolean maintainOffset )
resetConstraints must be called if you manually reposition a dd element.
Parameters:
  • maintainOffset : boolean
Returns:
  • void
This method is defined by DragDrop.

setDragElId

public function setDragElId( id {string} )
Allows you to specify that an element other than the linked element will be moved with the cursor during a drag
Parameters:
  • {string} : id
    the id of the element that will be used to initiate the drag
Returns:
  • void
This method is defined by DragDrop.

setHandleElId

public function setHandleElId( id {string} )
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:
  • {string} : id
    the id of the element that will be used to initiate the drag.
Returns:
  • void
This method is defined by DragDrop.

setInitialPosition

public function setInitialPosition( int diffX, int diffY )
Stores the initial placement of the linked element.
Parameters:
  • diffX : int
    the X offset, default 0
  • diffY : int
    the Y offset, default 0
Returns:
  • void
This method is defined by DragDrop.

setOuterHandleElId

public function setOuterHandleElId( id the )
Allows you to set an element outside of the linked element as a drag handle
Parameters:
  • the : id
    id of the element that will be used to initiate the drag
Returns:
  • void
This method is defined by DragDrop.

setPadding

public function setPadding( int iTop, int iRight, int iBot, int iLeft )
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:
  • iTop : int
    Top pad
  • iRight : int
    Right pad
  • iBot : int
    Bot pad
  • iLeft : int
    Left pad
Returns:
  • void
This method is defined by DragDrop.

setXConstraint

public function setXConstraint( int iLeft, int iRight, int iTickSize )
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:
  • iLeft : int
    the number of pixels the element can move to the left
  • iRight : int
    the number of pixels the element can move to the right
  • iTickSize : int
    optional parameter for specifying that the element should move iTickSize pixels at a time.
Returns:
  • void
This method is defined by DragDrop.

setYConstraint

public function setYConstraint( int iUp, int iDown, int iTickSize )
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:
  • iUp : int
    the number of pixels the element can move up
  • iDown : int
    the number of pixels the element can move down
  • iTickSize : int
    optional parameter for specifying that the element should move iTickSize pixels at a time.
Returns:
  • void
This method is defined by DragDrop.

startDrag

public function startDrag( int X, int Y )
Abstract method called after a drag/drop object is clicked and the drag or mousedown time thresholds have beeen met.
Parameters:
  • X : int
    click location
  • Y : int
    click location
Returns:
  • void
This method is defined by DragDrop.

toString

public function toString()
toString method
Parameters:
  • None.
Returns:
  • string
    string representation of the dd obj
This method is defined by DragDrop.

unlock

public function unlock()
Unlock this instace
Parameters:
  • None.
Returns:
  • void
This method is defined by DragDrop.

unreg

public function unreg()
Remove all drag and drop hooks for this element
Parameters:
  • None.
Returns:
  • void
This method is defined by DragDrop.

Config Details

dropAllowed

dropAllowed : String
The CSS class returned to the drag source when drop is allowed (defaults to "x-dd-drop-ok").
This config option is defined by DropTarget.

dropNotAllowed

dropNotAllowed : String
The CSS class returned to the drag source when drop is not allowed (defaults to "x-dd-drop-nodrop").
This config option is defined by DropTarget.

overClass

overClass : String
The CSS class applied to the drop target element while the drag source is over it (defaults to "").
This config option is defined by DropTarget.
Ext - Copyright © 2006-2007 Ext JS, LLC
All rights reserved.