docs/output/Ext.grid.ColumnLayout.js

   1 Ext.data.JsonP.Ext_grid_ColumnLayout({
   2   "tagname": "class",
   3   "name": "Ext.grid.ColumnLayout",
   4   "doc": "<p>This class is used only by the grid's HeaderContainer docked child.</p>\n\n\n\n\n<p>This class adds the ability to shrink the vertical size of the inner container element back if a grouped\ncolumn header has all its child columns dragged out, and the whole HeaderContainer needs to shrink back down.</p>\n\n\n\n\n<p>It also enforces the grid's HeaderContainer's forceFit config by, after every calaculateChildBoxes call, converting\nall pixel widths into flex values, so that propertions are maintained upon width change of the grid.</p>\n\n\n\n\n<p>Also, after every layout, after all headers have attained their 'stretchmax' height, it goes through and calls\n<code>setPadding</code> on the columns so that they lay out correctly. TODO: implement a ColumnHeader component\nlayout which takes responsibility for this, and will run upon resize.</p>\n\n",
   5   "extends": "Ext.layout.container.HBox",
   6   "mixins": [
   7
   8   ],
   9   "alternateClassNames": [
  10
  11   ],
  12   "xtype": null,
  13   "author": null,
  14   "docauthor": null,
  15   "singleton": false,
  16   "private": true,
  17   "cfg": [
  18     {
  19       "tagname": "cfg",
  20       "name": "align",
  21       "member": "Ext.layout.container.HBox",
  22       "type": "String",
  23       "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>top</tt></b> : <b>Default</b><div class=\"sub-desc\">child items are aligned vertically\nat the <b>top</b> of the container</div></li>\n<li><b><tt>middle</tt></b> : <div class=\"sub-desc\">child items are aligned vertically in the\n<b>middle</b> of the container</div></li>\n<li><b><tt>stretch</tt></b> : <div class=\"sub-desc\">child items are stretched vertically to fill\nthe height of the container</div></li>\n<li><b><tt>stretchmax</tt></b> : <div class=\"sub-desc\">child items are stretched vertically to\nthe height of the largest item.</div></li>\n</ul></div>\n\n",
  24       "private": false,
  25       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/container/HBox.js",
  26       "linenr": 43,
  27       "html_filename": "HBox.html",
  28       "href": "HBox.html#Ext-layout-container-HBox-cfg-align",
  29       "shortDoc": "Controls how the child items of the container are aligned. Acceptable configuration values for this\nproperty are:\n\n\nt..."
  30     },
  31     {
  32       "tagname": "cfg",
  33       "name": "animate",
  34       "member": "Ext.layout.container.Box",
  35       "type": "Mixed",
  36       "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",
  37       "private": false,
  38       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/container/Box.js",
  39       "linenr": 25,
  40       "html_filename": "Box.html",
  41       "href": "Box.html#Ext-layout-container-Box-cfg-animate",
  42       "shortDoc": "If truthy, child Component are animated into position whenever the Container\nis layed out. If this option is numeric,..."
  43     },
  44     {
  45       "tagname": "cfg",
  46       "name": "bindToOwnerCtComponent",
  47       "member": "Ext.layout.container.AbstractContainer",
  48       "type": "Boolean",
  49       "doc": "<p>Flag to notify the ownerCt Component on afterLayout of a change</p>\n",
  50       "private": false,
  51       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/layout/container/AbstractContainer.js",
  52       "linenr": 24,
  53       "html_filename": "AbstractContainer2.html",
  54       "href": "AbstractContainer2.html#Ext-layout-container-AbstractContainer-cfg-bindToOwnerCtComponent"
  55     },
  56     {
  57       "tagname": "cfg",
  58       "name": "bindToOwnerCtContainer",
  59       "member": "Ext.layout.container.AbstractContainer",
  60       "type": "Boolean",
  61       "doc": "<p>Flag to notify the ownerCt Container on afterLayout of a change</p>\n",
  62       "private": false,
  63       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/layout/container/AbstractContainer.js",
  64       "linenr": 30,
  65       "html_filename": "AbstractContainer2.html",
  66       "href": "AbstractContainer2.html#Ext-layout-container-AbstractContainer-cfg-bindToOwnerCtContainer"
  67     },
  68     {
  69       "tagname": "cfg",
  70       "name": "clearInnerCtOnLayout",
  71       "member": "Ext.layout.container.Box",
  72       "type": "Boolean",
  73       "doc": "\n",
  74       "private": false,
  75       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/container/Box.js",
  76       "linenr": 128,
  77       "html_filename": "Box.html",
  78       "href": "Box.html#Ext-layout-container-Box-cfg-clearInnerCtOnLayout"
  79     },
  80     {
  81       "tagname": "cfg",
  82       "name": "defaultMargins",
  83       "member": "Ext.layout.container.Box",
  84       "type": "Object",
  85       "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",
  86       "private": false,
  87       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/container/Box.js",
  88       "linenr": 32,
  89       "html_filename": "Box.html",
  90       "href": "Box.html#Ext-layout-container-Box-cfg-defaultMargins",
  91       "shortDoc": "If the individual contained items do not have a margins\nproperty specified or margin specified via CSS, the default m..."
  92     },
  93     {
  94       "tagname": "cfg",
  95       "name": "flex",
  96       "member": "Ext.layout.container.Box",
  97       "type": "Number",
  98       "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",
  99       "private": false,
 100       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/container/Box.js",
 101       "linenr": 102,
 102       "html_filename": "Box.html",
 103       "href": "Box.html#Ext-layout-container-Box-cfg-flex",
 104       "shortDoc": "This configuration option is to be applied to child items of the container managed\nby this layout. Each child item wi..."
 105     },
 106     {
 107       "tagname": "cfg",
 108       "name": "itemCls",
 109       "member": "Ext.layout.container.AbstractContainer",
 110       "type": "String",
 111       "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",
 112       "private": false,
 113       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/layout/container/AbstractContainer.js",
 114       "linenr": 36,
 115       "html_filename": "AbstractContainer2.html",
 116       "href": "AbstractContainer2.html#Ext-layout-container-AbstractContainer-cfg-itemCls",
 117       "shortDoc": "An optional extra CSS class that will be added to the container. This can be useful for adding\ncustomized styles to t..."
 118     },
 119     {
 120       "tagname": "cfg",
 121       "name": "pack",
 122       "member": "Ext.layout.container.Box",
 123       "type": "String",
 124       "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",
 125       "private": false,
 126       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/container/Box.js",
 127       "linenr": 89,
 128       "html_filename": "Box.html",
 129       "href": "Box.html#Ext-layout-container-Box-cfg-pack",
 130       "shortDoc": "Controls how the child items of the container are packed together. Acceptable configuration values\nfor this property ..."
 131     },
 132     {
 133       "tagname": "cfg",
 134       "name": "padding",
 135       "member": "Ext.layout.container.Box",
 136       "type": "String",
 137       "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",
 138       "private": false,
 139       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/container/Box.js",
 140       "linenr": 68,
 141       "html_filename": "Box.html",
 142       "href": "Box.html#Ext-layout-container-Box-cfg-padding",
 143       "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..."
 144     }
 145   ],
 146   "method": [
 147     {
 148       "tagname": "method",
 149       "name": "getLayoutItems",
 150       "member": "Ext.layout.container.AbstractContainer",
 151       "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",
 152       "params": [
 153
 154       ],
 155       "return": {
 156         "type": "Array",
 157         "doc": "<p>of child components</p>\n"
 158       },
 159       "private": false,
 160       "static": false,
 161       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/layout/container/AbstractContainer.js",
 162       "linenr": 87,
 163       "html_filename": "AbstractContainer2.html",
 164       "href": "AbstractContainer2.html#Ext-layout-container-AbstractContainer-method-getLayoutItems",
 165       "shortDoc": "Returns an array of child components either for a render phase (Performed in the beforeLayout method of the layout's\n..."
 166     },
 167     {
 168       "tagname": "method",
 169       "name": "getRenderTarget",
 170       "member": "Ext.layout.container.AbstractContainer",
 171       "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",
 172       "params": [
 173
 174       ],
 175       "return": {
 176         "type": "Ext.core.Element",
 177         "doc": "\n"
 178       },
 179       "private": false,
 180       "static": false,
 181       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/layout/container/AbstractContainer.js",
 182       "linenr": 106,
 183       "html_filename": "AbstractContainer2.html",
 184       "href": "AbstractContainer2.html#Ext-layout-container-AbstractContainer-method-getRenderTarget",
 185       "shortDoc": "Returns the element into which rendering must take place. Defaults to the owner Container's Ext.AbstractComponent.tar..."
 186     },
 187     {
 188       "tagname": "method",
 189       "name": "getTarget",
 190       "member": "Ext.layout.container.AbstractContainer",
 191       "doc": "<p>Returns the owner component's resize element.</p>\n",
 192       "params": [
 193
 194       ],
 195       "return": {
 196         "type": "Ext.core.Element",
 197         "doc": "\n"
 198       },
 199       "private": false,
 200       "static": false,
 201       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/layout/container/AbstractContainer.js",
 202       "linenr": 99,
 203       "html_filename": "AbstractContainer2.html",
 204       "href": "AbstractContainer2.html#Ext-layout-container-AbstractContainer-method-getTarget",
 205       "shortDoc": "<p>Returns the owner component's resize element.</p>\n"
 206     },
 207     {
 208       "tagname": "method",
 209       "name": "updateChildBoxes",
 210       "member": "Ext.layout.container.Box",
 211       "doc": "<p>Resizes and repositions each child component</p>\n",
 212       "params": [
 213         {
 214           "type": "Array",
 215           "name": "boxes",
 216           "doc": "<p>The box measurements</p>\n",
 217           "optional": false
 218         }
 219       ],
 220       "return": {
 221         "type": "void",
 222         "doc": "\n"
 223       },
 224       "private": false,
 225       "static": false,
 226       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/container/Box.js",
 227       "linenr": 580,
 228       "html_filename": "Box.html",
 229       "href": "Box.html#Ext-layout-container-Box-method-updateChildBoxes",
 230       "shortDoc": "<p>Resizes and repositions each child component</p>\n"
 231     }
 232   ],
 233   "property": [
 234
 235   ],
 236   "event": [
 237
 238   ],
 239   "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/ColumnLayout.js",
 240   "linenr": 1,
 241   "html_filename": "ColumnLayout.html",
 242   "href": "ColumnLayout.html#Ext-grid-ColumnLayout",
 243   "cssVar": [
 244
 245   ],
 246   "cssMixin": [
 247
 248   ],
 249   "component": false,
 250   "superclasses": [
 251     "Ext.layout.Layout",
 252     "Ext.layout.container.AbstractContainer",
 253     "Ext.layout.container.Container",
 254     "Ext.layout.container.Box",
 255     "Ext.layout.container.HBox"
 256   ],
 257   "subclasses": [
 258
 259   ],
 260   "mixedInto": [
 261
 262   ],
 263   "allMixins": [
 264
 265   ]
 266 });