X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/3789b528d8dd8aad4558e38e22d775bcab1cbd36..HEAD:/docs/output/Ext.dd.StatusProxy.js diff --git a/docs/output/Ext.dd.StatusProxy.js b/docs/output/Ext.dd.StatusProxy.js index d8ad0bf4..62e2c7ac 100644 --- a/docs/output/Ext.dd.StatusProxy.js +++ b/docs/output/Ext.dd.StatusProxy.js @@ -1,336 +1 @@ -Ext.data.JsonP.Ext_dd_StatusProxy({ - "tagname": "class", - "name": "Ext.dd.StatusProxy", - "doc": "
A specialized drag proxy that supports a drop status icon, Ext.Layer styles and auto-repair. This is the\ndefault drag proxy used by all Ext.dd components.
\n", - "extends": null, - "mixins": [ - - ], - "alternateClassNames": [ - - ], - "xtype": null, - "author": null, - "docauthor": null, - "singleton": false, - "private": false, - "cfg": [ - { - "tagname": "cfg", - "name": "dropAllowed", - "member": "Ext.dd.StatusProxy", - "type": "String", - "doc": "The CSS class to apply to the status element when drop is allowed (defaults to \"x-dd-drop-ok\").
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/StatusProxy.js", - "linenr": 32, - "html_filename": "StatusProxy.html", - "href": "StatusProxy.html#Ext-dd-StatusProxy-cfg-dropAllowed" - }, - { - "tagname": "cfg", - "name": "dropNotAllowed", - "member": "Ext.dd.StatusProxy", - "type": "String", - "doc": "The CSS class to apply to the status element when drop is not allowed (defaults to \"x-dd-drop-nodrop\").
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/StatusProxy.js", - "linenr": 37, - "html_filename": "StatusProxy.html", - "href": "StatusProxy.html#Ext-dd-StatusProxy-cfg-dropNotAllowed" - } - ], - "method": [ - { - "tagname": "method", - "name": "StatusProxy", - "member": "Ext.dd.StatusProxy", - "doc": "\n", - "params": [ - { - "type": "Object", - "name": "config", - "doc": "\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/StatusProxy.js", - "linenr": 1, - "html_filename": "StatusProxy.html", - "href": "StatusProxy.html#Ext-dd-StatusProxy-method-constructor", - "shortDoc": "\n" - }, - { - "tagname": "method", - "name": "getEl", - "member": "Ext.dd.StatusProxy", - "doc": "Returns the underlying proxy Ext.Layer
\n", - "params": [ - - ], - "return": { - "type": "Ext.Layer", - "doc": "el
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/StatusProxy.js", - "linenr": 87, - "html_filename": "StatusProxy.html", - "href": "StatusProxy.html#Ext-dd-StatusProxy-method-getEl", - "shortDoc": "Returns the underlying proxy Ext.Layer
\n" - }, - { - "tagname": "method", - "name": "getGhost", - "member": "Ext.dd.StatusProxy", - "doc": "Returns the ghost element
\n", - "params": [ - - ], - "return": { - "type": "Ext.core.Element", - "doc": "el
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/StatusProxy.js", - "linenr": 95, - "html_filename": "StatusProxy.html", - "href": "StatusProxy.html#Ext-dd-StatusProxy-method-getGhost", - "shortDoc": "Returns the ghost element
\n" - }, - { - "tagname": "method", - "name": "hide", - "member": "Ext.dd.StatusProxy", - "doc": "Hides the proxy
\n", - "params": [ - { - "type": "Boolean", - "name": "clear", - "doc": "True to reset the status and clear the ghost contents, false to preserve them
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/StatusProxy.js", - "linenr": 103, - "html_filename": "StatusProxy.html", - "href": "StatusProxy.html#Ext-dd-StatusProxy-method-hide", - "shortDoc": "Hides the proxy
\n" - }, - { - "tagname": "method", - "name": "repair", - "member": "Ext.dd.StatusProxy", - "doc": "Causes the proxy to return to its position of origin via an animation. Should be called after an\ninvalid drop operation by the item being dragged.
\n", - "params": [ - { - "type": "Array", - "name": "xy", - "doc": "The XY position of the element ([x, y])
\n", - "optional": false - }, - { - "type": "Function", - "name": "callback", - "doc": "The function to call after the repair is complete.
\n", - "optional": false - }, - { - "type": "Object", - "name": "scope", - "doc": "The scope (this
reference) in which the callback function is executed. Defaults to the browser window.
Resets the status indicator to the default dropNotAllowed value
\n", - "params": [ - { - "type": "Boolean", - "name": "clearGhost", - "doc": "True to also remove all content from the ghost, false to preserve it
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/StatusProxy.js", - "linenr": 56, - "html_filename": "StatusProxy.html", - "href": "StatusProxy.html#Ext-dd-StatusProxy-method-reset", - "shortDoc": "Resets the status indicator to the default dropNotAllowed value
\n" - }, - { - "tagname": "method", - "name": "setStatus", - "member": "Ext.dd.StatusProxy", - "doc": "Updates the proxy's visual element to indicate the status of whether or not drop is allowed\nover the current target element.
\n", - "params": [ - { - "type": "String", - "name": "cssClass", - "doc": "The css class for the new drop status indicator image
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/StatusProxy.js", - "linenr": 43, - "html_filename": "StatusProxy.html", - "href": "StatusProxy.html#Ext-dd-StatusProxy-method-setStatus", - "shortDoc": "Updates the proxy's visual element to indicate the status of whether or not drop is allowed\nover the current target e..." - }, - { - "tagname": "method", - "name": "show", - "member": "Ext.dd.StatusProxy", - "doc": "Displays this proxy
\n", - "params": [ - - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/StatusProxy.js", - "linenr": 123, - "html_filename": "StatusProxy.html", - "href": "StatusProxy.html#Ext-dd-StatusProxy-method-show", - "shortDoc": "Displays this proxy
\n" - }, - { - "tagname": "method", - "name": "stop", - "member": "Ext.dd.StatusProxy", - "doc": "Stops the repair animation if it's currently running
\n", - "params": [ - - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/StatusProxy.js", - "linenr": 114, - "html_filename": "StatusProxy.html", - "href": "StatusProxy.html#Ext-dd-StatusProxy-method-stop", - "shortDoc": "Stops the repair animation if it's currently running
\n" - }, - { - "tagname": "method", - "name": "sync", - "member": "Ext.dd.StatusProxy", - "doc": "Force the Layer to sync its shadow and shim positions to the element
\n", - "params": [ - - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/StatusProxy.js", - "linenr": 131, - "html_filename": "StatusProxy.html", - "href": "StatusProxy.html#Ext-dd-StatusProxy-method-sync", - "shortDoc": "Force the Layer to sync its shadow and shim positions to the element
\n" - }, - { - "tagname": "method", - "name": "update", - "member": "Ext.dd.StatusProxy", - "doc": "Updates the contents of the ghost element
\n", - "params": [ - { - "type": "String/HTMLElement", - "name": "html", - "doc": "The html that will replace the current innerHTML of the ghost element, or a\nDOM node to append as the child of the ghost element (in which case the innerHTML will be cleared first).
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/StatusProxy.js", - "linenr": 68, - "html_filename": "StatusProxy.html", - "href": "StatusProxy.html#Ext-dd-StatusProxy-method-update", - "shortDoc": "Updates the contents of the ghost element
\n" - } - ], - "property": [ - - ], - "event": [ - - ], - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/StatusProxy.js", - "linenr": 1, - "html_filename": "StatusProxy.html", - "href": "StatusProxy.html#Ext-dd-StatusProxy", - "cssVar": [ - - ], - "cssMixin": [ - - ], - "component": false, - "superclasses": [ - - ], - "subclasses": [ - - ], - "mixedInto": [ - - ], - "allMixins": [ - - ] -}); \ No newline at end of file +Ext.data.JsonP.Ext_dd_StatusProxy({"tagname":"class","html":"Hierarchy
Ext.BaseExt.dd.StatusProxyFiles
A specialized drag proxy that supports a drop status icon, Ext.Layer styles and auto-repair. This is the\ndefault drag proxy used by all Ext.dd components.
\nThe CSS class to apply to the status element when drop is allowed.
\nDefaults to: "x-dd-drop-ok"
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
\nHides the proxy
\nTrue to reset the status and clear the ghost contents, false to preserve them
\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
\nCauses the proxy to return to its position of origin via an animation. Should be called after an\ninvalid drop operation by the item being dragged.
\nResets the status indicator to the default dropNotAllowed value
\nTrue to also remove all content from the ghost, false to preserve it
\nUpdates the proxy's visual element to indicate the status of whether or not drop is allowed\nover the current target element.
\nThe css class for the new drop status indicator image
\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
\nStops the repair animation if it's currently running
\nForce the Layer to sync its shadow and shim positions to the element
\nUpdates the contents of the ghost element
\nThe html that will replace the current innerHTML of the ghost element, or a\nDOM node to append as the child of the ghost element (in which case the innerHTML will be cleared first).
\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