X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/6746dc89c47ed01b165cc1152533605f97eb8e8d..f562e4c6e5fac7bcb445985b99acbea4d706e6f0:/docs/output/Ext.grid.plugin.DragDrop.js?ds=inline diff --git a/docs/output/Ext.grid.plugin.DragDrop.js b/docs/output/Ext.grid.plugin.DragDrop.js index b9491744..3e904704 100644 --- a/docs/output/Ext.grid.plugin.DragDrop.js +++ b/docs/output/Ext.grid.plugin.DragDrop.js @@ -1,339 +1 @@ -Ext.data.JsonP.Ext_grid_plugin_DragDrop({ - "allMixins": [ - - ], - "deprecated": null, - "docauthor": null, - "members": { - "cfg": [ - { - "type": "String", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "DragDrop2.html#Ext-grid-plugin-DragDrop-cfg-ddGroup", - "shortDoc": "A named drag drop group to which this object belongs. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/grid/plugin/DragDrop.js", - "private": false, - "name": "ddGroup", - "owner": "Ext.grid.plugin.DragDrop", - "doc": "
A named drag drop group to which this object belongs. If a group is specified, then both the DragZones and DropZone\nused by this plugin will only interact with other drag drop objects in the same group (defaults to 'TreeDD').
\n", - "linenr": 90, - "html_filename": "DragDrop2.html" - }, - { - "type": "String", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "DragDrop2.html#Ext-grid-plugin-DragDrop-cfg-dragGroup", - "shortDoc": "The ddGroup to which the DragZone will belong. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/grid/plugin/DragDrop.js", - "private": false, - "name": "dragGroup", - "owner": "Ext.grid.plugin.DragDrop", - "doc": "The ddGroup to which the DragZone will belong.
\n\n\nThis defines which other DropZones the DragZone will interact with. Drag/DropZones only interact with other Drag/DropZones\nwhich are members of the same ddGroup.
\n\n", - "linenr": 97, - "html_filename": "DragDrop2.html" - }, - { - "type": "String", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "DragDrop2.html#Ext-grid-plugin-DragDrop-cfg-dropGroup", - "shortDoc": "The ddGroup to which the DropZone will belong. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/grid/plugin/DragDrop.js", - "private": false, - "name": "dropGroup", - "owner": "Ext.grid.plugin.DragDrop", - "doc": "The ddGroup to which the DropZone will belong.
\n\n\nThis defines which other DragZones the DropZone will interact with. Drag/DropZones only interact with other Drag/DropZones\nwhich are members of the same ddGroup.
\n\n", - "linenr": 104, - "html_filename": "DragDrop2.html" - }, - { - "type": "Boolean", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "DragDrop2.html#Ext-grid-plugin-DragDrop-cfg-enableDrag", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/grid/plugin/DragDrop.js", - "private": false, - "name": "enableDrag", - "owner": "Ext.grid.plugin.DragDrop", - "doc": "Defaults to true
Set to false
to disallow dragging items from the View
Defaults to true
Set to false
to disallow the View from accepting drop gestures
The destroy method is invoked by the owning Component at the time the Component is being destroyed.
\n\n\nThe supplied implementation is empty. Subclasses should perform plugin cleanup in their own implementation of this method.
\n\n", - "linenr": 42, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "AbstractPlugin.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractPlugin.html#Ext-AbstractPlugin-method-disable", - "shortDoc": "The base implementation just sets the plugin's disabled flag to true\n\n\nPlugin subclasses which need more complex proc...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractPlugin.js", - "private": false, - "params": [ - - ], - "name": "disable", - "owner": "Ext.AbstractPlugin", - "doc": "The base implementation just sets the plugin's disabled
flag to true
Plugin subclasses which need more complex processing may implement an overriding implementation.
\n\n", - "linenr": 57, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "AbstractPlugin.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractPlugin.html#Ext-AbstractPlugin-method-enable", - "shortDoc": "The base implementation just sets the plugin's disabled flag to false\n\n\nPlugin subclasses which need more complex pro...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractPlugin.js", - "private": false, - "params": [ - - ], - "name": "enable", - "owner": "Ext.AbstractPlugin", - "doc": "The base implementation just sets the plugin's disabled
flag to false
Plugin subclasses which need more complex processing may implement an overriding implementation.
\n\n", - "linenr": 49, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "AbstractPlugin.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractPlugin.html#Ext-AbstractPlugin-method-init", - "shortDoc": "The init method is invoked after initComponent has been run for the client Component. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractPlugin.js", - "private": false, - "params": [ - { - "type": "Component", - "optional": false, - "doc": "The client Component which owns this plugin.
\n", - "name": "client" - } - ], - "name": "init", - "owner": "Ext.AbstractPlugin", - "doc": "The init method is invoked after initComponent has been run for the client Component.
\n\n\nThe supplied implementation is empty. Subclasses should perform plugin initialization, and set up bidirectional\nlinks between the plugin and its client Component in their own implementation of this method.
\n\n", - "linenr": 33, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "AbstractPlugin.html" - } - ], - "property": [ - - ], - "cssVar": [ - - ], - "cssMixin": [ - - ], - "event": [ - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "href": "DragDrop2.html#Ext-grid-plugin-DragDrop-event-beforedrop", - "shortDoc": "This event is fired through the GridView. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/grid/plugin/DragDrop.js", - "private": false, - "params": [ - { - "type": "HtmlElement", - "optional": false, - "doc": "The GridView node if any over which the mouse was positioned.
\n\nReturning false
to this event signals that the drop gesture was invalid, and if the drag proxy\nwill animate back to the point from which the drag began.
Returning 0
To this event signals that the data transfer operation should not take place, but\nthat the gesture was valid, and that the repair operation should not take place.
Any other return value continues with the data transfer operation.
\n\n", - "name": "node" - }, - { - "type": "Object", - "optional": false, - "doc": "The data object gathered at mousedown time by the cooperating DragZone's\ngetDragData method it contains the following properties:
copy
property, or true
if the GridView was configured\n with allowCopy: true
and the control key was pressed when the drag operation was begunThe Model over which the drop gesture took place.
\n", - "name": "overModel" - }, - { - "type": "String", - "optional": false, - "doc": "\"before\"
or \"after\"
depending on whether the mouse is above or below the midline of the node.
A function to call to complete the data transfer operation and either move or copy Model instances from the source\nView's Store to the destination View's Store.
\n\n\nThis is useful when you want to perform some kind of asynchronous processing before confirming\nthe drop, such as an confirm call, or an Ajax request.
\n\n\nReturn 0
from this event handler, and call the dropFunction
at any time to perform the data transfer.
The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "beforedrop", - "owner": "Ext.grid.plugin.DragDrop", - "doc": "This event is fired through the GridView. Add listeners to the GridView object
\n\n\nFired when a drop gesture has been triggered by a mouseup event in a valid drop position in the GridView.\n\n", - "linenr": 32, - "html_filename": "DragDrop2.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "href": "DragDrop2.html#Ext-grid-plugin-DragDrop-event-drop", - "shortDoc": "This event is fired through the GridView. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/grid/plugin/DragDrop.js", - "private": false, - "params": [ - { - "type": "HtmlElement", - "optional": false, - "doc": "
The GridView node if any over which the mouse was positioned.
\n", - "name": "node" - }, - { - "type": "Object", - "optional": false, - "doc": "The data object gathered at mousedown time by the cooperating DragZone's\ngetDragData method it contains the following properties:
copy
property, or true
if the GridView was configured\n with allowCopy: true
and the control key was pressed when the drag operation was begunThe Model over which the drop gesture took place.
\n", - "name": "overModel" - }, - { - "type": "String", - "optional": false, - "doc": "\"before\"
or \"after\"
depending on whether the mouse is above or below the midline of the node.
The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "drop", - "owner": "Ext.grid.plugin.DragDrop", - "doc": "This event is fired through the GridView. Add listeners to the GridView object\nFired when a drop operation has been completed and the data has been moved or copied.
\n", - "linenr": 65, - "html_filename": "DragDrop2.html" - } - ] - }, - "singleton": false, - "alias": null, - "superclasses": [ - "Ext.AbstractPlugin" - ], - "protected": false, - "tagname": "class", - "mixins": [ - - ], - "href": "DragDrop2.html#Ext-grid-plugin-DragDrop", - "subclasses": [ - - ], - "static": false, - "author": null, - "component": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/grid/plugin/DragDrop.js", - "private": false, - "alternateClassNames": [ - - ], - "name": "Ext.grid.plugin.DragDrop", - "doc": "This plugin provides drag and/or drop functionality for a GridView.
\n\n\nIt creates a specialized instance of DragZone which knows how to drag out of a GridView\nand loads the data object which is passed to a cooperating DragZone's methods with the following properties:
copy
property, or true
if the GridView was configured\n with allowCopy: true
and the control key was pressed when the drag operation was begun.It also creates a specialized instance of Ext.dd.DropZone which cooperates with other DropZones which are members of the same\nddGroup which processes such data objects.
\n\n\nAdding this plugin to a view means that two new events may be fired from the client GridView, beforedrop
and\ndrop
Hierarchy
Ext.BaseExt.AbstractPluginExt.grid.plugin.DragDropUses
Files
This plugin provides drag and/or drop functionality for a GridView.
\n\nIt creates a specialized instance of DragZone which knows how to drag out of a GridView and loads the data object which is passed to a cooperating DragZone's\nmethods with the following properties:
\n\ncopy
: Boolean
The value of the GridView's copy
property, or true
if the GridView was configured with allowCopy: true
and\nthe control key was pressed when the drag operation was begun.
view
: GridView
The source GridView from which the drag originated.
ddel
: HtmlElement
The drag proxy element which moves with the mouse
item
: HtmlElement
The GridView node upon which the mousedown event was registered.
records
: Array
An Array of Models representing the selected data being dragged from the source GridView.
It also creates a specialized instance of Ext.dd.DropZone which cooperates with other DropZones which are\nmembers of the same ddGroup which processes such data objects.
\n\nAdding this plugin to a view means that two new events may be fired from the client GridView, beforedrop
and drop
Ext.create('Ext.data.Store', {\n storeId:'simpsonsStore',\n fields:['name'],\n data: [[\"Lisa\"], [\"Bart\"], [\"Homer\"], [\"Marge\"]],\n proxy: {\n type: 'memory',\n reader: 'array'\n }\n});\n\nExt.create('Ext.grid.Panel', {\n store: 'simpsonsStore',\n columns: [\n {header: 'Name', dataIndex: 'name', flex: true}\n ],\n viewConfig: {\n plugins: {\n ptype: 'gridviewdragdrop',\n dragText: 'Drag and drop to reorganize'\n }\n },\n height: 200,\n width: 400,\n renderTo: Ext.getBody()\n});\n
\nA named drag drop group to which this object belongs. If a group is specified, then both the DragZones and\nDropZone used by this plugin will only interact with other drag drop objects in the same group.
\nDefaults to: "GridDD"
The ddGroup to which the DragZone will belong.
\n\nThis defines which other DropZones the DragZone will interact with. Drag/DropZones only interact with other\nDrag/DropZones which are members of the same ddGroup.
\nThe ddGroup to which the DropZone will belong.
\n\nThis defines which other DragZones the DropZone will interact with. Drag/DropZones only interact with other\nDrag/DropZones which are members of the same ddGroup.
\nFalse to disallow dragging items from the View.
\nDefaults to: true
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
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 return 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
\nCall the original method that was previously overridden with override
\n\nExt.define('My.Cat', {\n constructor: function() {\n alert(\"I'm a cat!\");\n\n return this;\n }\n});\n\nMy.Cat.override({\n constructor: function() {\n alert(\"I'm going to be a cat!\");\n\n var instance = this.callOverridden();\n\n alert(\"Meeeeoooowwww\");\n\n return instance;\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
\nThe arguments, either an array or the arguments
object
Returns the result after calling the overridden method
\nCall the parent's overridden method. For example:
\n\nExt.define('My.own.A', {\n constructor: function(test) {\n alert(test);\n }\n});\n\nExt.define('My.own.B', {\n extend: 'My.own.A',\n\n constructor: function(test) {\n alert(test);\n\n this.callParent([test + 1]);\n }\n});\n\nExt.define('My.own.C', {\n extend: 'My.own.B',\n\n constructor: function() {\n alert(\"Going to call parent's overriden constructor...\");\n\n this.callParent(arguments);\n }\n});\n\nvar a = new My.own.A(1); // alerts '1'\nvar b = new My.own.B(1); // alerts '1', then alerts '2'\nvar c = new My.own.C(2); // alerts \"Going to call parent's overriden constructor...\"\n // alerts '2', then alerts '3'\n
\nThe arguments, either an array or the arguments
object\nfrom the current method, for example: this.callParent(arguments)
Returns the result from the superclass' method
\nThe destroy method is invoked by the owning Component at the time the Component is being destroyed.
\n\nThe supplied implementation is empty. Subclasses should perform plugin cleanup in their own implementation of\nthis method.
\nThe base implementation just sets the plugin's disabled
flag to true
Plugin subclasses which need more complex processing may implement an overriding implementation.
\nThe base implementation just sets the plugin's disabled
flag to false
Plugin subclasses which need more complex processing may implement an overriding implementation.
\nThe init method is invoked after initComponent method has been run for the client Component.
\n\nThe supplied implementation is empty. Subclasses should perform plugin initialization, and set up bidirectional\nlinks between the plugin and its client Component in their own implementation of this method.
\nThe client Component which owns this plugin.
\nInitialize configuration for this class. a typical example:
\n\nExt.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 return this;\n }\n});\n\nvar awesome = new My.awesome.Class({\n name: 'Super Awesome'\n});\n\nalert(awesome.getName()); // 'Super Awesome'\n
\nmixins The mixin prototypes as key - value pairs
\nGet 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
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 return this;\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
\nAdd / override static properties of this class.
\n\nExt.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
\nthis
\nBorrow another class' members to the prototype of this class.
\n\nExt.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
\nThe class to borrow members from
\nThe names of the members to borrow
\nthis
\nCreate a new instance of this Class.
\n\nExt.define('My.cool.Class', {\n ...\n});\n\nMy.cool.Class.create({\n someConfig: true\n});\n
\n\nAll parameters are passed to the constructor of the class.
\nthe created instance.
\nCreate aliases for existing prototype methods. Example:
\n\nExt.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
\nThe new method name, or an object to set multiple aliases. See\nflexSetter
\nThe original method name
\nGet the current class' name in string format.
\n\nExt.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
\nclassName
\nAdd methods / properties to the prototype of this class.
\n\nExt.define('My.awesome.Cat', {\n constructor: function() {\n ...\n }\n});\n\n My.awesome.Cat.implement({\n meow: function() {\n alert('Meowww...');\n }\n });\n\n var kitty = new My.awesome.Cat;\n kitty.meow();\n
\nOverride prototype members of this class. Overridden methods can be invoked via\ncallOverridden
\n\nExt.define('My.Cat', {\n constructor: function() {\n alert(\"I'm a cat!\");\n\n return this;\n }\n});\n\nMy.Cat.override({\n constructor: function() {\n alert(\"I'm going to be a cat!\");\n\n var instance = this.callOverridden();\n\n alert(\"Meeeeoooowwww\");\n\n return instance;\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
\nthis
\nThis event is fired through the GridView. Add listeners to the GridView object
\n\nFired when a drop gesture has been triggered by a mouseup event in a valid drop position in the GridView.
\nThe GridView node if any over which the mouse was positioned.
\n\nReturning false
to this event signals that the drop gesture was invalid, and if the drag proxy will animate\nback to the point from which the drag began.
Returning 0
To this event signals that the data transfer operation should not take place, but that the gesture\nwas valid, and that the repair operation should not take place.
Any other return value continues with the data transfer operation.
\nThe data object gathered at mousedown time by the cooperating DragZone's getDragData method it contains the following properties:
\n\ncopy : Boolean
\n\nThe value of the GridView's copy
property, or true
if the GridView was configured with allowCopy: true
and\nthe control key was pressed when the drag operation was begun
view : GridView
\n\nThe source GridView from which the drag originated.
ddel : HtmlElement
\n\nThe drag proxy element which moves with the mouse
item : HtmlElement
\n\nThe GridView node upon which the mousedown event was registered.
records : Array
\n\nAn Array of Models representing the selected data being dragged from the source GridView.
The Model over which the drop gesture took place.
\n\"before\"
or \"after\"
depending on whether the mouse is above or below the midline\nof the node.
A function to call to complete the data transfer operation and either move or copy Model instances from the\nsource View's Store to the destination View's Store.
\n\nThis is useful when you want to perform some kind of asynchronous processing before confirming the drop, such as\nan confirm call, or an Ajax request.
\n\nReturn 0
from this event handler, and call the dropFunction
at any time to perform the data transfer.
The options object passed to Ext.util.Observable.addListener.
\n\n\n\nThis event is fired through the GridView. Add listeners to the GridView object Fired when a drop operation\nhas been completed and the data has been moved or copied.
\nThe GridView node if any over which the mouse was positioned.
\nThe data object gathered at mousedown time by the cooperating DragZone's getDragData method it contains the following properties:
\n\ncopy : Boolean
\n\nThe value of the GridView's copy
property, or true
if the GridView was configured with allowCopy: true
and\nthe control key was pressed when the drag operation was begun
view : GridView
\n\nThe source GridView from which the drag originated.
ddel : HtmlElement
\n\nThe drag proxy element which moves with the mouse
item : HtmlElement
\n\nThe GridView node upon which the mousedown event was registered.
records : Array
\n\nAn Array of Models representing the selected data being dragged from the source GridView.
The Model over which the drop gesture took place.
\n\"before\"
or \"after\"
depending on whether the mouse is above or below the midline\nof the node.
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n