X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/6746dc89c47ed01b165cc1152533605f97eb8e8d..HEAD:/docs/output/Ext.layout.container.Border.js diff --git a/docs/output/Ext.layout.container.Border.js b/docs/output/Ext.layout.container.Border.js index d552e1be..e5744150 100644 --- a/docs/output/Ext.layout.container.Border.js +++ b/docs/output/Ext.layout.container.Border.js @@ -1,252 +1 @@ -Ext.data.JsonP.Ext_layout_container_Border({ - "allMixins": [ - - ], - "deprecated": null, - "docauthor": null, - "members": { - "cfg": [ - { - "type": "Boolean", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "AbstractContainer.html#Ext-layout-container-AbstractContainer-cfg-bindToOwnerCtComponent", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/layout/container/AbstractContainer.js", - "private": false, - "name": "bindToOwnerCtComponent", - "owner": "Ext.layout.container.AbstractContainer", - "doc": "
Flag to notify the ownerCt Component on afterLayout of a change
\n", - "linenr": 17, - "html_filename": "AbstractContainer.html" - }, - { - "type": "Boolean", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "AbstractContainer.html#Ext-layout-container-AbstractContainer-cfg-bindToOwnerCtContainer", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/layout/container/AbstractContainer.js", - "private": false, - "name": "bindToOwnerCtContainer", - "owner": "Ext.layout.container.AbstractContainer", - "doc": "Flag to notify the ownerCt Container on afterLayout of a change
\n", - "linenr": 23, - "html_filename": "AbstractContainer.html" - }, - { - "type": "String", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "AbstractContainer.html#Ext-layout-container-AbstractContainer-cfg-itemCls", - "shortDoc": "An optional extra CSS class that will be added to the container. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/layout/container/AbstractContainer.js", - "private": false, - "name": "itemCls", - "owner": "Ext.layout.container.AbstractContainer", - "doc": "An optional extra CSS class that will be added to the container. This can be useful for adding\ncustomized styles to the container or any of its children using standard CSS rules. See\nExt.Component.ctCls also.
\n\n\n\n", - "linenr": 29, - "html_filename": "AbstractContainer.html" - } - ], - "method": [ - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractContainer.html#Ext-layout-container-AbstractContainer-method-getLayoutItems", - "shortDoc": "Returns an array of child components either for a render phase (Performed in the beforeLayout method of the layout's\n...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/layout/container/AbstractContainer.js", - "private": false, - "params": [ - - ], - "name": "getLayoutItems", - "owner": "Ext.layout.container.AbstractContainer", - "doc": "Returns an array of child components either for a render phase (Performed in the beforeLayout method of the layout's\nbase class), or the layout phase (onLayout).
\n\n", - "linenr": 49, - "return": { - "type": "Array", - "doc": "of child components
\n" - }, - "html_filename": "AbstractContainer.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Border.html#Ext-layout-container-Border-method-getPlaceholder", - "shortDoc": "Return the placeholder Component to which the passed child Panel of the layout will collapse. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/layout/container/Border.js", - "private": false, - "params": [ - { - "type": "Panel", - "optional": false, - "doc": "The child Panel of the layout for which to return the placeholder.
\n", - "name": "panel" - } - ], - "name": "getPlaceholder", - "owner": "Ext.layout.container.Border", - "doc": "Return the placeholder Component to which the passed child Panel of the layout will collapse.\nBy default, this will be a Header component (Docked to the appropriate border). See placeholder.\nconfig to customize this.
\n\n\nNote that this will be a fully instantiated Component, but will only be rendered when the Panel is first collapsed.
\n\n", - "linenr": 505, - "return": { - "type": "Component", - "doc": "The Panel's placeholder unless the collapseMode is\n'header'
, in which case undefined is returned.
Returns the element into which rendering must take place. Defaults to the owner Container's Ext.AbstractComponent.targetEl.
\n\n\nMay be overridden in layout managers which implement an inner element.
\n", - "linenr": 68, - "return": { - "type": "Ext.core.Element", - "doc": "\n" - }, - "html_filename": "AbstractContainer.html" - }, - { - "deprecated": null, - "alias": null, - "protected": true, - "tagname": "method", - "href": "Container.html#Ext-layout-container-Container-method-getRenderedItems", - "shortDoc": "Returns all items that are rendered ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/layout/container/Container.js", - "private": false, - "params": [ - - ], - "name": "getRenderedItems", - "owner": "Ext.layout.container.Container", - "doc": "Returns all items that are rendered
\n", - "linenr": 53, - "return": { - "type": "Array", - "doc": "All matching items
\n" - }, - "html_filename": "Container.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractContainer.html#Ext-layout-container-AbstractContainer-method-getTarget", - "shortDoc": "Returns the owner component's resize element. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/layout/container/AbstractContainer.js", - "private": false, - "params": [ - - ], - "name": "getTarget", - "owner": "Ext.layout.container.AbstractContainer", - "doc": "Returns the owner component's resize element.
\n", - "linenr": 61, - "return": { - "type": "Ext.core.Element", - "doc": "\n" - }, - "html_filename": "AbstractContainer.html" - }, - { - "deprecated": null, - "alias": null, - "protected": true, - "tagname": "method", - "href": "Container.html#Ext-layout-container-Container-method-getVisibleItems", - "shortDoc": "Returns all items that are both rendered and visible ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/layout/container/Container.js", - "private": false, - "params": [ - - ], - "name": "getVisibleItems", - "owner": "Ext.layout.container.Container", - "doc": "Returns all items that are both rendered and visible
\n", - "linenr": 76, - "return": { - "type": "Array", - "doc": "All matching items
\n" - }, - "html_filename": "Container.html" - } - ], - "property": [ - - ], - "cssVar": [ - - ], - "cssMixin": [ - - ], - "event": [ - - ] - }, - "singleton": false, - "alias": null, - "superclasses": [ - "Ext.layout.Layout", - "Ext.layout.container.AbstractContainer", - "Ext.layout.container.Container" - ], - "protected": false, - "tagname": "class", - "mixins": [ - - ], - "href": "Border.html#Ext-layout-container-Border", - "subclasses": [ - - ], - "static": false, - "author": null, - "component": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/layout/container/Border.js", - "private": false, - "alternateClassNames": [ - "Ext.layout.BorderLayout" - ], - "name": "Ext.layout.container.Border", - "doc": "This is a multi-pane, application-oriented UI layout style that supports multiple\nnested panels, automatic bars between regions and built-in\nexpanding and collapsing of regions.
\n\n\nThis class is intended to be extended or created via the layout:'border'
\nExt.container.Container.layout config, and should generally not need to be created directly\nvia the new keyword.
Example usage:
\n\n\n Ext.create('Ext.panel.Panel', {\n width: 500,\n height: 400,\n title: 'Border Layout',\n layout: 'border',\n items: [{\n title: 'South Region is resizable',\n region: 'south', // position for region\n xtype: 'panel',\n height: 100,\n split: true, // enable resizing\n margins: '0 5 5 5'\n },{\n // xtype: 'panel' implied by default\n title: 'West Region is collapsible',\n region:'west',\n xtype: 'panel',\n margins: '5 0 0 5',\n width: 200,\n collapsible: true, // make collapsible\n id: 'west-region-container',\n layout: 'fit'\n },{\n title: 'Center Region',\n region: 'center', // center region is required, no width/height specified\n xtype: 'panel',\n layout: 'fit',\n margins: '5 5 0 0'\n }],\n renderTo: Ext.getBody()\n });\n
\n\n\nNotes:
\n\n\nregion:'center'
.\nThe child item in the center region will always be resized to fill the remaining space not used by\nthe other regions in the layout.west
or east
may be configured with either\nan initial width
, or a Ext.layout.container.Box.flex value, or an initial percentage width string (Which is simply divided by 100 and used as a flex value). The 'center' region has a flex value of 1
.north
or south
may be configured with either\nan initial height
, or a Ext.layout.container.Box.flex value, or an initial percentage height string (Which is simply divided by 100 and used as a flex value). The 'center' region has a flex value of 1
.wrc = Ext.getCmp('west-region-container');\nwrc.removeAll();\nwrc.add({\n title: 'Added Panel',\n html: 'Some content'\n});\n
\nAlternate names
Ext.layout.BorderLayoutHierarchy
Ext.BaseExt.layout.LayoutExt.layout.container.AbstractContainerExt.layout.container.ContainerExt.layout.container.BorderRequires
Files
This is a multi-pane, application-oriented UI layout style that supports multiple nested panels, automatic bars\nbetween regions and built-in expanding and collapsing of regions.
\n\nThis class is intended to be extended or created via the layout:'border'
Ext.container.Container.layout\nconfig, and should generally not need to be created directly via the new keyword.
Ext.create('Ext.panel.Panel', {\n width: 500,\n height: 400,\n title: 'Border Layout',\n layout: 'border',\n items: [{\n title: 'South Region is resizable',\n region: 'south', // position for region\n xtype: 'panel',\n height: 100,\n split: true, // enable resizing\n margins: '0 5 5 5'\n },{\n // xtype: 'panel' implied by default\n title: 'West Region is collapsible',\n region:'west',\n xtype: 'panel',\n margins: '5 0 0 5',\n width: 200,\n collapsible: true, // make collapsible\n id: 'west-region-container',\n layout: 'fit'\n },{\n title: 'Center Region',\n region: 'center', // center region is required, no width/height specified\n xtype: 'panel',\n layout: 'fit',\n margins: '5 5 0 0'\n }],\n renderTo: Ext.getBody()\n});\n
\n\nAny Container using the Border layout must have a child item with region:'center'
.\nThe child item in the center region will always be resized to fill the remaining space\nnot used by the other regions in the layout.
Any child items with a region of west
or east
may be configured with either an initial\nwidth
, or a Ext.layout.container.Box.flex value, or an initial percentage width\nstring (Which is simply divided by 100 and used as a flex value).\nThe 'center' region has a flex value of 1
.
Any child items with a region of north
or south
may be configured with either an initial\nheight
, or a Ext.layout.container.Box.flex value, or an initial percentage height\nstring (Which is simply divided by 100 and used as a flex value).\nThe 'center' region has a flex value of 1
.
The regions of a BorderLayout are fixed at render time and thereafter, its child\nComponents may not be removed or added**. To add/remove Components within a BorderLayout,\nhave them wrapped by an additional Container which is directly managed by the BorderLayout.\nIf the region is to be collapsible, the Container used directly by the BorderLayout manager\nshould be a Panel. In the following example a Container (an Ext.panel.Panel) is added to\nthe west region:
\n\nwrc = Ext.getCmp('west-region-container');\nwrc.removeAll();\nwrc.add({\n title: 'Added Panel',\n html: 'Some content'\n});\n
There is no BorderLayout.Region class in ExtJS 4.0+
Flag to notify the ownerCt Component on afterLayout of a change
\nDefaults to: false
Flag to notify the ownerCt Container on afterLayout of a change
\nDefaults to: false
An optional extra CSS class that will be added to the container. This can be useful for adding\ncustomized styles to the container or any of its children using standard CSS rules. See\nExt.Component.componentCls also.
\n\n\n\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
\nContainers should not lay out child components when collapsed.
\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
\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.
Returns an array of child components either for a render phase (Performed in the beforeLayout method of the layout's\nbase class), or the layout phase (onLayout).
\n\nof child components
\nReturn the placeholder Component to which the passed child Panel of the\nlayout will collapse. By default, this will be a Header component (Docked to the\nappropriate border). See placeholder. config to customize this.
\n\nNote that this will be a fully instantiated Component, but will only be rendered when the Panel is first\ncollapsed.
\nThe child Panel of the layout for which to return the placeholder.
\nThe Panel's placeholder unless the collapseMode is 'header'
, in which case undefined is returned.
Returns the element into which rendering must take place. Defaults to the owner Container's target element.
\n\n\nMay be overridden in layout managers which implement an inner element.
\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
\n