Upgrade to ExtJS 4.0.2 - Released 06/09/2011
[extjs.git] / docs / output / Ext.layout.container.Absolute.js
1 Ext.data.JsonP.Ext_layout_container_Absolute({
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": "Anchor.html#Ext-layout-container-Anchor-cfg-anchor",
16         "shortDoc": "This configuation option is to be applied to child items of a container managed by\nthis layout (ie. ...",
17         "static": false,
18         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/layout/container/Anchor.js",
19         "private": false,
20         "name": "anchor",
21         "owner": "Ext.layout.container.Anchor",
22         "doc": "<p>This configuation option is to be applied to <b>child <tt>items</tt></b> of a container managed by\nthis layout (ie. configured with <tt>layout:'anchor'</tt>).</p>\n\n\n<br/>\n\n\n\n\n<p>This value is what tells the layout how an item should be anchored to the container. <tt>items</tt>\nadded to an AnchorLayout accept an anchoring-specific config property of <b>anchor</b> which is a string\ncontaining two values: the horizontal anchor value and the vertical anchor value (for example, '100% 50%').\nThe following types of anchor values are supported:<div class=\"mdetail-params\"><ul>\n\n<li><b>Percentage</b> : Any value between 1 and 100, expressed as a percentage.<div class=\"sub-desc\">\nThe first anchor is the percentage width that the item should take up within the container, and the\nsecond is the percentage height.  For example:\n<pre><code>// two values specified\nanchor: '100% 50%' // render item complete width of the container and\n                   // 1/2 height of the container\n// one value specified\nanchor: '100%'     // the width value; the height will default to auto\n</code></pre></div></li>\n\n<li><b>Offsets</b> : Any positive or negative integer value.<div class=\"sub-desc\">\nThis is a raw adjustment where the first anchor is the offset from the right edge of the container,\nand the second is the offset from the bottom edge. For example:\n<pre><code>// two values specified\nanchor: '-50 -100' // render item the complete width of the container\n                   // minus 50 pixels and\n                   // the complete height minus 100 pixels.\n// one value specified\nanchor: '-50'      // anchor value is assumed to be the right offset value\n                   // bottom offset will default to 0\n</code></pre></div></li>\n\n<li><b>Sides</b> : Valid values are <tt>'right'</tt> (or <tt>'r'</tt>) and <tt>'bottom'</tt>\n(or <tt>'b'</tt>).<div class=\"sub-desc\">\nEither the container must have a fixed size or an anchorSize config value defined at render time in\norder for these to have any effect.</div></li>\n\n<li><b>Mixed</b> : <div class=\"sub-desc\">\nAnchor values can also be mixed as needed.  For example, to render the width offset from the container\nright edge by 50 pixels and 75% of the container's height use:\n<pre><code>anchor: '-50 75%'\n</code></pre></div></li>\n\n\n</ul></div>\n\n",
23         "linenr": 54,
24         "html_filename": "Anchor.html"
25       },
26       {
27         "type": "Boolean",
28         "deprecated": null,
29         "alias": null,
30         "protected": false,
31         "tagname": "cfg",
32         "href": "AbstractContainer.html#Ext-layout-container-AbstractContainer-cfg-bindToOwnerCtComponent",
33         "static": false,
34         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/layout/container/AbstractContainer.js",
35         "private": false,
36         "name": "bindToOwnerCtComponent",
37         "owner": "Ext.layout.container.AbstractContainer",
38         "doc": "<p>Flag to notify the ownerCt Component on afterLayout of a change</p>\n",
39         "linenr": 17,
40         "html_filename": "AbstractContainer.html"
41       },
42       {
43         "type": "Boolean",
44         "deprecated": null,
45         "alias": null,
46         "protected": false,
47         "tagname": "cfg",
48         "href": "AbstractContainer.html#Ext-layout-container-AbstractContainer-cfg-bindToOwnerCtContainer",
49         "static": false,
50         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/layout/container/AbstractContainer.js",
51         "private": false,
52         "name": "bindToOwnerCtContainer",
53         "owner": "Ext.layout.container.AbstractContainer",
54         "doc": "<p>Flag to notify the ownerCt Container on afterLayout of a change</p>\n",
55         "linenr": 23,
56         "html_filename": "AbstractContainer.html"
57       },
58       {
59         "type": "String",
60         "deprecated": null,
61         "alias": null,
62         "protected": false,
63         "tagname": "cfg",
64         "href": "Anchor.html#Ext-layout-container-Anchor-cfg-defaultAnchor",
65         "shortDoc": "Default anchor for all child container items applied if no anchor or specific width is set on the child item. ...",
66         "static": false,
67         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/layout/container/Anchor.js",
68         "private": false,
69         "name": "defaultAnchor",
70         "owner": "Ext.layout.container.Anchor",
71         "doc": "<p>Default anchor for all child <b>container</b> items applied if no anchor or specific width is set on the child item.  Defaults to '100%'.</p>\n",
72         "linenr": 104,
73         "html_filename": "Anchor.html"
74       },
75       {
76         "type": "String",
77         "deprecated": null,
78         "alias": null,
79         "protected": false,
80         "tagname": "cfg",
81         "href": "AbstractContainer.html#Ext-layout-container-AbstractContainer-cfg-itemCls",
82         "shortDoc": "An optional extra CSS class that will be added to the container. ...",
83         "static": false,
84         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/layout/container/AbstractContainer.js",
85         "private": false,
86         "name": "itemCls",
87         "owner": "Ext.layout.container.AbstractContainer",
88         "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",
89         "linenr": 29,
90         "html_filename": "AbstractContainer.html"
91       }
92     ],
93     "method": [
94       {
95         "deprecated": null,
96         "alias": null,
97         "protected": false,
98         "tagname": "method",
99         "href": "AbstractContainer.html#Ext-layout-container-AbstractContainer-method-getLayoutItems",
100         "shortDoc": "Returns an array of child components either for a render phase (Performed in the beforeLayout method of the layout's\n...",
101         "static": false,
102         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/layout/container/AbstractContainer.js",
103         "private": false,
104         "params": [
105
106         ],
107         "name": "getLayoutItems",
108         "owner": "Ext.layout.container.AbstractContainer",
109         "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",
110         "linenr": 49,
111         "return": {
112           "type": "Array",
113           "doc": "<p>of child components</p>\n"
114         },
115         "html_filename": "AbstractContainer.html"
116       },
117       {
118         "deprecated": null,
119         "alias": null,
120         "protected": false,
121         "tagname": "method",
122         "href": "AbstractContainer.html#Ext-layout-container-AbstractContainer-method-getRenderTarget",
123         "shortDoc": "Returns the element into which rendering must take place. ...",
124         "static": false,
125         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/layout/container/AbstractContainer.js",
126         "private": false,
127         "params": [
128
129         ],
130         "name": "getRenderTarget",
131         "owner": "Ext.layout.container.AbstractContainer",
132         "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",
133         "linenr": 68,
134         "return": {
135           "type": "Ext.core.Element",
136           "doc": "\n"
137         },
138         "html_filename": "AbstractContainer.html"
139       },
140       {
141         "deprecated": null,
142         "alias": null,
143         "protected": true,
144         "tagname": "method",
145         "href": "Container.html#Ext-layout-container-Container-method-getRenderedItems",
146         "shortDoc": "Returns all items that are rendered ...",
147         "static": false,
148         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/layout/container/Container.js",
149         "private": false,
150         "params": [
151
152         ],
153         "name": "getRenderedItems",
154         "owner": "Ext.layout.container.Container",
155         "doc": "<p>Returns all items that are rendered</p>\n",
156         "linenr": 53,
157         "return": {
158           "type": "Array",
159           "doc": "<p>All matching items</p>\n"
160         },
161         "html_filename": "Container.html"
162       },
163       {
164         "deprecated": null,
165         "alias": null,
166         "protected": false,
167         "tagname": "method",
168         "href": "AbstractContainer.html#Ext-layout-container-AbstractContainer-method-getTarget",
169         "shortDoc": "Returns the owner component's resize element. ...",
170         "static": false,
171         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/layout/container/AbstractContainer.js",
172         "private": false,
173         "params": [
174
175         ],
176         "name": "getTarget",
177         "owner": "Ext.layout.container.AbstractContainer",
178         "doc": "<p>Returns the owner component's resize element.</p>\n",
179         "linenr": 61,
180         "return": {
181           "type": "Ext.core.Element",
182           "doc": "\n"
183         },
184         "html_filename": "AbstractContainer.html"
185       },
186       {
187         "deprecated": null,
188         "alias": null,
189         "protected": true,
190         "tagname": "method",
191         "href": "Container.html#Ext-layout-container-Container-method-getVisibleItems",
192         "shortDoc": "Returns all items that are both rendered and visible ...",
193         "static": false,
194         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/layout/container/Container.js",
195         "private": false,
196         "params": [
197
198         ],
199         "name": "getVisibleItems",
200         "owner": "Ext.layout.container.Container",
201         "doc": "<p>Returns all items that are both rendered and visible</p>\n",
202         "linenr": 76,
203         "return": {
204           "type": "Array",
205           "doc": "<p>All matching items</p>\n"
206         },
207         "html_filename": "Container.html"
208       }
209     ],
210     "property": [
211
212     ],
213     "cssVar": [
214
215     ],
216     "cssMixin": [
217
218     ],
219     "event": [
220
221     ]
222   },
223   "singleton": false,
224   "alias": null,
225   "superclasses": [
226     "Ext.layout.Layout",
227     "Ext.layout.container.AbstractContainer",
228     "Ext.layout.container.Container",
229     "Ext.layout.container.Anchor"
230   ],
231   "protected": false,
232   "tagname": "class",
233   "mixins": [
234
235   ],
236   "href": "Absolute.html#Ext-layout-container-Absolute",
237   "subclasses": [
238
239   ],
240   "static": false,
241   "author": null,
242   "component": false,
243   "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/layout/container/Absolute.js",
244   "private": false,
245   "alternateClassNames": [
246     "Ext.layout.AbsoluteLayout"
247   ],
248   "name": "Ext.layout.container.Absolute",
249   "doc": "<p>This is a layout that inherits the anchoring of <b><a href=\"#/api/Ext.layout.container.Anchor\" rel=\"Ext.layout.container.Anchor\" class=\"docClass\">Ext.layout.container.Anchor</a></b> and adds the\nability for x/y positioning using the standard x and y component config options.</p>\n\n\n<p>This class is intended to be extended or created via the <tt><b><a href=\"#/api/Ext.container.Container-cfg-layout\" rel=\"Ext.container.Container-cfg-layout\" class=\"docClass\">layout</a></b></tt>\nconfiguration property.  See <tt><b><a href=\"#/api/Ext.container.Container-cfg-layout\" rel=\"Ext.container.Container-cfg-layout\" class=\"docClass\">Ext.container.Container.layout</a></b></tt> for additional details.</p>\n\n\n<p><p><img src=\"doc-resources/Ext.layout.container.Absolute/Ext.layout.container.Absolute.png\" alt=\"Ext.layout.container.Absolute container layout\"></p></p>\n\n<p>Example usage:</p>\n\n\n<pre><code>Ext.create('Ext.form.Panel', {\n    title: 'Absolute Layout',\n    width: 300,\n    height: 275,\n    layout:'absolute',\n    layoutConfig: {\n        // layout-specific configs go here\n        //itemCls: 'x-abs-layout-item',\n    },\n    url:'save-form.php',\n    defaultType: 'textfield',\n    items: [{\n        x: 10,\n        y: 10,\n        xtype:'label',\n        text: 'Send To:'\n    },{\n        x: 80,\n        y: 10,\n        name: 'to',\n        anchor:'90%'  // anchor width by percentage\n    },{\n        x: 10,\n        y: 40,\n        xtype:'label',\n        text: 'Subject:'\n    },{\n        x: 80,\n        y: 40,\n        name: 'subject',\n        anchor: '90%'  // anchor width by percentage\n    },{\n        x:0,\n        y: 80,\n        xtype: 'textareafield',\n        name: 'msg',\n        anchor: '100% 100%'  // anchor width and height\n    }],\n    renderTo: Ext.getBody()\n});\n</code></pre>\n\n",
250   "mixedInto": [
251
252   ],
253   "linenr": 1,
254   "xtypes": [
255
256   ],
257   "html_filename": "Absolute.html",
258   "extends": "Ext.layout.container.Anchor"
259 });