ddGroup : String

A named drag drop group to which this object belongs. ...

A named drag drop group to which this object belongs. If a group is specified, then this object will only\ninteract with other drag drop objects in the same group.

dropAllowed : String

The CSS class returned to the drag source when drop is allowed. ...

The CSS class returned to the drag source when drop is allowed.

Defaults to: Ext.baseCSSPrefix + 'dd-drop-ok'

dropNotAllowed : String

The CSS class returned to the drag source when drop is not allowed. ...

The CSS class returned to the drag source when drop is not allowed.

Defaults to: Ext.baseCSSPrefix + 'dd-drop-nodrop'

overClass : String

The CSS class applied to the drop target element while the drag source is over it. ...

The CSS class applied to the drop target element while the drag source is over it.

Defaults to: ""

Properties

Defined By

Instance Properties

$className : Stringprivate

...

Defaults to: 'Ext.Base'

__ygDragDrop : Booleanprivate

Internal typeof flag ...

Internal typeof flag

Defaults to: true

_domRef : Objectprivate

Cached reference to the linked element

available : Boolean

The available property is false until the linked dom element is accessible. ...

The available property is false until the linked dom element is accessible.

Defaults to: false

config : Object

Configuration attributes passed into the constructor

configMap : Objectprivate

...

Defaults to: {}

constrainX : Booleanprivate

Set to true when horizontal contraints are applied ...

Set to true when horizontal contraints are applied

Defaults to: false

constrainY : Booleanprivate

Set to true when vertical contraints are applied ...

Set to true when vertical contraints are applied

Defaults to: false

defaultPadding : Object

Provides default constraint padding to \"constrainTo\" elements. ...

Provides default constraint padding to \"constrainTo\" elements.

Defaults to: {left: 0, right: 0, top: 0, bottom: 0}

dragElId : Stringprivate

The id of the element that will be dragged. ...

The id of the element that will be dragged. By default this is same\nas the linked element, but could be changed to another element. Ex:\nExt.dd.DDProxy

groups : Object

The group defines a logical collection of DragDrop objects that are\nrelated. ...

The group defines a logical collection of DragDrop objects that are\nrelated. Instances only get events when interacting with other\nDragDrop object in the same group. This lets us define multiple\ngroups using a single DragDrop subclass if we want.

\n\n

An object in the format {'group1':true, 'group2':true}

handleElId : Stringprivate

The ID of the element that initiates the drag operation. ...

The ID of the element that initiates the drag operation. By default\nthis is the linked element, but could be changed to be a child of this\nelement. This lets us do things like only starting the drag when the\nheader element within the linked html element is clicked.

hasOuterHandles : Boolean

By default, drags can only be initiated if the mousedown occurs in the\nregion the linked element is. ...

By default, drags can only be initiated if the mousedown occurs in the\nregion the linked element is. This is done in part to work around a\nbug in some browsers that mis-report the mousedown if the previous\nmouseup happened outside of the window. This property is set to true\nif outer handles are defined. Defaults to false.

Defaults to: false

id : String

The id of the element associated with this object. ...

The id of the element associated with this object. This is what we\nrefer to as the \"linked element\" because the size and position of\nthis element is used to determine when the drag and drop objects have\ninteracted.

ignoreSelf : Boolean

Set to false to enable a DragDrop object to fire drag events while dragging\nover its own Element. ...

Set to false to enable a DragDrop object to fire drag events while dragging\nover its own Element. Defaults to true - DragDrop objects do not by default\nfire drag events to themselves.

Ext.view.DropZone
view source

indicatorCls : Stringprivate

...

Defaults to: Ext.baseCSSPrefix + 'grid-drop-indicator'

Ext.view.DropZone
view source

indicatorHtml : Stringprivate

...

Defaults to: '<div class="' + Ext.baseCSSPrefix + 'grid-drop-indicator-left"></div><div class="' + Ext.baseCSSPrefix + 'grid-drop-indicator-right"></div>'

initConfigList : Arrayprivate

...

Defaults to: []

initConfigMap : Objectprivate

...

Defaults to: {}

invalidHandleClasses : String[]

An Array of CSS class names for elements to be considered in valid as drag handles.

invalidHandleIds : Object

An object who's property names identify the IDs of elements to be considered invalid as drag handles. ...

An object who's property names identify the IDs of elements to be considered invalid as drag handles.\nA non-null property value identifies the ID as invalid. For example, to prevent\ndragging from being initiated on element ID \"foo\", use:

\n\n

{\n    foo: true\n}\n

invalidHandleTypes : Object

An object who's property names identify HTML tags to be considered invalid as drag handles. ...

An object who's property names identify HTML tags to be considered invalid as drag handles.\nA non-null property value identifies the tag as invalid. Defaults to the\nfollowing value which prevents drag operations from being initiated by <a> elements:

\n\n

