X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/6746dc89c47ed01b165cc1152533605f97eb8e8d..f562e4c6e5fac7bcb445985b99acbea4d706e6f0:/docs/output/Ext.tree.plugin.TreeViewDragDrop.js diff --git a/docs/output/Ext.tree.plugin.TreeViewDragDrop.js b/docs/output/Ext.tree.plugin.TreeViewDragDrop.js new file mode 100644 index 00000000..aaab9ffc --- /dev/null +++ b/docs/output/Ext.tree.plugin.TreeViewDragDrop.js @@ -0,0 +1 @@ +Ext.data.JsonP.Ext_tree_plugin_TreeViewDragDrop({"tagname":"class","html":"

Hierarchy

Ext.Base
Ext.AbstractPlugin
Ext.tree.plugin.TreeViewDragDrop

Uses

Files

This plugin provides drag and/or drop functionality for a TreeView.

\n\n

It creates a specialized instance of DragZone which knows how to drag out of a\nTreeView and loads the data object which is passed to a cooperating\nDragZone's methods with the following properties:

\n\n\n\n\n

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\n

Adding this plugin to a view means that two new events may be fired from the client TreeView, beforedrop and\ndrop.

\n\n

Note that the plugin must be added to the tree view, not to the tree panel. For example using viewConfig:

\n\n
viewConfig: {\n    plugins: { ptype: 'treeviewdragdrop' }\n}\n
\n
Defined By

Config options

 

True if drops on the tree container (outside of a specific tree node) are allowed.

\n

True if drops on the tree container (outside of a specific tree node) are allowed.

\n
Allow inserting a dragged node between an expanded parent node and its first child that will become a sibling of\nthe ...

Allow inserting a dragged node between an expanded parent node and its first child that will become a sibling of\nthe parent when dropped.

\n
True if the tree should only allow append drops (use for trees which are sorted). ...

True if the tree should only allow append drops (use for trees which are sorted).

\n

Defaults to: false

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 both the DragZones and\nDropZone used by this plugin will only interact with other drag drop objects in the same group.

\n

Defaults to: "TreeDD"

The ddGroup to which the DragZone will belong. ...

The ddGroup to which the DragZone will belong.

\n\n

This defines which other DropZones the DragZone will interact with. Drag/DropZones only interact with other\nDrag/DropZones which are members of the same ddGroup.

\n
The ddGroup to which the DropZone will belong. ...

The ddGroup to which the DropZone will belong.

\n\n

This defines which other DragZones the DropZone will interact with. Drag/DropZones only interact with other\nDrag/DropZones which are members of the same ddGroup.

\n
Set to false to disallow dragging items from the View. ...

Set to false to disallow dragging items from the View.

\n

Defaults to: true

Set to false to disallow the View from accepting drop gestures. ...

Set to false to disallow the View from accepting drop gestures.

\n

Defaults to: true

The delay in milliseconds to wait before expanding a target tree node while dragging a droppable node over the\ntarget. ...

The delay in milliseconds to wait before expanding a target tree node while dragging a droppable node over the\ntarget.

\n

Defaults to: 1000

The color to use when visually highlighting the dragged or dropped node (default value is light blue). ...

The color to use when visually highlighting the dragged or dropped node (default value is light blue).\nThe color must be a 6 digit hex value, without a preceding '#'. See also nodeHighlightOnDrop and\nnodeHighlightOnRepair.

\n

Defaults to: "c3daf9"

Whether or not to highlight any nodes after they are\nsuccessfully dropped on their target. ...

Whether or not to highlight any nodes after they are\nsuccessfully dropped on their target. Defaults to the value of Ext.enableFx.\nSee also nodeHighlightColor and nodeHighlightOnRepair.

\n
Whether or not to highlight any nodes after they are\nrepaired from an unsuccessful drag/drop. ...

Whether or not to highlight any nodes after they are\nrepaired from an unsuccessful drag/drop. Defaults to the value of Ext.enableFx.\nSee also nodeHighlightColor and nodeHighlightOnDrop.

\n
Defined By

Properties

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        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
\n

Methods

Defined By

Instance Methods

( Array/Arguments args ) : Objectprotected
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        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
\n

Parameters

  • args : Array/Arguments

    The arguments, either an array or the arguments object

    \n

Returns

  • Object

    Returns the result after calling the overridden method

    \n
( Array/Arguments args ) : Objectprotected
Call the parent's overridden method. ...

Call the parent's overridden method. For example:

\n\n
Ext.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
\n

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 from the superclass' method

    \n
The destroy method is invoked by the owning Component at the time the Component is being destroyed. ...

The destroy method is invoked by the owning Component at the time the Component is being destroyed.

\n\n

The supplied implementation is empty. Subclasses should perform plugin cleanup in their own implementation of\nthis method.

\n
The base implementation just sets the plugin's disabled flag to true\n\nPlugin subclasses which need more complex proce...

The base implementation just sets the plugin's disabled flag to true

\n\n

Plugin subclasses which need more complex processing may implement an overriding implementation.

\n
The base implementation just sets the plugin's disabled flag to false\n\nPlugin subclasses which need more complex proc...

The base implementation just sets the plugin's disabled flag to false

\n\n

Plugin subclasses which need more complex processing may implement an overriding implementation.

\n
The init method is invoked after initComponent method has been run for the client Component. ...

The init method is invoked after initComponent method has been run for the client Component.

\n\n

The 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

Parameters

  • client : Ext.Component

    The client Component which owns this plugin.

    \n
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        return this;\n    }\n});\n\nvar awesome = new My.awesome.Class({\n    name: 'Super Awesome'\n});\n\nalert(awesome.getName()); // 'Super Awesome'\n
\n

