|
| DropTarget( Mixed el , Object config )
+ Parameters:el : MixedThe container element config : Object Returns: | 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 | 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 | 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:
-
- Returns:
-
-
-
-
- |
- 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
+drag handle that do something other than start the drag. | 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:
- {string} : sGroupthe name of the group
- Returns:
-
-
-
-
- |
- 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.
+groups as needed. Parameters:{string} : sGroupthe name of the group Returns: | DragDrop |
| applyConfig()
+ :
+ voidApplies 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:
-
- Returns:
-
-
-
-
- |
- 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:
-
- Returns:
-
-
-
-
- |
- DragDrop |
-
-
- |
-
-
- clearTicks() : void
- Clears any tick interval defined for this instance
-
- Clears any tick interval defined for this instance
- Parameters:
-
- Returns:
-
-
-
-
- |
- DragDrop |
-
-
- |
-
-
- constrainTo( Mixed constrainTo , [Object/Number pad ], [Boolean inContent ] ) : void
- Initializes the drag drop object's constraints to restrict movement to a certain element.
-Usage:
- var dd = new Ext.d...
-
- Initializes the drag drop object's constraints to restrict movement to a certain element.
-Usage:
- var dd = new Ext.dd.DDProxy("dragDiv1", "proxytest",
+each object.
| DragDrop |
| clearConstraints()
+ :
+ voidClears 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. | DragDrop |
| clearTicks()
+ :
+ voidClears any tick interval defined for this instance Clears any tick interval defined for this instance | 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:
+ var dd = new Ext.dd.DDProxy("dragDiv1", "proxytest",
{ dragElId: "existingProxyDiv" });
dd.startDrag = function(){
- this.constrainTo("parent-id");
+ this.constrainTo("parent-id");
};
-Or you can initalize it using the Ext.Element object:
+Or you can initalize it using the Ext.Element object:
Ext.get("dragDiv1").initDDProxy("proxytest", {dragElId: "existingProxyDiv"}, {
startDrag : function(){
- this.constrainTo("parent-id");
+ this.constrainTo("parent-id");
}
- });
- |
- DragDrop |
-
-
- |
-
-
- endDrag( Event e ) : void
- Fired when we are done dragging the object
-
- Fired when we are done dragging the object
- Parameters:
- e : Eventthe mouseup event
- Returns:
-
-
-
-
- |
- 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
+an object containing the sides to pad. For example: {right:10, bottom:10} inContent : Boolean(optional) Constrain the draggable in the content box of the element (inside padding and borders) Returns: | DragDrop |
| endDrag( Event e )
+ :
+ voidFired when we are done dragging the object Fired when we are done dragging the object Parameters:e : Eventthe mouseup event Returns: | DragDrop |
| getDragEl()
+ :
+ HTMLElementReturns 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:
-
- Returns:
-
- HTMLElement the html element
-
-
-
-
- |
- DragDrop |
-
-
- |
-
-
- getEl() : HTMLElement
- Returns a reference to the linked element
-
- Returns a reference to the linked element
- Parameters:
-
- Returns:
-
- HTMLElement the html element
-
-
-
-
- |
- DragDrop |
-
-
- |
-
-
- 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:
-
- Returns:
-
-
-
-
- |
- DragDrop |
-
-
- |
-
-
- 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:
-
- Returns:
-
-
-
-
- |
- 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:
-
- Returns:
-
-
-
-
- |
- 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:
-
- Returns:
-
-
-
-
- |
- DragDrop |
-
-
- |
-
-
- lock() : void
- Lock this instance
-
- Lock this instance
- Parameters:
-
- Returns:
-
-
-
-
- |
- DragDrop |
-
-
- |
-
-
- notifyDrop( Ext.dd.DragSource source , Event e , Object data ) : Boolean
- The 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
+element. An example of this can be found in Ext.dd.DDProxy Parameters:Returns:HTMLElement the html element
| DragDrop |
| getEl()
+ :
+ HTMLElementReturns a reference to the linked element Returns a reference to the linked element Parameters:Returns:HTMLElement the html element
| 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 | 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. | DragDrop |
| isLocked()
+ :
+ booleanReturns 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.) | 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 | DragDrop |
| lock()
+ :
+ void | 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:
-
- Returns:
-
-
-
-
- |
- DropTarget |
-
-
- |
-
-
- notifyEnter( Ext.dd.DragSource source , Event e , Object data ) : String
- The 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
+repair action does not run. | 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:
-
- Returns:
-
-
-
-
- |
- DropTarget |
-
-
- |
-
-
- notifyOut( Ext.dd.DragSource source , Event e , Object data ) : void
- The function a Ext.dd.DragSource calls once to notify this drop target that the source has been dragged
-out of the ta...
-
- The function a Ext.dd.DragSource calls once to notify this drop target that the source has been dragged
+and returns the dropAllowed config value. This method should be overridden if drop validation is required. | 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 ta... 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:
-
- Returns:
-
-
-
-
- |
- DropTarget |
-
-
- |
-
-
- notifyOver( Ext.dd.DragSource source , Event e , Object data ) : String
- The function a Ext.dd.DragSource calls continuously while it is being dragged over the target.
-This method will be ca...
-
- The function a Ext.dd.DragSource calls continuously while it is being dragged over the target.
+overClass (if any) from the drop element. | 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 ca... 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:
-
- Returns:
-
-
-
-
- |
- 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:
-
- Returns:
-
-
-
-
- |
- DragDrop |
-
-
- |
-
-
- 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:
- e : Eventthe mousemove event
- Returns:
-
-
-
-
- |
- 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:
-
- Returns:
-
-
-
-
- |
- 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:
-
- Returns:
-
-
-
-
- |
- 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:
-
- Returns:
-
-
-
-
- |
- 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:
-
- Returns:
-
-
-
-
- |
- DragDrop |
-
-
- |
-
-
- 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:
- e : Eventthe mouseup event
- Returns:
-
-
-
-
- |
- 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:
- e : Eventthe mousedown event
- Returns:
-
-
-
-
- |
- 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:
- e : Eventthe mouseup event
- Returns:
-
-
-
-
- |
- DragDrop |
-
-
- |
-
-
- removeFromGroup( string sGroup ) : void
- Remove's this instance from the supplied interaction group
-
- Remove's this instance from the supplied interaction group
- Parameters:
- sGroup : stringThe group to drop
- Returns:
-
-
-
-
- |
- DragDrop |
-
-
- |
-
-
- removeInvalidHandleClass( string cssClass ) : void
- Unsets an invalid css class
-
- Unsets an invalid css class
- Parameters:
-
- Returns:
-
-
-
-
- |
- DragDrop |
-
-
- |
-
-
- removeInvalidHandleId( string id ) : void
- Unsets an invalid handle id
-
- Unsets an invalid handle id
- Parameters:
-
- Returns:
-
-
-
-
- |
- DragDrop |
-
-
- |
-
-
- removeInvalidHandleType( string tagName ) : void
- Unsets an excluded tag name set by addInvalidHandleType
-
- Unsets an excluded tag name set by addInvalidHandleType
- Parameters:
-
- Returns:
-
-
-
-
- |
- 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:
-
- Returns:
-
-
-
-
- |
- DragDrop |
-
-
- |
-
-
- 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:
-
- Returns:
-
-
-
-
- |
- DragDrop |
-
-
- |
-
-
- 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
+This default implementation simply returns the dropAllowed config value. | DropTarget |
| onAvailable()
+ :
+ voidOverride 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. | 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:e : Eventthe mousemove event Returns: | 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 | 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 | 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 | 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 | 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:e : Eventthe mouseup event Returns: | 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:e : Eventthe mousedown event Returns: | 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:e : Eventthe mouseup event Returns: | DragDrop |
| removeFromGroup( string sGroup )
+ :
+ voidRemove's this instance from the supplied interaction group Remove's this instance from the supplied interaction group Parameters:sGroup : stringThe group to drop Returns: | DragDrop |
| removeInvalidHandleClass( string cssClass )
+ :
+ voidUnsets an invalid css class Unsets an invalid css class | DragDrop |
| removeInvalidHandleId( string id )
+ :
+ voidUnsets an invalid handle id Unsets an invalid handle id | DragDrop |
| removeInvalidHandleType( string tagName )
+ :
+ voidUnsets an excluded tag name set by addInvalidHandleType Unsets an excluded tag name set by addInvalidHandleType | 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. | 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 | 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:
-
- Returns:
-
-
-
-
- |
- DragDrop |
-
-
- |
-
-
- setInitialPosition( int diffX , int diffY ) : void
- Stores the initial placement of the linked element.
-
- Stores the initial placement of the linked element.
- Parameters:
- diffX : intthe X offset, default 0 diffY : intthe Y offset, default 0
- Returns:
-
-
-
-
- |
- 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:
-
- Returns:
-
-
-
-
- |
- 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
+that starts the drag operation. | DragDrop |
| setInitPosition( int diffX , int diffY )
+ :
+ voidStores the initial placement of the linked element. Stores the initial placement of the linked element. Parameters:diffX : intthe X offset, default 0 diffY : intthe Y offset, default 0 Returns: | 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 | 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:
- iTop : intTop pad iRight : intRight pad iBot : intBot pad iLeft : intLeft pad
- Returns:
-
-
-
-
- |
- 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
+will have the first param, the left and right the second. Parameters:iTop : intTop pad iRight : intRight pad iBot : intBot pad iLeft : intLeft pad Returns: | 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.
- |
- 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
+should move iTickSize pixels at a time. Returns: | 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:
- iUp : intthe number of pixels the element can move up iDown : intthe number of pixels the element can move down iTickSize : intoptional parameter for specifying that the
-element should move iTickSize pixels at a time.
- Returns:
-
-
-
-
- |
- 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:
- X : intclick location Y : intclick location
- Returns:
-
-
-
-
- |
- DragDrop |
-
-
- |
-
-
- toString() : string
- toString method
-
- toString method
- Parameters:
-
- Returns:
-
-
-
-
- |
- DragDrop |
-
-
- |
-
-
- unlock() : void
- Unlock this instace
-
- Unlock this instace
- Parameters:
-
- Returns:
-
-
-
-
- |
- DragDrop |
-
-
- |
-
-
- unreg() : void
- Remove all drag and drop hooks for this element
-
- Remove all drag and drop hooks for this element
- Parameters:
-
- Returns:
-
-
-
-
- |
- DragDrop |
-
-