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

   1 Ext.data.JsonP.Ext_layout_container_Column({
   2   "allMixins": [
   3
   4   ],
   5   "deprecated": null,
   6   "docauthor": null,
   7   "members": {
   8     "cfg": [
   9       {
  10         "type": "Boolean",
  11         "deprecated": null,
  12         "alias": null,
  13         "protected": false,
  14         "tagname": "cfg",
  15         "href": "AbstractContainer.html#Ext-layout-container-AbstractContainer-cfg-bindToOwnerCtComponent",
  16         "static": false,
  17         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/layout/container/AbstractContainer.js",
  18         "private": false,
  19         "name": "bindToOwnerCtComponent",
  20         "owner": "Ext.layout.container.AbstractContainer",
  21         "doc": "<p>Flag to notify the ownerCt Component on afterLayout of a change</p>\n",
  22         "linenr": 17,
  23         "html_filename": "AbstractContainer.html"
  24       },
  25       {
  26         "type": "Boolean",
  27         "deprecated": null,
  28         "alias": null,
  29         "protected": false,
  30         "tagname": "cfg",
  31         "href": "AbstractContainer.html#Ext-layout-container-AbstractContainer-cfg-bindToOwnerCtContainer",
  32         "static": false,
  33         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/layout/container/AbstractContainer.js",
  34         "private": false,
  35         "name": "bindToOwnerCtContainer",
  36         "owner": "Ext.layout.container.AbstractContainer",
  37         "doc": "<p>Flag to notify the ownerCt Container on afterLayout of a change</p>\n",
  38         "linenr": 23,
  39         "html_filename": "AbstractContainer.html"
  40       },
  41       {
  42         "type": "String",
  43         "deprecated": null,
  44         "alias": null,
  45         "protected": false,
  46         "tagname": "cfg",
  47         "href": "AbstractContainer.html#Ext-layout-container-AbstractContainer-cfg-itemCls",
  48         "shortDoc": "An optional extra CSS class that will be added to the container. ...",
  49         "static": false,
  50         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/layout/container/AbstractContainer.js",
  51         "private": false,
  52         "name": "itemCls",
  53         "owner": "Ext.layout.container.AbstractContainer",
  54         "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",
  55         "linenr": 29,
  56         "html_filename": "AbstractContainer.html"
  57       }
  58     ],
  59     "method": [
  60       {
  61         "deprecated": null,
  62         "alias": null,
  63         "protected": false,
  64         "tagname": "method",
  65         "href": "AbstractContainer.html#Ext-layout-container-AbstractContainer-method-getLayoutItems",
  66         "shortDoc": "Returns an array of child components either for a render phase (Performed in the beforeLayout method of the layout's\n...",
  67         "static": false,
  68         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/layout/container/AbstractContainer.js",
  69         "private": false,
  70         "params": [
  71
  72         ],
  73         "name": "getLayoutItems",
  74         "owner": "Ext.layout.container.AbstractContainer",
  75         "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",
  76         "linenr": 49,
  77         "return": {
  78           "type": "Array",
  79           "doc": "<p>of child components</p>\n"
  80         },
  81         "html_filename": "AbstractContainer.html"
  82       },
  83       {
  84         "deprecated": null,
  85         "alias": null,
  86         "protected": false,
  87         "tagname": "method",
  88         "href": "AbstractContainer.html#Ext-layout-container-AbstractContainer-method-getRenderTarget",
  89         "shortDoc": "Returns the element into which rendering must take place. ...",
  90         "static": false,
  91         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/layout/container/AbstractContainer.js",
  92         "private": false,
  93         "params": [
  94
  95         ],
  96         "name": "getRenderTarget",
  97         "owner": "Ext.layout.container.AbstractContainer",
  98         "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",
  99         "linenr": 68,
 100         "return": {
 101           "type": "Ext.core.Element",
 102           "doc": "\n"
 103         },
 104         "html_filename": "AbstractContainer.html"
 105       },
 106       {
 107         "deprecated": null,
 108         "alias": null,
 109         "protected": true,
 110         "tagname": "method",
 111         "href": "Container.html#Ext-layout-container-Container-method-getRenderedItems",
 112         "shortDoc": "Returns all items that are rendered ...",
 113         "static": false,
 114         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/layout/container/Container.js",
 115         "private": false,
 116         "params": [
 117
 118         ],
 119         "name": "getRenderedItems",
 120         "owner": "Ext.layout.container.Container",
 121         "doc": "<p>Returns all items that are rendered</p>\n",
 122         "linenr": 53,
 123         "return": {
 124           "type": "Array",
 125           "doc": "<p>All matching items</p>\n"
 126         },
 127         "html_filename": "Container.html"
 128       },
 129       {
 130         "deprecated": null,
 131         "alias": null,
 132         "protected": false,
 133         "tagname": "method",
 134         "href": "AbstractContainer.html#Ext-layout-container-AbstractContainer-method-getTarget",
 135         "shortDoc": "Returns the owner component's resize element. ...",
 136         "static": false,
 137         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/layout/container/AbstractContainer.js",
 138         "private": false,
 139         "params": [
 140
 141         ],
 142         "name": "getTarget",
 143         "owner": "Ext.layout.container.AbstractContainer",
 144         "doc": "<p>Returns the owner component's resize element.</p>\n",
 145         "linenr": 61,
 146         "return": {
 147           "type": "Ext.core.Element",
 148           "doc": "\n"
 149         },
 150         "html_filename": "AbstractContainer.html"
 151       },
 152       {
 153         "deprecated": null,
 154         "alias": null,
 155         "protected": true,
 156         "tagname": "method",
 157         "href": "Container.html#Ext-layout-container-Container-method-getVisibleItems",
 158         "shortDoc": "Returns all items that are both rendered and visible ...",
 159         "static": false,
 160         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/layout/container/Container.js",
 161         "private": false,
 162         "params": [
 163
 164         ],
 165         "name": "getVisibleItems",
 166         "owner": "Ext.layout.container.Container",
 167         "doc": "<p>Returns all items that are both rendered and visible</p>\n",
 168         "linenr": 76,
 169         "return": {
 170           "type": "Array",
 171           "doc": "<p>All matching items</p>\n"
 172         },
 173         "html_filename": "Container.html"
 174       }
 175     ],
 176     "property": [
 177
 178     ],
 179     "cssVar": [
 180
 181     ],
 182     "cssMixin": [
 183
 184     ],
 185     "event": [
 186
 187     ]
 188   },
 189   "singleton": false,
 190   "alias": null,
 191   "superclasses": [
 192     "Ext.layout.Layout",
 193     "Ext.layout.container.AbstractContainer",
 194     "Ext.layout.container.Container",
 195     "Ext.layout.container.Auto"
 196   ],
 197   "protected": false,
 198   "tagname": "class",
 199   "mixins": [
 200
 201   ],
 202   "href": "Column.html#Ext-layout-container-Column",
 203   "subclasses": [
 204
 205   ],
 206   "static": false,
 207   "author": null,
 208   "component": false,
 209   "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/layout/container/Column.js",
 210   "private": false,
 211   "alternateClassNames": [
 212     "Ext.layout.ColumnLayout"
 213   ],
 214   "name": "Ext.layout.container.Column",
 215   "doc": "<p>This is the layout style of choice for creating structural layouts in a multi-column format where the width of\neach column can be specified as a percentage or fixed width, but the height is allowed to vary based on the content.\nThis class is intended to be extended or created via the layout:'column' <a href=\"#/api/Ext.container.Container-cfg-layout\" rel=\"Ext.container.Container-cfg-layout\" class=\"docClass\">Ext.container.Container.layout</a> config,\nand should generally not need to be created directly via the new keyword.</p>\n\n\n<p>ColumnLayout does not have any direct config options (other than inherited ones), but it does support a\nspecific config property of <b><tt>columnWidth</tt></b> that can be included in the config of any panel added to it.  The\nlayout will use the columnWidth (if present) or width of each panel during layout to determine how to size each panel.\nIf width or columnWidth is not specified for a given panel, its width will default to the panel's width (or auto).</p>\n\n\n<p>The width property is always evaluated as pixels, and must be a number greater than or equal to 1.\nThe columnWidth property is always evaluated as a percentage, and must be a decimal value greater than 0 and\nless than 1 (e.g., .25).</p>\n\n\n<p>The basic rules for specifying column widths are pretty simple.  The logic makes two passes through the\nset of contained panels.  During the first layout pass, all panels that either have a fixed width or none\nspecified (auto) are skipped, but their widths are subtracted from the overall container width.  During the second\npass, all panels with columnWidths are assigned pixel widths in proportion to their percentages based on\nthe total <b>remaining</b> container width.  In other words, percentage width panels are designed to fill the space\nleft over by all the fixed-width and/or auto-width panels.  Because of this, while you can specify any number of columns\nwith different percentages, the columnWidths must always add up to 1 (or 100%) when added together, otherwise your\nlayout may not render as expected.  \n<p><img src=\"doc-resources/Ext.layout.container.Column/Ext.layout.container.Column1.png\" alt=\"Ext.layout.container.Column container layout\"></p>\nExample usage:</p>\n\n\n<pre><code>    // All columns are percentages -- they must add up to 1\n    Ext.create('Ext.panel.Panel', {\n        title: 'Column Layout - Percentage Only',\n        width: 350,\n        height: 250,\n        layout:'column',\n        items: [{\n            title: 'Column 1',\n            columnWidth: .25\n        },{\n            title: 'Column 2',\n            columnWidth: .55\n        },{\n            title: 'Column 3',\n            columnWidth: .20\n        }],\n        renderTo: Ext.getBody()\n    }); \n\n// <p><img src=\"doc-resources/Ext.layout.container.Column/Ext.layout.container.Column2.png\" alt=\"Ext.layout.container.Column container layout\"></p>\n// Mix of width and columnWidth -- all columnWidth values must add up\n// to 1. The first column will take up exactly 120px, and the last two\n// columns will fill the remaining container width.\n\n    Ext.create('Ext.Panel', {\n        title: 'Column Layout - Mixed',\n        width: 350,\n        height: 250,\n        layout:'column',\n        items: [{\n            title: 'Column 1',\n            width: 120\n        },{\n            title: 'Column 2',\n            columnWidth: .7\n        },{\n            title: 'Column 3',\n            columnWidth: .3\n        }],\n        renderTo: Ext.getBody()\n    }); \n</code></pre>\n\n",
 216   "mixedInto": [
 217
 218   ],
 219   "linenr": 1,
 220   "xtypes": [
 221
 222   ],
 223   "html_filename": "Column.html",
 224   "extends": "Ext.layout.container.Auto"
 225 });