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

   1 Ext.data.JsonP.Ext_layout_container_Box({
   2   "tagname": "class",
   3   "name": "Ext.layout.container.Box",
   4   "doc": "<p>Base Class for HBoxLayout and VBoxLayout Classes. Generally it should not need to be used directly.</p>\n\n",
   5   "extends": "Ext.layout.container.Container",
   6   "mixins": [
   7
   8   ],
   9   "alternateClassNames": [
  10     "Ext.layout.BoxLayout"
  11   ],
  12   "xtype": null,
  13   "author": null,
  14   "docauthor": null,
  15   "singleton": false,
  16   "private": false,
  17   "cfg": [
  18     {
  19       "tagname": "cfg",
  20       "name": "animate",
  21       "member": "Ext.layout.container.Box",
  22       "type": "Mixed",
  23       "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",
  24       "private": false,
  25       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/container/Box.js",
  26       "linenr": 25,
  27       "html_filename": "Box.html",
  28       "href": "Box.html#Ext-layout-container-Box-cfg-animate",
  29       "shortDoc": "If truthy, child Component are animated into position whenever the Container\nis layed out. If this option is numeric,..."
  30     },
  31     {
  32       "tagname": "cfg",
  33       "name": "bindToOwnerCtComponent",
  34       "member": "Ext.layout.container.AbstractContainer",
  35       "type": "Boolean",
  36       "doc": "<p>Flag to notify the ownerCt Component on afterLayout of a change</p>\n",
  37       "private": false,
  38       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/layout/container/AbstractContainer.js",
  39       "linenr": 24,
  40       "html_filename": "AbstractContainer2.html",
  41       "href": "AbstractContainer2.html#Ext-layout-container-AbstractContainer-cfg-bindToOwnerCtComponent"
  42     },
  43     {
  44       "tagname": "cfg",
  45       "name": "bindToOwnerCtContainer",
  46       "member": "Ext.layout.container.AbstractContainer",
  47       "type": "Boolean",
  48       "doc": "<p>Flag to notify the ownerCt Container on afterLayout of a change</p>\n",
  49       "private": false,
  50       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/layout/container/AbstractContainer.js",
  51       "linenr": 30,
  52       "html_filename": "AbstractContainer2.html",
  53       "href": "AbstractContainer2.html#Ext-layout-container-AbstractContainer-cfg-bindToOwnerCtContainer"
  54     },
  55     {
  56       "tagname": "cfg",
  57       "name": "clearInnerCtOnLayout",
  58       "member": "Ext.layout.container.Box",
  59       "type": "Boolean",
  60       "doc": "\n",
  61       "private": false,
  62       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/container/Box.js",
  63       "linenr": 128,
  64       "html_filename": "Box.html",
  65       "href": "Box.html#Ext-layout-container-Box-cfg-clearInnerCtOnLayout"
  66     },
  67     {
  68       "tagname": "cfg",
  69       "name": "defaultMargins",
  70       "member": "Ext.layout.container.Box",
  71       "type": "Object",
  72       "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",
  73       "private": false,
  74       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/container/Box.js",
  75       "linenr": 32,
  76       "html_filename": "Box.html",
  77       "href": "Box.html#Ext-layout-container-Box-cfg-defaultMargins",
  78       "shortDoc": "If the individual contained items do not have a margins\nproperty specified or margin specified via CSS, the default m..."
  79     },
  80     {
  81       "tagname": "cfg",
  82       "name": "flex",
  83       "member": "Ext.layout.container.Box",
  84       "type": "Number",
  85       "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",
  86       "private": false,
  87       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/container/Box.js",
  88       "linenr": 102,
  89       "html_filename": "Box.html",
  90       "href": "Box.html#Ext-layout-container-Box-cfg-flex",
  91       "shortDoc": "This configuration option is to be applied to child items of the container managed\nby this layout. Each child item wi..."
  92     },
  93     {
  94       "tagname": "cfg",
  95       "name": "itemCls",
  96       "member": "Ext.layout.container.AbstractContainer",
  97       "type": "String",
  98       "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>.<a href=\"#/api/Ext.Component--ctCls\" rel=\"Ext.Component--ctCls\" class=\"docClass\">ctCls</a> also.</p>\n\n\n<p></p></p>\n",
  99       "private": false,
 100       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/layout/container/AbstractContainer.js",
 101       "linenr": 36,
 102       "html_filename": "AbstractContainer2.html",
 103       "href": "AbstractContainer2.html#Ext-layout-container-AbstractContainer-cfg-itemCls",
 104       "shortDoc": "An optional extra CSS class that will be added to the container. This can be useful for adding\ncustomized styles to t..."
 105     },
 106     {
 107       "tagname": "cfg",
 108       "name": "pack",
 109       "member": "Ext.layout.container.Box",
 110       "type": "String",
 111       "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",
 112       "private": false,
 113       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/container/Box.js",
 114       "linenr": 89,
 115       "html_filename": "Box.html",
 116       "href": "Box.html#Ext-layout-container-Box-cfg-pack",
 117       "shortDoc": "Controls how the child items of the container are packed together. Acceptable configuration values\nfor this property ..."
 118     },
 119     {
 120       "tagname": "cfg",
 121       "name": "padding",
 122       "member": "Ext.layout.container.Box",
 123       "type": "String",
 124       "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",
 125       "private": false,
 126       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/container/Box.js",
 127       "linenr": 68,
 128       "html_filename": "Box.html",
 129       "href": "Box.html#Ext-layout-container-Box-cfg-padding",
 130       "shortDoc": "Sets the padding to be applied to all child items managed by this layout.\n\n\nThis property must be specified as a stri..."
 131     }
 132   ],
 133   "method": [
 134     {
 135       "tagname": "method",
 136       "name": "getLayoutItems",
 137       "member": "Ext.layout.container.AbstractContainer",
 138       "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",
 139       "params": [
 140
 141       ],
 142       "return": {
 143         "type": "Array",
 144         "doc": "<p>of child components</p>\n"
 145       },
 146       "private": false,
 147       "static": false,
 148       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/layout/container/AbstractContainer.js",
 149       "linenr": 87,
 150       "html_filename": "AbstractContainer2.html",
 151       "href": "AbstractContainer2.html#Ext-layout-container-AbstractContainer-method-getLayoutItems",
 152       "shortDoc": "Returns an array of child components either for a render phase (Performed in the beforeLayout method of the layout's\n..."
 153     },
 154     {
 155       "tagname": "method",
 156       "name": "getRenderTarget",
 157       "member": "Ext.layout.container.AbstractContainer",
 158       "doc": "<p>Returns the element into which rendering must take place. Defaults to the owner Container's <a href=\"#/api/Ext.AbstractComponent--targetEl\" rel=\"Ext.AbstractComponent--targetEl\" class=\"docClass\">Ext.AbstractComponent.targetEl</a>.</p>\n\n\n<p>May be overridden in layout managers which implement an inner element.</p>\n",
 159       "params": [
 160
 161       ],
 162       "return": {
 163         "type": "Ext.core.Element",
 164         "doc": "\n"
 165       },
 166       "private": false,
 167       "static": false,
 168       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/layout/container/AbstractContainer.js",
 169       "linenr": 106,
 170       "html_filename": "AbstractContainer2.html",
 171       "href": "AbstractContainer2.html#Ext-layout-container-AbstractContainer-method-getRenderTarget",
 172       "shortDoc": "Returns the element into which rendering must take place. Defaults to the owner Container's Ext.AbstractComponent.tar..."
 173     },
 174     {
 175       "tagname": "method",
 176       "name": "getTarget",
 177       "member": "Ext.layout.container.AbstractContainer",
 178       "doc": "<p>Returns the owner component's resize element.</p>\n",
 179       "params": [
 180
 181       ],
 182       "return": {
 183         "type": "Ext.core.Element",
 184         "doc": "\n"
 185       },
 186       "private": false,
 187       "static": false,
 188       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/layout/container/AbstractContainer.js",
 189       "linenr": 99,
 190       "html_filename": "AbstractContainer2.html",
 191       "href": "AbstractContainer2.html#Ext-layout-container-AbstractContainer-method-getTarget",
 192       "shortDoc": "<p>Returns the owner component's resize element.</p>\n"
 193     },
 194     {
 195       "tagname": "method",
 196       "name": "updateChildBoxes",
 197       "member": "Ext.layout.container.Box",
 198       "doc": "<p>Resizes and repositions each child component</p>\n",
 199       "params": [
 200         {
 201           "type": "Array",
 202           "name": "boxes",
 203           "doc": "<p>The box measurements</p>\n",
 204           "optional": false
 205         }
 206       ],
 207       "return": {
 208         "type": "void",
 209         "doc": "\n"
 210       },
 211       "private": false,
 212       "static": false,
 213       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/container/Box.js",
 214       "linenr": 580,
 215       "html_filename": "Box.html",
 216       "href": "Box.html#Ext-layout-container-Box-method-updateChildBoxes",
 217       "shortDoc": "<p>Resizes and repositions each child component</p>\n"
 218     }
 219   ],
 220   "property": [
 221
 222   ],
 223   "event": [
 224
 225   ],
 226   "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/container/Box.js",
 227   "linenr": 1,
 228   "html_filename": "Box.html",
 229   "href": "Box.html#Ext-layout-container-Box",
 230   "cssVar": [
 231
 232   ],
 233   "cssMixin": [
 234
 235   ],
 236   "component": false,
 237   "superclasses": [
 238     "Ext.layout.Layout",
 239     "Ext.layout.container.AbstractContainer",
 240     "Ext.layout.container.Container"
 241   ],
 242   "subclasses": [
 243     "Ext.layout.container.HBox",
 244     "Ext.layout.container.VBox"
 245   ],
 246   "mixedInto": [
 247
 248   ],
 249   "allMixins": [
 250
 251   ]
 252 });