X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/3789b528d8dd8aad4558e38e22d775bcab1cbd36..6746dc89c47ed01b165cc1152533605f97eb8e8d:/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 2e7dfe9d..d552e1be 100644 --- a/docs/output/Ext.layout.container.Border.js +++ b/docs/output/Ext.layout.container.Border.js @@ -1,174 +1,252 @@ Ext.data.JsonP.Ext_layout_container_Border({ - "tagname": "class", - "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
\nFlag to notify the ownerCt Component on afterLayout of a change
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/layout/container/AbstractContainer.js", - "linenr": 24, - "html_filename": "AbstractContainer2.html", - "href": "AbstractContainer2.html#Ext-layout-container-AbstractContainer-cfg-bindToOwnerCtComponent" - }, - { - "tagname": "cfg", - "name": "bindToOwnerCtContainer", - "member": "Ext.layout.container.AbstractContainer", - "type": "Boolean", - "doc": "Flag to notify the ownerCt Container on afterLayout of a change
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/layout/container/AbstractContainer.js", - "linenr": 30, - "html_filename": "AbstractContainer2.html", - "href": "AbstractContainer2.html#Ext-layout-container-AbstractContainer-cfg-bindToOwnerCtContainer" - }, - { - "tagname": "cfg", - "name": "itemCls", - "member": "Ext.layout.container.AbstractContainer", - "type": "String", - "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", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/layout/container/AbstractContainer.js", - "linenr": 36, - "html_filename": "AbstractContainer2.html", - "href": "AbstractContainer2.html#Ext-layout-container-AbstractContainer-cfg-itemCls", - "shortDoc": "An optional extra CSS class that will be added to the container. This can be useful for adding\ncustomized styles to t..." - } - ], - "method": [ - { - "tagname": "method", - "name": "getLayoutItems", - "member": "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", - "params": [ + "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": [ - ], - "return": { - "type": "Array", - "doc": "of child components
\n" + ], + "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" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/layout/container/AbstractContainer.js", - "linenr": 87, - "html_filename": "AbstractContainer2.html", - "href": "AbstractContainer2.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..." - }, - { - "tagname": "method", - "name": "getPlaceholder", - "member": "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", - "params": [ - { - "type": "Panel", - "name": "panel", - "doc": "The child Panel of the layout for which to return the placeholder.
\n", - "optional": false - } - ], - "return": { - "type": "Component", - "doc": "The Panel's placeholder unless the collapseMode is\n'header'
, in which case undefined is returned.
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", - "params": [ + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "AbstractContainer.html#Ext-layout-container-AbstractContainer-method-getRenderTarget", + "shortDoc": "Returns the element into which rendering must take place. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/layout/container/AbstractContainer.js", + "private": false, + "params": [ - ], - "return": { - "type": "Ext.core.Element", - "doc": "\n" + ], + "name": "getRenderTarget", + "owner": "Ext.layout.container.AbstractContainer", + "doc": "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" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/layout/container/AbstractContainer.js", - "linenr": 106, - "html_filename": "AbstractContainer2.html", - "href": "AbstractContainer2.html#Ext-layout-container-AbstractContainer-method-getRenderTarget", - "shortDoc": "Returns the element into which rendering must take place. Defaults to the owner Container's Ext.AbstractComponent.tar..." - }, - { - "tagname": "method", - "name": "getTarget", - "member": "Ext.layout.container.AbstractContainer", - "doc": "Returns the owner component's resize element.
\n", - "params": [ + { + "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": [ - ], - "return": { - "type": "Ext.core.Element", - "doc": "\n" + ], + "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" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/layout/container/AbstractContainer.js", - "linenr": 99, - "html_filename": "AbstractContainer2.html", - "href": "AbstractContainer2.html#Ext-layout-container-AbstractContainer-method-getTarget", - "shortDoc": "Returns the owner component's resize element.
\n" - } - ], - "property": [ + { + "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": [ - ], - "event": [ + ], + "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": [ - ], - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/container/Border.js", - "linenr": 1, - "html_filename": "Border.html", - "href": "Border.html#Ext-layout-container-Border", - "cssVar": [ + ], + "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": [ - ], - "cssMixin": [ + ], + "cssVar": [ - ], - "component": false, + ], + "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
\n