Parameters

Returns

  • Object

    mixins The mixin prototypes as key - value pairs

    \n
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        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
\n

Returns

Defined By

Static Methods

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
\n

Parameters

Returns

( Ext.Base fromClass, String/String[] members ) : Ext.Basestatic
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
\n

Parameters

  • fromClass : Ext.Base

    The class to borrow members from

    \n
  • members : String/String[]

    The names of the members to borrow

    \n

Returns

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.

\n

Returns

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
\n

Parameters

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
\n

Returns

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.implement({\n     meow: function() {\n        alert('Meowww...');\n     }\n });\n\n var kitty = new My.awesome.Cat;\n kitty.meow();\n
\n

Parameters

Override prototype members of this class. ...

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

\n\n
Ext.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
\n

Parameters

Returns

Defined By

Events

( HTMLElement node, Object data, Ext.data.Model overModel, String dropPosition, Function dropFunction, Object eOpts )
This event is fired through the TreeView. ...

This event is fired through the TreeView. Add listeners to the TreeView object

\n\n

Fired when a drop gesture has been triggered by a mouseup event in a valid drop position in the TreeView.

\n

Parameters

  • node : HTMLElement

    The TreeView node if any over which the mouse was positioned.

    \n\n

    Returning 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.

    \n\n

    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.

    \n\n

    Any other return value continues with the data transfer operation.

    \n
  • data : Object

    The data object gathered at mousedown time by the cooperating\nDragZone's getDragData method it contains the following\nproperties:

    \n
    • copy : Boolean

      The value of the TreeView's copy property, or true if the TreeView was configured with\nallowCopy: true and the control key was pressed when the drag operation was begun

      \n
    • view : Ext.tree.View

      The source TreeView from which the drag originated.

      \n
    • ddel : HTMLElement

      The drag proxy element which moves with the mouse

      \n
    • item : HTMLElement

      The TreeView node upon which the mousedown event was registered.

      \n
    • records : Ext.data.Model[]

      An Array of Models representing the selected data being\ndragged from the source TreeView.

      \n
  • overModel : Ext.data.Model

    The Model over which the drop gesture took place.

    \n
  • dropPosition : String

    \"before\", \"after\" or \"append\" depending on whether the mouse is above or below\nthe midline of the node, or the node is a branch node which accepts new child nodes.

    \n
  • dropFunction : Function

    A function to call to complete the data transfer operation and either move or copy\nModel instances from the source View's Store to the destination View's Store.

    \n\n

    This 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\n

    Return 0 from this event handler, and call the dropFunction at any time to perform the data transfer.

    \n
  • eOpts : Object

    The options object passed to Ext.util.Observable.addListener.

    \n\n\n\n