{\n    A: \"A\"\n}\n

isInstance : Booleanprivate

...

Defaults to: true

isNotifyTarget : Booleanprivate

private ...

private

Defaults to: true

isTarget : Boolean

private\n\nBy default, all instances can be a drop target. ...

private

\n\n

By default, all instances can be a drop target. This can be disabled by\nsetting isTarget to false.

Defaults to: true

Overrides: Ext.dd.DragDrop.isTarget

locked : Booleanprivate

Individual drag/drop instances can be locked. ...

Individual drag/drop instances can be locked. This will prevent\nonmousedown start drag.

Defaults to: false

maintainOffset : Boolean

Maintain offsets when we resetconstraints. ...

Maintain offsets when we resetconstraints. Set to true when you want\nthe position of the element relative to its parent to stay the same\nwhen the page changes

Defaults to: false

maxX : Numberprivate

The right constraint ...

The right constraint

Defaults to: 0

maxY : Numberprivate

The down constraint ...

The down constraint

Defaults to: 0

minX : Numberprivate

The left constraint ...

The left constraint

Defaults to: 0

minY : Numberprivate

The up constraint ...

The up constraint

Defaults to: 0

moveOnly : Boolean

When set to true, other DD objects in cooperating DDGroups do not receive\nnotification events when this DD object is ...

When set to true, other DD objects in cooperating DDGroups do not receive\nnotification events when this DD object is dragged over them.

Defaults to: false

padding : Number[]

The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object. ...

The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.\nAn array containing the 4 padding values: [top, right, bottom, left]

primaryButtonOnly : Boolean

By default the drag and drop instance will only respond to the primary\nbutton click (left button for a right-handed m...

By default the drag and drop instance will only respond to the primary\nbutton click (left button for a right-handed mouse). Set to true to\nallow drag and drop to start with any mouse click that is propogated\nby the browser

Defaults to: true

self : Ext.Classprotected

Get the reference to the current class from which this object was instantiated. ...

Get the reference to the current class from which this object was instantiated. Unlike statics,\nthis.self is scope-dependent and it's meant to be used for dynamic inheritance. See statics\nfor a detailed comparison

\n\n

Ext.define('My.Cat', {\n    statics: {\n        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n    },\n\n    constructor: function() {\n        alert(this.self.speciesName); // dependent on 'this'\n    },\n\n    clone: function() {\n        return new this.self();\n    }\n});\n\n\nExt.define('My.SnowLeopard', {\n    extend: 'My.Cat',\n    statics: {\n        speciesName: 'Snow Leopard'         // My.SnowLeopard.speciesName = 'Snow Leopard'\n    }\n});\n\nvar cat = new My.Cat();                     // alerts 'Cat'\nvar snowLeopard = new My.SnowLeopard();     // alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone));             // alerts 'My.SnowLeopard'\n

startPageX : Numberprivate

The linked element's absolute X position at the time the drag was\nstarted ...

The linked element's absolute X position at the time the drag was\nstarted

Defaults to: 0

startPageY : Numberprivate

The linked element's absolute X position at the time the drag was\nstarted ...

The linked element's absolute X position at the time the drag was\nstarted

Defaults to: 0

xTicks : Number[]

Array of pixel locations the element will snap to if we specified a\nhorizontal graduation/interval. ...

Array of pixel locations the element will snap to if we specified a\nhorizontal graduation/interval. This array is generated automatically\nwhen you define a tick interval.

yTicks : Number[]

Array of pixel locations the element will snap to if we specified a\nvertical graduation/interval. ...

Array of pixel locations the element will snap to if we specified a\nvertical graduation/interval. This array is generated automatically\nwhen you define a tick interval.

Defined By

Static Properties

$onExtended : Arrayprivatestatic

...

Defaults to: []

Methods

Defined By

Instance Methods

Ext.view.DropZone
view source

newExt.view.DropZone( el, config ) : Ext.view.DropZone

Creates new DropTarget. ...

Creates new DropTarget.

Parameters

el : String/HTMLElement/Ext.Element
The container element or ID of it.
\n
config : Object
\n

Returns

Ext.view.DropZone
\n

Overrides: Ext.dd.DropTarget.constructor

addInvalidHandleClass( )

Overridden and disabled. ...

Overridden and disabled. A DDTarget does not support being dragged.

Overrides: Ext.dd.DragDrop.addInvalidHandleClass

addInvalidHandleId( )

Overridden and disabled. ...

Overridden and disabled. A DDTarget does not support being dragged.

Overrides: Ext.dd.DragDrop.addInvalidHandleId

addInvalidHandleType( )

Overridden and disabled. ...

Overridden and disabled. A DDTarget does not support being dragged.

Overrides: Ext.dd.DragDrop.addInvalidHandleType

addToGroup( sGroup )

Adds this instance to a group of related drag/drop objects. ...

Adds this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.

Parameters

sGroup : String
the name of the group
\n

applyConfig( )

Applies the configuration parameters that were passed into the constructor. ...

Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.

b4Drag( e )private

Code that executes immediately before the onDrag event ...

Code that executes immediately before the onDrag event

Parameters

e : Object
\n

b4DragDrop( e )private

Code that executes immediately before the onDragDrop event ...

Code that executes immediately before the onDragDrop event

Parameters

e : Object
\n

b4DragOut( e )private

Code that executes immediately before the onDragOut event ...

Code that executes immediately before the onDragOut event

Parameters

e : Object
\n

b4DragOver( e )private

Code that executes immediately before the onDragOver event ...

Code that executes immediately before the onDragOver event

Parameters

e : Object
\n

b4EndDrag( e )private

Code that executes immediately before the endDrag event ...

Code that executes immediately before the endDrag event

Parameters

e : Object
\n

b4MouseDown( e )private

Code executed immediately before the onMouseDown event ...

Code executed immediately before the onMouseDown event

Parameters

e : Event
the mousedown event
\n

b4StartDrag( x, y )private

Code that executes immediately before the startDrag event ...

Code that executes immediately before the startDrag event

Parameters

x : Object
\n
y : Object
\n

callOverridden( args ) : Objectdeprecatedprotected

Call the original method that was previously overridden with override\n\nExt.define('My.Cat', {\n constructor: functi...

Call the original method that was previously overridden with override

\n\n

Ext.define('My.Cat', {\n    constructor: function() {\n        alert(\"I'm a cat!\");\n    }\n});\n\nMy.Cat.override({\n    constructor: function() {\n        alert(\"I'm going to be a cat!\");\n\n        this.callOverridden();\n\n        alert(\"Meeeeoooowwww\");\n    }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n                          // alerts \"I'm a cat!\"\n                          // alerts \"Meeeeoooowwww\"\n

This method has been deprecated

as of 4.1. Use callParent instead.

\n\n

Parameters

args : Array/Arguments
The arguments, either an array or the arguments object\nfrom the current method, for example: this.callOverridden(arguments)
\n

Returns

Object
Returns the result of calling the overridden method
\n

callParent( args ) : Objectprotected

Call the \"parent\" method of the current method. ...

Call the \"parent\" method of the current method. That is the method previously\noverridden by derivation or by an override (see Ext.define).

\n\n

 Ext.define('My.Base', {\n     constructor: function (x) {\n         this.x = x;\n     },\n\n     statics: {\n         method: function (x) {\n             return x;\n         }\n     }\n });\n\n Ext.define('My.Derived', {\n     extend: 'My.Base',\n\n     constructor: function () {\n         this.callParent([21]);\n     }\n });\n\n var obj = new My.Derived();\n\n alert(obj.x);  // alerts 21\n

\n\n

This can be used with an override as follows:

\n\n

 Ext.define('My.DerivedOverride', {\n     override: 'My.Derived',\n\n     constructor: function (x) {\n         this.callParent([x*2]); // calls original My.Derived constructor\n     }\n });\n\n var obj = new My.Derived();\n\n alert(obj.x);  // now alerts 42\n

\n\n

This also works with static methods.

\n\n

 Ext.define('My.Derived2', {\n     extend: 'My.Base',\n\n     statics: {\n         method: function (x) {\n             return this.callParent([x*2]); // calls My.Base.method\n         }\n     }\n });\n\n alert(My.Base.method(10);     // alerts 10\n alert(My.Derived2.method(10); // alerts 20\n

\n\n

Lastly, it also works with overridden static methods.

\n\n

 Ext.define('My.Derived2Override', {\n     override: 'My.Derived2',\n\n     statics: {\n         method: function (x) {\n             return this.callParent([x*2]); // calls My.Derived2.method\n         }\n     }\n });\n\n alert(My.Derived2.method(10); // now alerts 40\n

\n\n

To override a method and replace it and also call the superclass method, use\ncallSuper. This is often done to patch a method to fix a bug.

Parameters

args : Array/Arguments
The arguments, either an array or the arguments object\nfrom the current method, for example: this.callParent(arguments)
\n

Returns

Object
Returns the result of calling the parent method
\n

callSuper( args ) : Objectprotected

This method is used by an override to call the superclass method but bypass any\noverridden method. ...

This method is used by an override to call the superclass method but bypass any\noverridden method. This is often done to \"patch\" a method that contains a bug\nbut for whatever reason cannot be fixed directly.

\n\n

Consider:

\n\n

 Ext.define('Ext.some.Class', {\n     method: function () {\n         console.log('Good');\n     }\n });\n\n Ext.define('Ext.some.DerivedClass', {\n     method: function () {\n         console.log('Bad');\n\n         // ... logic but with a bug ...\n\n         this.callParent();\n     }\n });\n

\n\n

To patch the bug in DerivedClass.method, the typical solution is to create an\noverride:

\n\n

 Ext.define('App.paches.DerivedClass', {\n     override: 'Ext.some.DerivedClass',\n\n     method: function () {\n         console.log('Fixed');\n\n         // ... logic but with bug fixed ...\n\n         this.callSuper();\n     }\n });\n

\n\n

The patch method cannot use callParent to call the superclass method since\nthat would call the overridden method containing the bug. In other words, the\nabove patch would only produce \"Fixed\" then \"Good\" in the console log, whereas,\nusing callParent would produce \"Fixed\" then \"Bad\" then \"Good\".

Parameters

args : Array/Arguments
The arguments, either an array or the arguments object\nfrom the current method, for example: this.callSuper(arguments)
\n

Returns

Object
Returns the result of calling the superclass method
\n

clearConstraints( )

Overridden and disabled. ...

Overridden and disabled. A DDTarget does not support being dragged.

Overrides: Ext.dd.DragDrop.clearConstraints

clearTicks( )

Overridden and disabled. ...

Overridden and disabled. A DDTarget does not support being dragged.

Overrides: Ext.dd.DragDrop.clearTicks

clickValidator( e )private

...

Parameters

e : Object
\n

configClass( )private

...

constrainTo( constrainTo, [pad], [inContent] )

Initializes the drag drop object's constraints to restrict movement to a certain element. ...

Initializes the drag drop object's constraints to restrict movement to a certain element.

\n\n

Usage:

\n\n

var dd = new Ext.dd.DDProxy(\"dragDiv1\", \"proxytest\",\n               { dragElId: \"existingProxyDiv\" });\ndd.startDrag = function(){\n    this.constrainTo(\"parent-id\");\n};\n

\n\n

Or you can initalize it using the Ext.Element object:

\n\n

Ext.get(\"dragDiv1\").initDDProxy(\"proxytest\", {dragElId: \"existingProxyDiv\"}, {\n    startDrag : function(){\n        this.constrainTo(\"parent-id\");\n    }\n});\n

Parameters

constrainTo : String/HTMLElement/Ext.Element
The element or element ID to constrain to.
\n
pad : Object/Number (optional)
Pad provides a way to specify \"padding\" of the constraints,\nand can be either a number for symmetrical padding (4 would be equal to {left:4, right:4, top:4, bottom:4}) or\nan object containing the sides to pad. For example: {right:10, bottom:10}
\n
inContent : Boolean (optional)
Constrain the draggable in the content box of the element (inside padding and borders)
\n

Ext.view.DropZone
view source

containsRecordAtOffset( records, record, offset ) : Booleanprivate

Determines whether the record at the specified offset from the passed record\nis in the drag payload. ...

Determines whether the record at the specified offset from the passed record\nis in the drag payload.

Parameters

records : Object
\n
record : Object
\n
offset : Object
\n

Returns

Boolean
True if the targeted record is in the drag payload
\n

Ext.view.DropZone
view source

destroy( )

Destroy this DragDrop instance ...

Destroy this DragDrop instance

Overrides: Ext.dd.DropTarget.destroy

endDrag( )

Overridden and disabled. ...

Overridden and disabled. A DDTarget does not support being dragged.

Overrides: Ext.dd.DragDrop.endDrag

Ext.view.DropZone
view source

fireViewEvent( )private

Fire an event through the client DataView. ...

Fire an event through the client DataView. Lock this DropZone during the event processing so that\nits data does not become corrupted by processing mouse events.

getConfig( name )private

...

Parameters

name : Object
\n

getDragEl( )

Overridden and disabled. ...

Overridden and disabled. A DDTarget does not support being dragged.

Overrides: Ext.dd.DragDrop.getDragEl

getEl( ) : HTMLElement

Returns a reference to the linked element ...

Returns a reference to the linked element

Returns

HTMLElement
the html element
\n

Ext.view.DropZone
view source

getIndicator( )private

...

getInitialConfig( [name] ) : Object/Mixed

Returns the initial configuration passed to constructor when instantiating\nthis class. ...

Returns the initial configuration passed to constructor when instantiating\nthis class.

Parameters

name : String (optional)
Name of the config option to return.
\n

Returns

Object/Mixed
The full config object or a single config value\nwhen name parameter specified.
\n

Ext.view.DropZone
view source

getPosition( e, node )private

...

Parameters

e : Object
\n
node : Object
\n

Ext.view.DropZone
view source

getTargetFromEvent( e ) : Object

Returns a custom data object associated with the DOM node that is the target of the event. ...

Returns a custom data object associated with the DOM node that is the target of the event. By default\nthis looks up the event target in the Ext.dd.Registry, although you can override this method to\nprovide your own custom lookup.

Parameters

e : Event
The event
\n

Returns

Object
data The custom data
\n

Overrides: Ext.dd.DropZone.getTargetFromEvent

getTick( val, tickArray ) : Numberprivate

Normally the drag element is moved pixel by pixel, but we can specify\nthat it move a number of pixels at a time. ...

Normally the drag element is moved pixel by pixel, but we can specify\nthat it move a number of pixels at a time. This method resolves the\nlocation when we have it set up like this.

Parameters

val : Number
where we want to place the object
\n
tickArray : Number[]
sorted array of valid points
\n

Returns

Number
the closest tick
\n

handleMouseDown( e, oDD )private

Called when this object is clicked ...

Called when this object is clicked

Parameters

e : Event
\n
oDD : Ext.dd.DragDrop
the clicked dd object (this dd obj)
\n

handleOnAvailable( )private

Executed when the linked element is available ...

Executed when the linked element is available

hasConfig( config )private

...

Parameters

config : Object
\n

init( id, sGroup, config )

Sets up the DragDrop object. ...

Sets up the DragDrop object. Must be called in the constructor of any\nExt.dd.DragDrop subclass

Parameters

id : String
the id of the linked element
\n
sGroup : String
the group of related items
\n
config : Object
configuration attributes
\n

initConfig( config ) : Ext.Basechainableprotected

Initialize configuration for this class. ...

Initialize configuration for this class. a typical example:

\n\n

Ext.define('My.awesome.Class', {\n    // The default config\n    config: {\n        name: 'Awesome',\n        isAwesome: true\n    },\n\n    constructor: function(config) {\n        this.initConfig(config);\n    }\n});\n\nvar awesome = new My.awesome.Class({\n    name: 'Super Awesome'\n});\n\nalert(awesome.getName()); // 'Super Awesome'\n

Parameters

config : Object
\n

Returns

Ext.Base
this
\n

initTarget( id, sGroup, config )

Initializes Targeting functionality only... ...

Initializes Targeting functionality only... the object does not\nget a mousedown handler.

Parameters

id : String
the id of the linked element
\n
sGroup : String
the group of related items
\n
config : Object
configuration attributes
\n

Ext.view.DropZone
view source

invalidateDrop( )private

...

isLocked( ) : Boolean

Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on th...

Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)

Returns

Boolean
true if this obj or all drag/drop is locked, else\nfalse
\n

isValidHandleChild( )

Overridden and disabled. ...

Overridden and disabled. A DDTarget does not support being dragged.

Overrides: Ext.dd.DragDrop.isValidHandleChild

lock( )

Locks this instance ...

Locks this instance

notifyDrop( source, e, data ) : Booleantemplate

The function a Ext.dd.DragSource calls once to notify this drop zone that the dragged item has\nbeen dropped on it. ...

The function a Ext.dd.DragSource calls once to notify this drop zone that the dragged item has\nbeen dropped on it. The drag zone will look up the target node based on the event passed in, and if there\nis a node registered for that event, it will delegate to onNodeDrop for node-specific handling,\notherwise it will call onContainerDrop.

This is a template method.\n a hook into the functionality of this class.\n Feel free to override it in child classes.

Parameters

source : Ext.dd.DragSource
The drag source that was dragged over this drop zone
\n
e : Event
The event
\n
data : Object
An object containing arbitrary data supplied by the drag source
\n

Returns

Boolean
False if the drop was invalid.
\n

Overrides: Ext.dd.DropTarget.notifyDrop

notifyEnter( source, e, data ) : Stringtemplate

The function a Ext.dd.DragSource calls once to notify this drop zone that the source is now over\nthe zone. ...

The function a Ext.dd.DragSource calls once to notify this drop zone that the source is now over\nthe zone. The default implementation returns this.dropNotAllowed and expects that only registered drop\nnodes can process drag drop operations, so if you need the drop zone itself to be able to process drops\nyou should override this method and provide a custom implementation.

This is a template method.\n a hook into the functionality of this class.\n Feel free to override it in child classes.

Parameters

source : Ext.dd.DragSource
The drag source that was dragged over this drop zone
\n
e : Event
The event
\n
data : Object
An object containing arbitrary data supplied by the drag source
\n

Returns

String
status The CSS class that communicates the drop status back to the source so that the\nunderlying Ext.dd.StatusProxy can be updated
\n

Overrides: Ext.dd.DropTarget.notifyEnter

Ext.view.DropZone
view source

notifyOut( source, e, data )template

Moved out of the DropZone without dropping. ...

Moved out of the DropZone without dropping.\nRemove drop position indicator

\n\n

The function a Ext.dd.DragSource calls once to notify this drop zone that the source has been dragged\nout of the zone without dropping. If the drag source is currently over a registered node, the notification\nwill be delegated to onNodeOut for node-specific handling, otherwise it will be ignored.

This is a template method.\n a hook into the functionality of this class.\n Feel free to override it in child classes.

Parameters

source : Ext.dd.DragSource
The drag source that was dragged over this drop target
\n\n
e : Event
The event
\n\n
data : Object
An object containing arbitrary data supplied by the drag zone
\n\n

Overrides: Ext.dd.DropZone.notifyOut

notifyOver( source, e, data ) : Stringtemplate

The function a Ext.dd.DragSource calls continuously while it is being dragged over the drop zone. ...

The function a Ext.dd.DragSource calls continuously while it is being dragged over the drop zone.\nThis method will be called on every mouse movement while the drag source is over the drop zone.\nIt will call onNodeOver while the drag source is over a registered node, and will also automatically\ndelegate to the appropriate node-specific methods as necessary when the drag source enters and exits\nregistered nodes (onNodeEnter, onNodeOut). If the drag source is not currently over a\nregistered node, it will call onContainerOver.

This is a template method.\n a hook into the functionality of this class.\n Feel free to override it in child classes.

Parameters

source : Ext.dd.DragSource
The drag source that was dragged over this drop zone
\n
e : Event
The event
\n
data : Object
An object containing arbitrary data supplied by the drag source
\n

Returns

String
status The CSS class that communicates the drop status back to the source so that the\nunderlying Ext.dd.StatusProxy can be updated
\n

Overrides: Ext.dd.DropTarget.notifyOver

onAvailable( )

Override the onAvailable method to do what is needed after the initial\nposition was determined. ...

Override the onAvailable method to do what is needed after the initial\nposition was determined.

onConfigUpdate( names, callback, scope )private

...

Parameters

names : Object
\n
callback : Object
\n
scope : Object
\n

Ext.view.DropZone
view source

onContainerDrop( source, e, data ) : Booleantemplate

Called when the DropZone determines that a Ext.dd.DragSource has been dropped on it,\nbut not on any of its registered...

Called when the DropZone determines that a Ext.dd.DragSource has been dropped on it,\nbut not on any of its registered drop nodes. The default implementation returns false, so it should be\noverridden to provide the appropriate processing of the drop event if you need the drop zone itself to\nbe able to accept drops. It should return true when valid so that the drag source's repair action does not run.

This is a template method.\n a hook into the functionality of this class.\n Feel free to override it in child classes.

Parameters

source : Ext.dd.DragSource
The drag source that was dragged over this drop zone
\n
e : Event
The event
\n
data : Object
An object containing arbitrary data supplied by the drag source
\n

Returns

Boolean
True if the drop was valid, else false
\n

Overrides: Ext.dd.DropZone.onContainerDrop

Ext.view.DropZone
view source

onContainerOver( source, e, data ) : Stringtemplate

The mouse is past the end of all nodes (or there are no nodes)\n\nCalled while the DropZone determines that a Ext.dd.Dr...

The mouse is past the end of all nodes (or there are no nodes)

\n\n

Called while the DropZone determines that a Ext.dd.DragSource is being dragged over it,\nbut not over any of its registered drop nodes. The default implementation returns this.dropNotAllowed, so\nit should be overridden to provide the proper feedback if necessary.

This is a template method.\n a hook into the functionality of this class.\n Feel free to override it in child classes.

Parameters

source : Ext.dd.DragSource
The drag source that was dragged over this drop zone
\n\n
e : Event
The event
\n\n
data : Object
An object containing arbitrary data supplied by the drag source
\n\n

Returns

String
status The CSS class that communicates the drop status back to the source so that the\nunderlying Ext.dd.StatusProxy can be updated
\n\n

Overrides: Ext.dd.DropZone.onContainerOver

onDrag( )

Overridden and disabled. ...

Overridden and disabled. A DDTarget does not support being dragged.

Overrides: Ext.dd.DragDrop.onDrag

onDragDrop( )

Overridden and disabled. ...

Overridden and disabled. A DDTarget does not support being dragged.

Overrides: Ext.dd.DragDrop.onDragDrop

onDragEnter( )

Overridden and disabled. ...

Overridden and disabled. A DDTarget does not support being dragged.

Overrides: Ext.dd.DragDrop.onDragEnter

onDragOut( )

Overridden and disabled. ...

Overridden and disabled. A DDTarget does not support being dragged.

Overrides: Ext.dd.DragDrop.onDragOut

onDragOver( )

Overridden and disabled. ...

Overridden and disabled. A DDTarget does not support being dragged.

Overrides: Ext.dd.DragDrop.onDragOver

onInvalidDrop( )

Overridden and disabled. ...

Overridden and disabled. A DDTarget does not support being dragged.

Overrides: Ext.dd.DragDrop.onInvalidDrop

onMouseDown( )

Overridden and disabled. ...

Overridden and disabled. A DDTarget does not support being dragged.

Overrides: Ext.dd.DragDrop.onMouseDown

onMouseUp( )

Overridden and disabled. ...

Overridden and disabled. A DDTarget does not support being dragged.

Overrides: Ext.dd.DragDrop.onMouseUp

Ext.view.DropZone
view source

onNodeDrop( nodeData, source, e, data ) : Booleantemplate

Called when the DropZone determines that a Ext.dd.DragSource has been dropped onto\nthe drop node. ...

Called when the DropZone determines that a Ext.dd.DragSource has been dropped onto\nthe drop node. The default implementation returns false, so it should be overridden to provide the\nappropriate processing of the drop event and return true so that the drag source's repair action does not run.

This is a template method.\n a hook into the functionality of this class.\n Feel free to override it in child classes.

Parameters

nodeData : Object
The custom data associated with the drop node (this is the same value returned from\ngetTargetFromEvent for this node)
\n
source : Ext.dd.DragSource
The drag source that was dragged over this drop zone
\n
e : Event
The event
\n
data : Object
An object containing arbitrary data supplied by the drag source
\n

Returns

Boolean
True if the drop was valid, else false
\n

Overrides: Ext.dd.DropZone.onNodeDrop

onNodeEnter( nodeData, source, e, data )

Called when the DropZone determines that a Ext.dd.DragSource has entered a drop node\nthat has either been registered ...

Called when the DropZone determines that a Ext.dd.DragSource has entered a drop node\nthat has either been registered or detected by a configured implementation of getTargetFromEvent.\nThis method has no default implementation and should be overridden to provide\nnode-specific processing if necessary.

Parameters

nodeData : Object
The custom data associated with the drop node (this is the same value returned from\ngetTargetFromEvent for this node)
\n
source : Ext.dd.DragSource
The drag source that was dragged over this drop zone
\n
e : Event
The event
\n
data : Object
An object containing arbitrary data supplied by the drag source
\n

onNodeOut( nodeData, source, e, data )template

Called when the DropZone determines that a Ext.dd.DragSource has been dragged out of\nthe drop node without dropping. ...

Called when the DropZone determines that a Ext.dd.DragSource has been dragged out of\nthe drop node without dropping. This method has no default implementation and should be overridden to provide\nnode-specific processing if necessary.

This is a template method.\n a hook into the functionality of this class.\n Feel free to override it in child classes.

Parameters

nodeData : Object
The custom data associated with the drop node (this is the same value returned from\ngetTargetFromEvent for this node)
\n
source : Ext.dd.DragSource
The drag source that was dragged over this drop zone
\n
e : Event
The event
\n
data : Object
An object containing arbitrary data supplied by the drag source
\n

Ext.view.DropZone
view source

onNodeOver( nodeData, source, e, data ) : Stringtemplate

The mouse is over a View node\n\nCalled while the DropZone determines that a Ext.dd.DragSource is over a drop node\nthat...

The mouse is over a View node

\n\n

Called while the DropZone determines that a Ext.dd.DragSource is over a drop node\nthat has either been registered or detected by a configured implementation of getTargetFromEvent.\nThe default implementation returns this.dropAllowed, so it should be\noverridden to provide the proper feedback.

This is a template method.\n a hook into the functionality of this class.\n Feel free to override it in child classes.

Parameters

nodeData : Object
The custom data associated with the drop node (this is the same value returned from\ngetTargetFromEvent for this node)
\n\n
source : Ext.dd.DragSource
The drag source that was dragged over this drop zone
\n\n
e : Event
The event
\n\n
data : Object
An object containing arbitrary data supplied by the drag source
\n\n

Returns

String
status The CSS class that communicates the drop status back to the source so that the\nunderlying Ext.dd.StatusProxy can be updated
\n\n

Overrides: Ext.dd.DropZone.onNodeOver

Ext.view.DropZone
view source

positionIndicator( node, data, e )private

...

Parameters

node : Object
\n
data : Object
\n
e : Object
\n

removeFromGroup( sGroup )

Removes this instance from the supplied interaction group ...

Removes this instance from the supplied interaction group

Parameters

sGroup : String
The group to drop
\n

removeInvalidHandleClass( )

Overridden and disabled. ...

Overridden and disabled. A DDTarget does not support being dragged.

Overrides: Ext.dd.DragDrop.removeInvalidHandleClass

removeInvalidHandleId( )

Overridden and disabled. ...

Overridden and disabled. A DDTarget does not support being dragged.

Overrides: Ext.dd.DragDrop.removeInvalidHandleId

removeInvalidHandleType( )

Overridden and disabled. ...

Overridden and disabled. A DDTarget does not support being dragged.

Overrides: Ext.dd.DragDrop.removeInvalidHandleType

resetConstraints( )

Overridden and disabled. ...

Overridden and disabled. A DDTarget does not support being dragged.

Overrides: Ext.dd.DragDrop.resetConstraints

setConfig( config, applyIfNotSet ) : Ext.Basechainableprivate

...

Parameters

config : Object
\n
applyIfNotSet : Object
\n

Returns

Ext.Base
this
\n

setDragElId( )

Overridden and disabled. ...

Overridden and disabled. A DDTarget does not support being dragged.

Overrides: Ext.dd.DragDrop.setDragElId

setHandleElId( )

Overridden and disabled. ...

Overridden and disabled. A DDTarget does not support being dragged.

Overrides: Ext.dd.DragDrop.setHandleElId

setInitPosition( )

Overridden and disabled. ...

Overridden and disabled. A DDTarget does not support being dragged.

Overrides: Ext.dd.DragDrop.setInitPosition

setOuterHandleElId( )

Overridden and disabled. ...

Overridden and disabled. A DDTarget does not support being dragged.

Overrides: Ext.dd.DragDrop.setOuterHandleElId

setPadding( iTop, iRight, iBot, iLeft )

Configures the padding for the target zone in px. ...

Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.

Parameters

iTop : Number
Top pad
\n
iRight : Number
Right pad
\n
iBot : Number
Bot pad
\n
iLeft : Number
Left pad
\n

setStartPosition( pos )private

Sets the start position of the element. ...

Sets the start position of the element. This is set when the obj\nis initialized, the reset when a drag is started.

Parameters

pos : Object
current position (from previous lookup)
\n

setXConstraint( )

Overridden and disabled. ...

Overridden and disabled. A DDTarget does not support being dragged.

Overrides: Ext.dd.DragDrop.setXConstraint

setXTicks( iStartX, iTickSize )private

Creates the array of horizontal tick marks if an interval was specified\nin setXConstraint(). ...

Creates the array of horizontal tick marks if an interval was specified\nin setXConstraint().

Parameters

iStartX : Object
\n
iTickSize : Object
\n

setYConstraint( )

Overridden and disabled. ...

Overridden and disabled. A DDTarget does not support being dragged.

Overrides: Ext.dd.DragDrop.setYConstraint

setYTicks( iStartY, iTickSize )private

Creates the array of vertical tick marks if an interval was specified in\nsetYConstraint(). ...

Creates the array of vertical tick marks if an interval was specified in\nsetYConstraint().

Parameters

iStartY : Object
\n
iTickSize : Object
\n

startDrag( )

Overridden and disabled. ...

Overridden and disabled. A DDTarget does not support being dragged.

Overrides: Ext.dd.DragDrop.startDrag

statics( ) : Ext.Classprotected

Get the reference to the class from which this object was instantiated. ...

Get the reference to the class from which this object was instantiated. Note that unlike self,\nthis.statics() is scope-independent and it always returns the class from which it was called, regardless of what\nthis points to during run-time

\n\n

Ext.define('My.Cat', {\n    statics: {\n        totalCreated: 0,\n        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n    },\n\n    constructor: function() {\n        var statics = this.statics();\n\n        alert(statics.speciesName);     // always equals to 'Cat' no matter what 'this' refers to\n                                        // equivalent to: My.Cat.speciesName\n\n        alert(this.self.speciesName);   // dependent on 'this'\n\n        statics.totalCreated++;\n    },\n\n    clone: function() {\n        var cloned = new this.self;                      // dependent on 'this'\n\n        cloned.groupName = this.statics().speciesName;   // equivalent to: My.Cat.speciesName\n\n        return cloned;\n    }\n});\n\n\nExt.define('My.SnowLeopard', {\n    extend: 'My.Cat',\n\n    statics: {\n        speciesName: 'Snow Leopard'     // My.SnowLeopard.speciesName = 'Snow Leopard'\n    },\n\n    constructor: function() {\n        this.callParent();\n    }\n});\n\nvar cat = new My.Cat();                 // alerts 'Cat', then alerts 'Cat'\n\nvar snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone));         // alerts 'My.SnowLeopard'\nalert(clone.groupName);                 // alerts 'Cat'\n\nalert(My.Cat.totalCreated);             // alerts 3\n

Returns

Ext.Class
\n

toString( ) : String

toString method ...

toString method

Returns

String
string representation of the dd obj
\n\n

Overrides: Ext.dd.DragDrop.toString

triggerCacheRefresh( )private

private ...

private

unlock( )

Unlocks this instace ...

Unlocks this instace

unreg( )

Removes all drag and drop hooks for this element ...

Removes all drag and drop hooks for this element

Defined By

Static Methods

addConfig( config )privatestatic

...

Parameters

config : Object
\n

addInheritableStatics( members )chainableprivatestatic

...

Parameters

members : Object
\n

addMember( name, member )chainableprivatestatic

...

Parameters

name : Object
\n
member : Object
\n

addMembers( members )chainablestatic

Add methods / properties to the prototype of this class. ...

Add methods / properties to the prototype of this class.

\n\n

Ext.define('My.awesome.Cat', {\n    constructor: function() {\n        ...\n    }\n});\n\n My.awesome.Cat.addMembers({\n     meow: function() {\n        alert('Meowww...');\n     }\n });\n\n var kitty = new My.awesome.Cat;\n kitty.meow();\n

Parameters

members : Object
\n

addStatics( members ) : Ext.Basechainablestatic

Add / override static properties of this class. ...

Add / override static properties of this class.

\n\n

Ext.define('My.cool.Class', {\n    ...\n});\n\nMy.cool.Class.addStatics({\n    someProperty: 'someValue',      // My.cool.Class.someProperty = 'someValue'\n    method1: function() { ... },    // My.cool.Class.method1 = function() { ... };\n    method2: function() { ... }     // My.cool.Class.method2 = function() { ... };\n});\n

Parameters

members : Object
\n

Returns

Ext.Base
this
\n

addXtype( xtype )chainableprivatestatic

...

Parameters

xtype : Object
\n

borrow( fromClass, members ) : Ext.Basechainableprivatestatic

Borrow another class' members to the prototype of this class. ...

Borrow another class' members to the prototype of this class.

\n\n

Ext.define('Bank', {\n    money: '$$$',\n    printMoney: function() {\n        alert('$$$$$$$');\n    }\n});\n\nExt.define('Thief', {\n    ...\n});\n\nThief.borrow(Bank, ['money', 'printMoney']);\n\nvar steve = new Thief();\n\nalert(steve.money); // alerts '$$$'\nsteve.printMoney(); // alerts '$$$$$$$'\n

Parameters

fromClass : Ext.Base
The class to borrow members from
\n
members : Array/String
The names of the members to borrow
\n

Returns

Ext.Base
this
\n

create( ) : Objectstatic

Create a new instance of this Class. ...

Create a new instance of this Class.

\n\n

Ext.define('My.cool.Class', {\n    ...\n});\n\nMy.cool.Class.create({\n    someConfig: true\n});\n

\n\n

All parameters are passed to the constructor of the class.

Returns

Object
the created instance.
\n

createAlias( alias, origin )static

Create aliases for existing prototype methods. ...

Create aliases for existing prototype methods. Example:

\n\n

Ext.define('My.cool.Class', {\n    method1: function() { ... },\n    method2: function() { ... }\n});\n\nvar test = new My.cool.Class();\n\nMy.cool.Class.createAlias({\n    method3: 'method1',\n    method4: 'method2'\n});\n\ntest.method3(); // test.method1()\n\nMy.cool.Class.createAlias('method5', 'method3');\n\ntest.method5(); // test.method3() -> test.method1()\n

Parameters

alias : String/Object
The new method name, or an object to set multiple aliases. See\nflexSetter
\n
origin : String/Object
The original method name
\n

extend( config )privatestatic

...

Parameters

config : Object
\n

getName( ) : Stringstatic

Get the current class' name in string format. ...

Get the current class' name in string format.

\n\n

Ext.define('My.cool.Class', {\n    constructor: function() {\n        alert(this.self.getName()); // alerts 'My.cool.Class'\n    }\n});\n\nMy.cool.Class.getName(); // 'My.cool.Class'\n

Returns

String
className
\n

implement( )deprecatedstatic

Adds members to class. ...

Adds members to class.

This method has been deprecated since 4.1

Use addMembers instead.

\n\n

mixin( name, mixinClass )privatestatic

Used internally by the mixins pre-processor ...

Used internally by the mixins pre-processor

Parameters

name : Object
\n
mixinClass : Object
\n

onExtended( fn, scope )chainableprivatestatic

...

Parameters

fn : Object
\n
scope : Object
\n

override( members ) : Ext.Basechainabledeprecatedstatic

Override members of this class. ...

Override members of this class. Overridden methods can be invoked via\ncallParent.

\n\n

Ext.define('My.Cat', {\n    constructor: function() {\n        alert(\"I'm a cat!\");\n    }\n});\n\nMy.Cat.override({\n    constructor: function() {\n        alert(\"I'm going to be a cat!\");\n\n        this.callParent(arguments);\n\n        alert(\"Meeeeoooowwww\");\n    }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n                          // alerts \"I'm a cat!\"\n                          // alerts \"Meeeeoooowwww\"\n

\n\n

As of 4.1, direct use of this method is deprecated. Use Ext.define\ninstead:

\n\n

Ext.define('My.CatOverride', {\n    override: 'My.Cat',\n    constructor: function() {\n        alert(\"I'm going to be a cat!\");\n\n        this.callParent(arguments);\n\n        alert(\"Meeeeoooowwww\");\n    }\n});\n

\n\n

The above accomplishes the same result but can be managed by the Ext.Loader\nwhich can properly order the override and its target class and the build process\ncan determine whether the override is needed based on the required state of the\ntarget class (My.Cat).

This method has been deprecated since 4.1.0

Use Ext.define instead

\n\n

Parameters

members : Object
The properties to add to this class. This should be\nspecified as an object literal containing one or more properties.
\n

Returns

Ext.Base
this class
\n