docs/output/Ext.layout.container.VBox.js

   1 Ext.data.JsonP.Ext_layout_container_VBox({
   2   "allMixins": [
   3
   4   ],
   5   "deprecated": null,
   6   "docauthor": null,
   7   "members": {
   8     "cfg": [
   9       {
  10         "type": "String",
  11         "deprecated": null,
  12         "alias": null,
  13         "protected": false,
  14         "tagname": "cfg",
  15         "href": "VBox.html#Ext-layout-container-VBox-cfg-align",
  16         "shortDoc": "Controls how the child items of the container are aligned. ...",
  17         "static": false,
  18         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/layout/container/VBox.js",
  19         "private": false,
  20         "name": "align",
  21         "owner": "Ext.layout.container.VBox",
  22         "doc": "<p>Controls how the child items of the container are aligned. Acceptable configuration values for this\nproperty are:</p>\n\n<div class=\"mdetail-params\"><ul>\n<li><b><tt>left</tt></b> : <b>Default</b><div class=\"sub-desc\">child items are aligned horizontally\nat the <b>left</b> side of the container</div></li>\n<li><b><tt>center</tt></b> : <div class=\"sub-desc\">child items are aligned horizontally at the\n<b>mid-width</b> of the container</div></li>\n<li><b><tt>stretch</tt></b> : <div class=\"sub-desc\">child items are stretched horizontally to fill\nthe width of the container</div></li>\n<li><b><tt>stretchmax</tt></b> : <div class=\"sub-desc\">child items are stretched horizontally to\nthe size of the largest item.</div></li>\n</ul></div>\n\n",
  23         "linenr": 46,
  24         "html_filename": "VBox.html"
  25       },
  26       {
  27         "type": "Mixed",
  28         "deprecated": null,
  29         "alias": null,
  30         "protected": false,
  31         "tagname": "cfg",
  32         "href": "Box.html#Ext-layout-container-Box-cfg-animate",
  33         "shortDoc": "If truthy, child Component are animated into position whenever the Container\nis layed out. ...",
  34         "static": false,
  35         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/layout/container/Box.js",
  36         "private": false,
  37         "name": "animate",
  38         "owner": "Ext.layout.container.Box",
  39         "doc": "<p>If truthy, child Component are <i>animated</i> into position whenever the Container\nis layed out. If this option is numeric, it is used as the animation duration in milliseconds.</p>\n\n\n<p>May be set as a property at any time.</p>\n\n",
  40         "linenr": 25,
  41         "html_filename": "Box.html"
  42       },
  43       {
  44         "type": "Boolean",
  45         "deprecated": null,
  46         "alias": null,
  47         "protected": false,
  48         "tagname": "cfg",
  49         "href": "AbstractContainer.html#Ext-layout-container-AbstractContainer-cfg-bindToOwnerCtComponent",
  50         "static": false,
  51         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/layout/container/AbstractContainer.js",
  52         "private": false,
  53         "name": "bindToOwnerCtComponent",
  54         "owner": "Ext.layout.container.AbstractContainer",
  55         "doc": "<p>Flag to notify the ownerCt Component on afterLayout of a change</p>\n",
  56         "linenr": 17,
  57         "html_filename": "AbstractContainer.html"
  58       },
  59       {
  60         "type": "Boolean",
  61         "deprecated": null,
  62         "alias": null,
  63         "protected": false,
  64         "tagname": "cfg",
  65         "href": "AbstractContainer.html#Ext-layout-container-AbstractContainer-cfg-bindToOwnerCtContainer",
  66         "static": false,
  67         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/layout/container/AbstractContainer.js",
  68         "private": false,
  69         "name": "bindToOwnerCtContainer",
  70         "owner": "Ext.layout.container.AbstractContainer",
  71         "doc": "<p>Flag to notify the ownerCt Container on afterLayout of a change</p>\n",
  72         "linenr": 23,
  73         "html_filename": "AbstractContainer.html"
  74       },
  75       {
  76         "type": "Boolean",
  77         "deprecated": null,
  78         "alias": null,
  79         "protected": false,
  80         "tagname": "cfg",
  81         "href": "Box.html#Ext-layout-container-Box-cfg-clearInnerCtOnLayout",
  82         "static": false,
  83         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/layout/container/Box.js",
  84         "private": false,
  85         "name": "clearInnerCtOnLayout",
  86         "owner": "Ext.layout.container.Box",
  87         "doc": "\n",
  88         "linenr": 126,
  89         "html_filename": "Box.html"
  90       },
  91       {
  92         "type": "Object",
  93         "deprecated": null,
  94         "alias": null,
  95         "protected": false,
  96         "tagname": "cfg",
  97         "href": "Box.html#Ext-layout-container-Box-cfg-defaultMargins",
  98         "shortDoc": "If the individual contained items do not have a margins\nproperty specified or margin specified via CSS, the default m...",
  99         "static": false,
 100         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/layout/container/Box.js",
 101         "private": false,
 102         "name": "defaultMargins",
 103         "owner": "Ext.layout.container.Box",
 104         "doc": "<p>If the individual contained items do not have a <tt>margins</tt>\nproperty specified or margin specified via CSS, the default margins from this property will be\napplied to each item.</p>\n\n\n<br><p>This property may be specified as an object containing margins\n\n\n<p>to apply in the format:</p></p>\n\n<pre><code>{\n    top: (top margin),\n    right: (right margin),\n    bottom: (bottom margin),\n    left: (left margin)\n}</code></pre>\n\n\n<p>This property may also be specified as a string containing\nspace-separated, numeric margin values. The order of the sides associated\nwith each value matches the way CSS processes margin values:</p>\n\n\n<div class=\"mdetail-params\"><ul>\n<li>If there is only one value, it applies to all sides.</li>\n<li>If there are two values, the top and bottom borders are set to the\nfirst value and the right and left are set to the second.</li>\n<li>If there are three values, the top is set to the first value, the left\nand right are set to the second, and the bottom is set to the third.</li>\n<li>If there are four values, they apply to the top, right, bottom, and\nleft, respectively.</li>\n</ul></div>\n\n\n<p>Defaults to:</p>\n\n\n<pre><code>{top:0, right:0, bottom:0, left:0}\n</code></pre>\n\n",
 105         "linenr": 32,
 106         "html_filename": "Box.html"
 107       },
 108       {
 109         "type": "Number",
 110         "deprecated": null,
 111         "alias": null,
 112         "protected": false,
 113         "tagname": "cfg",
 114         "href": "Box.html#Ext-layout-container-Box-cfg-flex",
 115         "shortDoc": "This configuration option is to be applied to child items of the container managed\nby this layout. ...",
 116         "static": false,
 117         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/layout/container/Box.js",
 118         "private": false,
 119         "name": "flex",
 120         "owner": "Ext.layout.container.Box",
 121         "doc": "<p>This configuration option is to be applied to <b>child <tt>items</tt></b> of the container managed\nby this layout. Each child item with a <tt>flex</tt> property will be flexed <b>horizontally</b>\naccording to each item's <b>relative</b> <tt>flex</tt> value compared to the sum of all items with\na <tt>flex</tt> value specified.  Any child items that have either a <tt>flex = 0</tt> or\n<tt>flex = undefined</tt> will not be 'flexed' (the initial size will not be changed).</p>\n",
 122         "linenr": 102,
 123         "html_filename": "Box.html"
 124       },
 125       {
 126         "type": "String",
 127         "deprecated": null,
 128         "alias": null,
 129         "protected": false,
 130         "tagname": "cfg",
 131         "href": "AbstractContainer.html#Ext-layout-container-AbstractContainer-cfg-itemCls",
 132         "shortDoc": "An optional extra CSS class that will be added to the container. ...",
 133         "static": false,
 134         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/layout/container/AbstractContainer.js",
 135         "private": false,
 136         "name": "itemCls",
 137         "owner": "Ext.layout.container.AbstractContainer",
 138         "doc": "<p>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\n<a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Ext.Component</a>.ctCls also.</p>\n\n\n<p></p></p>\n",
 139         "linenr": 29,
 140         "html_filename": "AbstractContainer.html"
 141       },
 142       {
 143         "type": "String",
 144         "deprecated": null,
 145         "alias": null,
 146         "protected": false,
 147         "tagname": "cfg",
 148         "href": "Box.html#Ext-layout-container-Box-cfg-pack",
 149         "shortDoc": "Controls how the child items of the container are packed together. ...",
 150         "static": false,
 151         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/layout/container/Box.js",
 152         "private": false,
 153         "name": "pack",
 154         "owner": "Ext.layout.container.Box",
 155         "doc": "<p>Controls how the child items of the container are packed together. Acceptable configuration values\nfor this property are:</p>\n\n<div class=\"mdetail-params\"><ul>\n<li><b><tt>start</tt></b> : <b>Default</b><div class=\"sub-desc\">child items are packed together at\n<b>left</b> side of container</div></li>\n<li><b><tt>center</tt></b> : <div class=\"sub-desc\">child items are packed together at\n<b>mid-width</b> of container</div></li>\n<li><b><tt>end</tt></b> : <div class=\"sub-desc\">child items are packed together at <b>right</b>\nside of container</div></li>\n</ul></div>\n\n",
 156         "linenr": 89,
 157         "html_filename": "Box.html"
 158       },
 159       {
 160         "type": "String",
 161         "deprecated": null,
 162         "alias": null,
 163         "protected": false,
 164         "tagname": "cfg",
 165         "href": "Box.html#Ext-layout-container-Box-cfg-padding",
 166         "shortDoc": "Sets the padding to be applied to all child items managed by this layout. ...",
 167         "static": false,
 168         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/layout/container/Box.js",
 169         "private": false,
 170         "name": "padding",
 171         "owner": "Ext.layout.container.Box",
 172         "doc": "<p>Sets the padding to be applied to all child items managed by this layout.</p>\n\n\n<p>This property must be specified as a string containing\nspace-separated, numeric padding values. The order of the sides associated\nwith each value matches the way CSS processes padding values:</p>\n\n\n<div class=\"mdetail-params\"><ul>\n<li>If there is only one value, it applies to all sides.</li>\n<li>If there are two values, the top and bottom borders are set to the\nfirst value and the right and left are set to the second.</li>\n<li>If there are three values, the top is set to the first value, the left\nand right are set to the second, and the bottom is set to the third.</li>\n<li>If there are four values, they apply to the top, right, bottom, and\nleft, respectively.</li>\n</ul></div>\n\n\n<p>Defaults to: <code>\"0\"</code></p>\n\n",
 173         "linenr": 68,
 174         "html_filename": "Box.html"
 175       }
 176     ],
 177     "method": [
 178       {
 179         "deprecated": null,
 180         "alias": null,
 181         "protected": false,
 182         "tagname": "method",
 183         "href": "AbstractContainer.html#Ext-layout-container-AbstractContainer-method-getLayoutItems",
 184         "shortDoc": "Returns an array of child components either for a render phase (Performed in the beforeLayout method of the layout's\n...",
 185         "static": false,
 186         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/layout/container/AbstractContainer.js",
 187         "private": false,
 188         "params": [
 189
 190         ],
 191         "name": "getLayoutItems",
 192         "owner": "Ext.layout.container.AbstractContainer",
 193         "doc": "<p>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).</p>\n\n",
 194         "linenr": 49,
 195         "return": {
 196           "type": "Array",
 197           "doc": "<p>of child components</p>\n"
 198         },
 199         "html_filename": "AbstractContainer.html"
 200       },
 201       {
 202         "deprecated": null,
 203         "alias": null,
 204         "protected": false,
 205         "tagname": "method",
 206         "href": "AbstractContainer.html#Ext-layout-container-AbstractContainer-method-getRenderTarget",
 207         "shortDoc": "Returns the element into which rendering must take place. ...",
 208         "static": false,
 209         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/layout/container/AbstractContainer.js",
 210         "private": false,
 211         "params": [
 212
 213         ],
 214         "name": "getRenderTarget",
 215         "owner": "Ext.layout.container.AbstractContainer",
 216         "doc": "<p>Returns the element into which rendering must take place. Defaults to the owner Container's Ext.AbstractComponent.targetEl.</p>\n\n\n<p>May be overridden in layout managers which implement an inner element.</p>\n",
 217         "linenr": 68,
 218         "return": {
 219           "type": "Ext.core.Element",
 220           "doc": "\n"
 221         },
 222         "html_filename": "AbstractContainer.html"
 223       },
 224       {
 225         "deprecated": null,
 226         "alias": null,
 227         "protected": true,
 228         "tagname": "method",
 229         "href": "Container.html#Ext-layout-container-Container-method-getRenderedItems",
 230         "shortDoc": "Returns all items that are rendered ...",
 231         "static": false,
 232         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/layout/container/Container.js",
 233         "private": false,
 234         "params": [
 235
 236         ],
 237         "name": "getRenderedItems",
 238         "owner": "Ext.layout.container.Container",
 239         "doc": "<p>Returns all items that are rendered</p>\n",
 240         "linenr": 53,
 241         "return": {
 242           "type": "Array",
 243           "doc": "<p>All matching items</p>\n"
 244         },
 245         "html_filename": "Container.html"
 246       },
 247       {
 248         "deprecated": null,
 249         "alias": null,
 250         "protected": false,
 251         "tagname": "method",
 252         "href": "AbstractContainer.html#Ext-layout-container-AbstractContainer-method-getTarget",
 253         "shortDoc": "Returns the owner component's resize element. ...",
 254         "static": false,
 255         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/layout/container/AbstractContainer.js",
 256         "private": false,
 257         "params": [
 258
 259         ],
 260         "name": "getTarget",
 261         "owner": "Ext.layout.container.AbstractContainer",
 262         "doc": "<p>Returns the owner component's resize element.</p>\n",
 263         "linenr": 61,
 264         "return": {
 265           "type": "Ext.core.Element",
 266           "doc": "\n"
 267         },
 268         "html_filename": "AbstractContainer.html"
 269       },
 270       {
 271         "deprecated": null,
 272         "alias": null,
 273         "protected": true,
 274         "tagname": "method",
 275         "href": "Container.html#Ext-layout-container-Container-method-getVisibleItems",
 276         "shortDoc": "Returns all items that are both rendered and visible ...",
 277         "static": false,
 278         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/layout/container/Container.js",
 279         "private": false,
 280         "params": [
 281
 282         ],
 283         "name": "getVisibleItems",
 284         "owner": "Ext.layout.container.Container",
 285         "doc": "<p>Returns all items that are both rendered and visible</p>\n",
 286         "linenr": 76,
 287         "return": {
 288           "type": "Array",
 289           "doc": "<p>All matching items</p>\n"
 290         },
 291         "html_filename": "Container.html"
 292       },
 293       {
 294         "deprecated": null,
 295         "alias": null,
 296         "protected": false,
 297         "tagname": "method",
 298         "href": "Box.html#Ext-layout-container-Box-method-updateChildBoxes",
 299         "shortDoc": "Resizes and repositions each child component ...",
 300         "static": false,
 301         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/layout/container/Box.js",
 302         "private": false,
 303         "params": [
 304           {
 305             "type": "Array",
 306             "optional": false,
 307             "doc": "<p>The box measurements</p>\n",
 308             "name": "boxes"
 309           }
 310         ],
 311         "name": "updateChildBoxes",
 312         "owner": "Ext.layout.container.Box",
 313         "doc": "<p>Resizes and repositions each child component</p>\n",
 314         "linenr": 581,
 315         "return": {
 316           "type": "void",
 317           "doc": "\n"
 318         },
 319         "html_filename": "Box.html"
 320       }
 321     ],
 322     "property": [
 323
 324     ],
 325     "cssVar": [
 326
 327     ],
 328     "cssMixin": [
 329
 330     ],
 331     "event": [
 332
 333     ]
 334   },
 335   "singleton": false,
 336   "alias": null,
 337   "superclasses": [
 338     "Ext.layout.Layout",
 339     "Ext.layout.container.AbstractContainer",
 340     "Ext.layout.container.Container",
 341     "Ext.layout.container.Box"
 342   ],
 343   "protected": false,
 344   "tagname": "class",
 345   "mixins": [
 346
 347   ],
 348   "href": "VBox.html#Ext-layout-container-VBox",
 349   "subclasses": [
 350     "Ext.layout.container.Accordion"
 351   ],
 352   "static": false,
 353   "author": null,
 354   "component": false,
 355   "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/layout/container/VBox.js",
 356   "private": false,
 357   "alternateClassNames": [
 358     "Ext.layout.VBoxLayout"
 359   ],
 360   "name": "Ext.layout.container.VBox",
 361   "doc": "<p>A layout that arranges items vertically down a Container. This layout optionally divides available vertical\nspace between child items containing a numeric <code>flex</code> configuration.</p>\n\n\n<p>This layout may also be used to set the widths of child items by configuring it with the <a href=\"#/api/Ext.layout.container.VBox-cfg-align\" rel=\"Ext.layout.container.VBox-cfg-align\" class=\"docClass\">align</a> option.\n<p><img src=\"doc-resources/Ext.layout.container.VBox/Ext.layout.container.VBox.png\" alt=\"Ext.layout.container.VBox container layout\"></p>\nExample usage:</p>\n\n<pre><code>Ext.create('Ext.Panel', {\n    width: 500,\n    height: 400,\n    title: \"VBoxLayout Panel\",\n    layout: {                        \n        type: 'vbox',\n        align: 'center'\n    },\n    renderTo: document.body,\n    items: [{                        \n        xtype: 'panel',\n        title: 'Inner Panel One',\n        width: 250,\n        flex: 2                      \n    },{\n        xtype: 'panel',\n        title: 'Inner Panel Two',\n        width: 250,         \n        flex: 4\n    },{\n        xtype: 'panel',\n        title: 'Inner Panel Three',\n        width: '50%',           \n        flex: 4\n    }]\n});\n</code></pre>\n",
 362   "mixedInto": [
 363
 364   ],
 365   "linenr": 1,
 366   "xtypes": [
 367
 368   ],
 369   "html_filename": "VBox.html",
 370   "extends": "Ext.layout.container.Box"
 371 });