( HTMLElement node, Object data, Ext.data.Model overModel, String dropPosition, Object eOpts )
This event is fired through the TreeView. ...

This event is fired through the TreeView. Add listeners to the TreeView object Fired when a drop operation\nhas been completed and the data has been moved or copied.

\n

Parameters

  • node : HTMLElement

    The TreeView node if any over which the mouse was positioned.

    \n
  • data : Object

    The data object gathered at mousedown time by the cooperating\nDragZone's getDragData method it contains the following\nproperties:

    \n
    • copy : Boolean

      The value of the TreeView's copy property, or true if the TreeView was configured with\nallowCopy: true and the control key was pressed when the drag operation was begun

      \n
    • view : Ext.tree.View

      The source TreeView from which the drag originated.

      \n
    • ddel : HTMLElement

      The drag proxy element which moves with the mouse

      \n
    • item : HTMLElement

      The TreeView node upon which the mousedown event was registered.

      \n
    • records : Ext.data.Model[]

      An Array of Models representing the selected data being\ndragged from the source TreeView.

      \n
  • overModel : Ext.data.Model

    The Model over which the drop gesture took place.

    \n
  • dropPosition : String

    \"before\", \"after\" or \"append\" depending on whether the mouse is above or below\nthe midline of the node, or the node is a branch node which accepts new child nodes.

    \n
  • eOpts : Object

    The options object passed to Ext.util.Observable.addListener.

    \n\n\n\n
