Sencha Documentation

Provides easy access to all drag drop components that are registered on a page. Items can be retrieved either directly by DOM node id, or by passing in the drag drop event that occurred and looking up the event target.

Methods

 
getHandle( String/HTMLElement id ) : Object
Returns the handle registered for a DOM Node by id
Returns the handle registered for a DOM Node by id

Parameters

  • id : String/HTMLElement
    The DOM node or id to look up

Returns

  • Object   handle The custom handle data
 
getHandleFromEvent( Event e ) : Object
Returns the handle that is registered for the DOM node that is the target of the event
Returns the handle that is registered for the DOM node that is the target of the event

Parameters

  • e : Event
    The event

Returns

  • Object   handle The custom handle data
 
getTarget( String/HTMLElement id ) : Object
Returns a custom data object that is registered for a DOM node by id
Returns a custom data object that is registered for a DOM node by id

Parameters

  • id : String/HTMLElement
    The DOM node or id to look up

Returns

  • Object   data The custom data
 
getTargetFromEvent( Event e ) : Object
Returns a custom data object that is registered for the DOM node that is the target of the event
Returns a custom data object that is registered for the DOM node that is the target of the event

Parameters

  • e : Event
    The event

Returns

  • Object   data The custom data
 
register( String/HTMLElement element, [Object data] ) : Void
Resgister a drag drop element
Resgister a drag drop element

Parameters

  • element : String/HTMLElement
    The id or DOM node to register
  • data : Object
    (optional) An custom data object that will be passed between the elements that are involved in drag drop operations. You can populate this object with any arbitrary properties that your own code knows how to interpret, plus there are some specific properties known to the Registry that should be populated in the data object (if applicable):
    Value      Description
    --------- ------------------------------------------
    handles Array of DOM nodes that trigger dragging
    for the element being registered
    isHandle True if the element passed in triggers
    dragging itself, else false

Returns

  • Void
 
unregister( String/HTMLElement element ) : Void
Unregister a drag drop element
Unregister a drag drop element

Parameters

  • element : String/HTMLElement
    The id or DOM node to unregister

Returns

  • Void