X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/3789b528d8dd8aad4558e38e22d775bcab1cbd36..refs/heads/master:/docs/output/Ext.layout.component.Dock.js?ds=inline diff --git a/docs/output/Ext.layout.component.Dock.js b/docs/output/Ext.layout.component.Dock.js index 790e44cf..07b054b6 100644 --- a/docs/output/Ext.layout.component.Dock.js +++ b/docs/output/Ext.layout.component.Dock.js @@ -1,192 +1 @@ -Ext.data.JsonP.Ext_layout_component_Dock({ - "tagname": "class", - "name": "Ext.layout.component.Dock", - "doc": "\n", - "extends": "Ext.layout.component.AbstractDock", - "mixins": [ - - ], - "alternateClassNames": [ - - ], - "xtype": null, - "author": null, - "docauthor": null, - "singleton": false, - "private": true, - "cfg": [ - - ], - "method": [ - { - "tagname": "method", - "name": "getRenderTarget", - "member": "Ext.layout.component.Component", - "doc": "
Returns the element into which rendering must take place. Defaults to the owner Component's encapsulating element.
\n\n\nMay be overridden in Component layout managers which implement an inner element.
\n", - "params": [ - - ], - "return": { - "type": "Ext.core.Element", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/layout/component/Component.js", - "linenr": 129, - "html_filename": "Component5.html", - "href": "Component5.html#Ext-layout-component-Component-method-getRenderTarget", - "shortDoc": "Returns the element into which rendering must take place. Defaults to the owner Component's encapsulating element.\n\n\n..." - }, - { - "tagname": "method", - "name": "getTarget", - "member": "Ext.layout.component.Component", - "doc": "Returns the owner component's resize element.
\n", - "params": [ - - ], - "return": { - "type": "Ext.core.Element", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/layout/component/Component.js", - "linenr": 121, - "html_filename": "Component5.html", - "href": "Component5.html#Ext-layout-component-Component-method-getTarget", - "shortDoc": "Returns the owner component's resize element.
\n" - }, - { - "tagname": "method", - "name": "needsLayout", - "member": "Ext.layout.component.Component", - "doc": "Check if the new size is different from the current size and only\ntrigger a layout if it is necessary.
\n", - "params": [ - { - "type": "Mixed", - "name": "width", - "doc": "The new width to set.
\n", - "optional": false - }, - { - "type": "Mixed", - "name": "height", - "doc": "The new height to set.
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/layout/component/Component.js", - "linenr": 90, - "html_filename": "Component5.html", - "href": "Component5.html#Ext-layout-component-Component-method-needsLayout", - "shortDoc": "Check if the new size is different from the current size and only\ntrigger a layout if it is necessary.
\n" - }, - { - "tagname": "method", - "name": "setElementSize", - "member": "Ext.layout.component.Component", - "doc": "Set the size of any element supporting undefined, null, and values.
\n", - "params": [ - { - "type": "Mixed", - "name": "width", - "doc": "The new width to set.
\n", - "optional": false - }, - { - "type": "Mixed", - "name": "height", - "doc": "The new height to set.
\n", - "optional": false - }, - { - "type": "Object", - "name": "height", - "doc": "\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/layout/component/Component.js", - "linenr": 104, - "html_filename": "Component5.html", - "href": "Component5.html#Ext-layout-component-Component-method-setElementSize", - "shortDoc": "Set the size of any element supporting undefined, null, and values.
\n" - }, - { - "tagname": "method", - "name": "setTargetSize", - "member": "Ext.layout.component.Component", - "doc": "Set the size of the target element.
\n", - "params": [ - { - "type": "Mixed", - "name": "width", - "doc": "The new width to set.
\n", - "optional": false - }, - { - "type": "Mixed", - "name": "height", - "doc": "The new height to set.
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/layout/component/Component.js", - "linenr": 138, - "html_filename": "Component5.html", - "href": "Component5.html#Ext-layout-component-Component-method-setTargetSize", - "shortDoc": "Set the size of the target element.
\n" - } - ], - "property": [ - - ], - "event": [ - - ], - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/component/Dock.js", - "linenr": 1, - "html_filename": "Dock.html", - "href": "Dock.html#Ext-layout-component-Dock", - "cssVar": [ - - ], - "cssMixin": [ - - ], - "component": false, - "superclasses": [ - "Ext.layout.Layout", - "Ext.layout.component.Component", - "Ext.layout.component.AbstractDock" - ], - "subclasses": [ - "Ext.layout.component.Tip" - ], - "mixedInto": [ - - ], - "allMixins": [ - - ] -}); \ No newline at end of file +Ext.data.JsonP.Ext_layout_component_Dock({"tagname":"class","html":"Hierarchy
Ext.BaseExt.layout.LayoutExt.layout.component.ComponentExt.layout.component.AbstractDockExt.layout.component.DockFiles
NOTE This is a private utility class for internal use by the framework. Don't rely on its existence.
\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
\nThis method will adjust the position of the docked item inside an AutoContainerLayout\nand adjust the body box accordingly.
\nThe box containing information about the width and height\nof this docked item
\nThe index position of this docked item
\nThe adjusted box
\nThis method will set up some initial information about the panel size and bodybox\nand then loop over all the items you pass it to take care of stretching, aligning,\ndock position and all calculations involved with adjusting the body box.
\nArray containing all the docked items we have to layout
\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
\nWe are overriding the Ext.layout.Layout configureItem method to also add a class that\nindicates the position of the docked item. We use the itemCls (x-docked) as a prefix.\nAn example of a class added to a dock: right item is x-docked-right
\nThe item we are configuring
\nDestroys this layout. This is a template method that is empty by default, but should be implemented\nby subclasses that require explicit destruction to purge event handlers or remove DOM nodes.
\nThis is a template method. A hook into the functionality of this class.Feel free to override it in child classes.
This method will first update all the information about the docked items,\nbody dimensions and position, the panel's total size. It will then\nset all these values on the docked items and panel body.
\nReturns an array containing all the visible docked items inside this layout's owner Panel
\nAn array containing all the visible docked items of the Panel
\nReturns the element into which rendering must take place. Defaults to the owner Component's encapsulating element.
\n\n\nMay be overridden in Component layout managers which implement an inner element.
\nThis method will create a box object, with a reference to the item, the type of dock\n(top, left, bottom, right). It will also take care of stretching and aligning of the\ndocked items.
\nThe docked item we want to initialize the box for
\nThe initial box containing width and height and other useful information
\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
\nThe Panel that owns this DockLayout
\nThe target in which we are going to render the docked items
\nThe arguments passed to the ComponentLayout.layout method
\nRender the top and left docked items before any existing DOM nodes in our render target,\nand then render the right and bottom docked items after. This is important, for such things\nas tab stops and ARIA readers, that the DOM nodes are in a meaningful order.\nOur collection of docked items will already be ordered via Panel.getDockedItems().
\nThis function will be called by the dockItems method. Since the body is positioned absolute,\nwe need to give it dimensions and a position so that it is in the middle surrounded by\ndocked items
\nAn object containing new x, y, width and height values for the\nPanel's body
\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
\n