","allMixins":[],"meta":{},"requires":[],"deprecated":null,"extends":"Ext.AbstractPlugin","inheritable":false,"static":false,"superclasses":["Ext.Base","Ext.AbstractPlugin","Ext.tree.plugin.TreeViewDragDrop"],"singleton":false,"code_type":"ext_define","alias":null,"statics":{"property":[],"css_var":[],"css_mixin":[],"cfg":[],"method":[{"tagname":"method","deprecated":null,"static":true,"owner":"Ext.Base","template":false,"required":null,"protected":false,"name":"addStatics","id":"static-method-addStatics"},{"tagname":"method","deprecated":null,"static":true,"owner":"Ext.Base","template":false,"required":null,"protected":false,"name":"borrow","id":"static-method-borrow"},{"tagname":"method","deprecated":null,"static":true,"owner":"Ext.Base","template":false,"required":null,"protected":false,"name":"create","id":"static-method-create"},{"tagname":"method","deprecated":null,"static":true,"owner":"Ext.Base","template":false,"required":null,"protected":false,"name":"createAlias","id":"static-method-createAlias"},{"tagname":"method","deprecated":null,"static":true,"owner":"Ext.Base","template":false,"required":null,"protected":false,"name":"getName","id":"static-method-getName"},{"tagname":"method","deprecated":null,"static":true,"owner":"Ext.Base","template":false,"required":null,"protected":false,"name":"implement","id":"static-method-implement"},{"tagname":"method","deprecated":null,"static":true,"owner":"Ext.Base","template":false,"required":null,"protected":false,"name":"override","id":"static-method-override"}],"event":[]},"subclasses":[],"uses":["Ext.tree.ViewDragZone","Ext.tree.ViewDropZone"],"protected":false,"mixins":[],"members":{"property":[{"tagname":"property","deprecated":null,"static":false,"owner":"Ext.Base","template":null,"required":null,"protected":true,"name":"self","id":"property-self"}],"css_var":[],"css_mixin":[],"cfg":[{"tagname":"cfg","deprecated":null,"static":false,"owner":"Ext.tree.plugin.TreeViewDragDrop","template":null,"required":false,"protected":false,"name":"allowContainerDrop","id":"cfg-allowContainerDrop"},{"tagname":"cfg","deprecated":null,"static":false,"owner":"Ext.tree.plugin.TreeViewDragDrop","template":null,"required":false,"protected":false,"name":"allowParentInsert","id":"cfg-allowParentInsert"},{"tagname":"cfg","deprecated":null,"static":false,"owner":"Ext.tree.plugin.TreeViewDragDrop","template":null,"required":false,"protected":false,"name":"appendOnly","id":"cfg-appendOnly"},{"tagname":"cfg","deprecated":null,"static":false,"owner":"Ext.tree.plugin.TreeViewDragDrop","template":null,"required":false,"protected":false,"name":"ddGroup","id":"cfg-ddGroup"},{"tagname":"cfg","deprecated":null,"static":false,"owner":"Ext.tree.plugin.TreeViewDragDrop","template":null,"required":false,"protected":false,"name":"dragGroup","id":"cfg-dragGroup"},{"tagname":"cfg","deprecated":null,"static":false,"owner":"Ext.tree.plugin.TreeViewDragDrop","template":null,"required":false,"protected":false,"name":"dropGroup","id":"cfg-dropGroup"},{"tagname":"cfg","deprecated":null,"static":false,"owner":"Ext.tree.plugin.TreeViewDragDrop","template":null,"required":false,"protected":false,"name":"enableDrag","id":"cfg-enableDrag"},{"tagname":"cfg","deprecated":null,"static":false,"owner":"Ext.tree.plugin.TreeViewDragDrop","template":null,"required":false,"protected":false,"name":"enableDrop","id":"cfg-enableDrop"},{"tagname":"cfg","deprecated":null,"static":false,"owner":"Ext.tree.plugin.TreeViewDragDrop","template":null,"required":false,"protected":false,"name":"expandDelay","id":"cfg-expandDelay"},{"tagname":"cfg","deprecated":null,"static":false,"owner":"Ext.tree.plugin.TreeViewDragDrop","template":null,"required":false,"protected":false,"name":"nodeHighlightColor","id":"cfg-nodeHighlightColor"},{"tagname":"cfg","deprecated":null,"static":false,"owner":"Ext.tree.plugin.TreeViewDragDrop","template":null,"required":false,"protected":false,"name":"nodeHighlightOnDrop","id":"cfg-nodeHighlightOnDrop"},{"tagname":"cfg","deprecated":null,"static":false,"owner":"Ext.tree.plugin.TreeViewDragDrop","template":null,"required":false,"protected":false,"name":"nodeHighlightOnRepair","id":"cfg-nodeHighlightOnRepair"}],"method":[{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Base","template":false,"required":null,"protected":true,"name":"callOverridden","id":"method-callOverridden"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Base","template":false,"required":null,"protected":true,"name":"callParent","id":"method-callParent"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.AbstractPlugin","template":false,"required":null,"protected":false,"name":"destroy","id":"method-destroy"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.AbstractPlugin","template":false,"required":null,"protected":false,"name":"disable","id":"method-disable"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.AbstractPlugin","template":false,"required":null,"protected":false,"name":"enable","id":"method-enable"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.AbstractPlugin","template":false,"required":null,"protected":false,"name":"init","id":"method-init"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Base","template":false,"required":null,"protected":true,"name":"initConfig","id":"method-initConfig"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Base","template":false,"required":null,"protected":true,"name":"statics","id":"method-statics"}],"event":[{"tagname":"event","deprecated":null,"static":false,"owner":"Ext.tree.plugin.TreeViewDragDrop","template":null,"required":null,"protected":false,"name":"beforedrop","id":"event-beforedrop"},{"tagname":"event","deprecated":null,"static":false,"owner":"Ext.tree.plugin.TreeViewDragDrop","template":null,"required":null,"protected":false,"name":"drop","id":"event-drop"}]},"private":false,"component":false,"name":"Ext.tree.plugin.TreeViewDragDrop","alternateClassNames":[],"id":"class-Ext.tree.plugin.TreeViewDragDrop","mixedInto":[],"xtypes":{"plugin":["treeviewdragdrop"]},"files":[{"href":"TreeViewDragDrop.html#Ext-tree-plugin-TreeViewDragDrop","filename":"TreeViewDragDrop.js"}]}); \ No newline at end of file