X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/6746dc89c47ed01b165cc1152533605f97eb8e8d..f562e4c6e5fac7bcb445985b99acbea4d706e6f0:/docs/output/Ext.view.DropZone.js diff --git a/docs/output/Ext.view.DropZone.js b/docs/output/Ext.view.DropZone.js new file mode 100644 index 00000000..4ecec665 --- /dev/null +++ b/docs/output/Ext.view.DropZone.js @@ -0,0 +1 @@ +Ext.data.JsonP.Ext_view_DropZone({"tagname":"class","html":"
Hierarchy
Files
NOTE This is a private utility class for internal use by the framework. Don't rely on its existence.
\nA 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.
\nThe CSS class returned to the drag source when drop is allowed.
\nDefaults to: "x-dd-drop-ok"
The available property is false until the linked dom element is accessible.
\nThe available property is false until the linked dom element is accessible.
\nConfiguration attributes passed into the constructor
\nConfiguration attributes passed into the constructor
\nProvides default constraint padding to \"constrainTo\" elements.
\nProvides default constraint padding to \"constrainTo\" elements.
\nThe 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. An object in the format {'group1':true, 'group2':true}
\nBy 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.
\nThe 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.
\nSet 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.
\nAn Array of CSS class names for elements to be considered in valid as drag handles.
\nAn Array of CSS class names for elements to be considered in valid as drag handles.
\nAn 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\nAn 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\nBy default, all instances can be a drop target. This can be disabled by\nsetting isTarget to false.
\nMaintain 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
\nWhen 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.
\nThe 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]
\nBy 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
\nGet 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
\nCreates new DropTarget.
\nThe container element or ID of it.
\nLets you specify a css class of elements that will not initiate a drag
\nthe class of the elements you wish to ignore
\nLets you to specify an element id for a child of a drag handle\nthat should not initiate a drag
\nthe element id of the element you wish to ignore
\nAllows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.
\nthe type of element to exclude
\nAdds 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.
\nthe name of the group
\nApplies 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.
\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
\nClears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time.
\nClears any tick interval defined for this instance
\nInitializes the drag drop object's constraints to restrict movement to a certain element.
\n\nUsage:
\n\nvar dd = new Ext.dd.DDProxy(\"dragDiv1\", \"proxytest\",\n { dragElId: \"existingProxyDiv\" });\ndd.startDrag = function(){\n this.constrainTo(\"parent-id\");\n};\n
\n\nOr you can initalize it using the Ext.Element object:
\n\nExt.get(\"dragDiv1\").initDDProxy(\"proxytest\", {dragElId: \"existingProxyDiv\"}, {\n startDrag : function(){\n this.constrainTo(\"parent-id\");\n }\n});\n
\nThe element or element ID to constrain to.
\nPad 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}
Constrain the draggable in the content box of the element (inside padding and borders)
\nCalled when we are done dragging the object
\nthe mouseup event
\nReturns a reference to the actual element to drag. By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Ext.dd.DDProxy
\nthe html element
\nReturns a reference to the linked element
\nthe html element
\nReturns 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.
\nThe event
\ndata The custom data
\nSets up the DragDrop object. Must be called in the constructor of any\nExt.dd.DragDrop subclass
\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
\nReturns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)
\ntrue if this obj or all drag/drop is locked, else\nfalse
\nChecks the tag exclusion list to see if this click should be ignored
\nthe HTMLElement to evaluate
\ntrue if this is a valid tag type, false if not
\nThe 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.
\nThe drag source that was dragged over this drop zone
\nThe event
\nAn object containing arbitrary data supplied by the drag source
\nFalse if the drop was invalid.
\nThe 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.
\nThe drag source that was dragged over this drop zone
\nThe event
\nAn object containing arbitrary data supplied by the drag source
\nstatus The CSS class that communicates the drop status back to the source so that the\nunderlying Ext.dd.StatusProxy can be updated
\nThe 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.
\nThe drag source that was dragged over this drop target
\nThe event
\nAn object containing arbitrary data supplied by the drag zone
\nThe 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.
\nThe drag source that was dragged over this drop zone
\nThe event
\nAn object containing arbitrary data supplied by the drag source
\nstatus The CSS class that communicates the drop status back to the source so that the\nunderlying Ext.dd.StatusProxy can be updated
\nOverride the onAvailable method to do what is needed after the initial\nposition was determined.
\nCalled 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.
\nThe drag source that was dragged over this drop zone
\nThe event
\nAn object containing arbitrary data supplied by the drag source
\nTrue if the drop was valid, else false
\nCalled 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.
\nThe drag source that was dragged over this drop zone
\nThe event
\nAn object containing arbitrary data supplied by the drag source
\nstatus The CSS class that communicates the drop status back to the source so that the\nunderlying Ext.dd.StatusProxy can be updated
\nAbstract method called during the onMouseMove event while dragging an\nobject.
\nthe mousemove event
\nAbstract method called when this item is dropped on another DragDrop\nobj
\nthe mouseup event
\nIn POINT mode, the element\nid this was dropped on. In INTERSECT mode, an array of dd items this\nwas dropped on.
\nAbstract method called when this element fist begins hovering over\nanother DragDrop obj
\nthe mousemove event
\nIn POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of one or more\ndragdrop items being hovered over.
\nAbstract method called when we are no longer hovering over an element
\nthe mousemove event
\nIn POINT mode, the element\nid this was hovering over. In INTERSECT mode, an array of dd items\nthat the mouse is no longer over.
\nAbstract method called when this element is hovering over another\nDragDrop obj
\nthe mousemove event
\nIn POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of dd items\nbeing hovered over.
\nAbstract method called when this item is dropped on an area with no\ndrop target
\nthe mouseup event
\nCalled when a drag/drop obj gets a mousedown
\nthe mousedown event
\nCalled when a drag/drop obj gets a mouseup
\nthe mouseup event
\nCalled 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.
\nThe custom data associated with the drop node (this is the same value returned from\ngetTargetFromEvent for this node)
\nThe drag source that was dragged over this drop zone
\nThe event
\nAn object containing arbitrary data supplied by the drag source
\nTrue if the drop was valid, else false
\nCalled 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.
\nThe custom data associated with the drop node (this is the same value returned from\ngetTargetFromEvent for this node)
\nThe drag source that was dragged over this drop zone
\nThe event
\nAn object containing arbitrary data supplied by the drag source
\nCalled 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.
\nThe custom data associated with the drop node (this is the same value returned from\ngetTargetFromEvent for this node)
\nThe drag source that was dragged over this drop zone
\nThe event
\nAn object containing arbitrary data supplied by the drag source
\nCalled 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.dropNotAllowed, so it should be\noverridden to provide the proper feedback.
\nThe custom data associated with the drop node (this is the same value returned from\ngetTargetFromEvent for this node)
\nThe drag source that was dragged over this drop zone
\nThe event
\nAn object containing arbitrary data supplied by the drag source
\nstatus The CSS class that communicates the drop status back to the source so that the\nunderlying Ext.dd.StatusProxy can be updated
\nRemoves this instance from the supplied interaction group
\nThe group to drop
\nUnsets an invalid css class
\nthe class of the element(s) you wish to\nre-enable
\nUnsets an excluded tag name set by addInvalidHandleType
\nthe type of element to unexclude
\nAllows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag
\nthe id of the element that will be used to initiate the drag
\nAllows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.
\nthe id of the element that will be used to\ninitiate the drag.
\nAllows you to set an element outside of the linked element as a drag\nhandle
\nthe id of the element that will be used to initiate the drag
\nConfigures 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.
\nBy default, the element can be dragged any place on the screen. Use\nthis method to limit the horizontal travel of the element. Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.
\nBy default, the element can be dragged any place on the screen. Set\nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.
\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
\nRemoves all drag and drop hooks for this element
\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
\n