Ext.layout.BorderLayout.Region.html
20 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
<div class="body-wrap">
<div class="top-tools">
<a class="inner-link" href="#Ext.layout.BorderLayout.Region-props"><img src="../resources/images/default/s_wev8.gif" class="item-icon icon-prop">Properties</a>
<a class="inner-link" href="#Ext.layout.BorderLayout.Region-methods"><img src="../resources/images/default/s_wev8.gif" class="item-icon icon-method">Methods</a>
<a class="inner-link" href="#Ext.layout.BorderLayout.Region-events"><img src="../resources/images/default/s_wev8.gif" class="item-icon icon-event">Events</a>
<a class="inner-link" href="#Ext.layout.BorderLayout.Region-configs"><img src="../resources/images/default/s_wev8.gif" class="item-icon icon-config">Config Options</a>
<a class="bookmark" href="../docs/?class=Ext.layout.BorderLayout.Region"><img src="../resources/images/default/s_wev8.gif" class="item-icon icon-fav">Direct Link</a>
</div>
<h1>Class Ext.layout.BorderLayout.Region</h1>
<table cellspacing="0">
<tr><td class="label">Package:</td><td class="hd-info">Ext.layout</td></tr>
<tr><td class="label">Defined In:</td><td class="hd-info"><a href="../source/widgets/layout/BorderLayout_wev8.js" target="_blank">BorderLayout_wev8.js</a></td></tr>
<tr><td class="label">Class:</td><td class="hd-info">BorderLayout.Region</td></tr>
<tr><td class="label">Subclasses:</td><td class="hd-info"><a ext:cls="Ext.layout.BorderLayout.SplitRegion" href="output/Ext.layout.BorderLayout.SplitRegion.html">BorderLayout.SplitRegion</a></td></tr>
<tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr>
</table>
<div class="description">
This is a region of a BorderLayout that acts as a subcontainer within the layout. Each region has its own
layout that is independent of other regions and the containing BorderLayout, and can be any of the valid
Ext layout types. Region size is managed automatically and cannot be changed by the user -- for resizable
regions, see <a ext:cls="Ext.layout.BorderLayout.SplitRegion" href="output/Ext.layout.BorderLayout.SplitRegion.html">Ext.layout.BorderLayout.SplitRegion</a>. </div>
<div class="hr"></div>
<a id="Ext.layout.BorderLayout.Region-configs"></a>
<h2>Config Options</h2>
<table cellspacing="0" class="member-table">
<tr>
<th class="sig-header" colspan="2">Config Options</th>
<th class="msource-header">Defined By</th>
</tr>
<tr class="config-row expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.layout.BorderLayout.Region-animFloat"></a>
<b>animFloat</b> : Boolean <div class="mdesc">
<div class="short">When a collapsed region's bar is clicked, the region's panel will be displayed as a floated panel that will close aga...</div>
<div class="long">
When a collapsed region's bar is clicked, the region's panel will be displayed as a floated panel that will close again once the user mouses out of that panel (or clicks out if autoHide = false). Setting animFloat to false will prevent the open and close of these floated panels from being animated (defaults to true). </div>
</div>
</td>
<td class="msource">BorderLayout.Region</td>
</tr>
<tr class="config-row alt expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.layout.BorderLayout.Region-autoHide"></a>
<b>autoHide</b> : Boolean <div class="mdesc">
<div class="short">When a collapsed region's bar is clicked, the region's panel will be displayed as a floated panel. If autoHide is tru...</div>
<div class="long">
When a collapsed region's bar is clicked, the region's panel will be displayed as a floated panel. If autoHide is true, the panel will automatically hide after the user mouses out of the panel. If autoHide is false, the panel will continue to display until the user clicks outside of the panel (defaults to true). </div>
</div>
</td>
<td class="msource">BorderLayout.Region</td>
</tr>
<tr class="config-row expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.layout.BorderLayout.Region-cmargins"></a>
<b>cmargins</b> : Object <div class="mdesc">
<div class="short">An object containing margins to apply to the region's collapsed element in the format {left: (left margin), top: (top...</div>
<div class="long">
An object containing margins to apply to the region's collapsed element in the format {left: (left margin), top: (top margin), right: (right margin), bottom: (bottom margin)} </div>
</div>
</td>
<td class="msource">BorderLayout.Region</td>
</tr>
<tr class="config-row alt expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.layout.BorderLayout.Region-collapseMode"></a>
<b>collapseMode</b> : String <div class="mdesc">
<div class="short">By default, collapsible regions are collapsed by clicking the expand/collapse tool button that renders into the regio...</div>
<div class="long">
By default, collapsible regions are collapsed by clicking the expand/collapse tool button that renders into the region's title bar. Optionally, when collapseMode is set to 'mini' the region's split bar will also display a small collapse button in the center of the bar. In 'mini' mode the region will collapse to a thinner bar than in normal mode. By default collapseMode is undefined, and the only two supported values are undefined and 'mini'. Note that if a collapsible region does not have a title bar, then collapseMode must be set to 'mini' in order for the region to be collapsible by the user as the tool button will not be rendered. </div>
</div>
</td>
<td class="msource">BorderLayout.Region</td>
</tr>
<tr class="config-row expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.layout.BorderLayout.Region-collapsible"></a>
<b>collapsible</b> : Boolean <div class="mdesc">
<div class="short">True to allow the user to collapse this region (defaults to false). If true, an expand/collapse tool button will auto...</div>
<div class="long">
True to allow the user to collapse this region (defaults to false). If true, an expand/collapse tool button will automatically be rendered into the title bar of the region, otherwise the button will not be shown. Note that a title bar is required to display the toggle button -- if no region title is specified, the region will only be collapsible if <a ext:cls="Ext.layout.BorderLayout.Region" ext:member="collapseMode" href="output/Ext.layout.BorderLayout.Region.html#collapseMode">collapseMode</a> is set to 'mini'. </div>
</div>
</td>
<td class="msource">BorderLayout.Region</td>
</tr>
<tr class="config-row alt expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.layout.BorderLayout.Region-floatable"></a>
<b>floatable</b> : Boolean <div class="mdesc">
<div class="short">True to allow clicking a collapsed region's bar to display the region's panel floated above the layout, false to forc...</div>
<div class="long">
True to allow clicking a collapsed region's bar to display the region's panel floated above the layout, false to force the user to fully expand a collapsed region by clicking the expand button to see it again (defaults to true). </div>
</div>
</td>
<td class="msource">BorderLayout.Region</td>
</tr>
<tr class="config-row expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.layout.BorderLayout.Region-margins"></a>
<b>margins</b> : Object <div class="mdesc">
<div class="short">An object containing margins to apply to the region in the format {left: (left margin), top: (top margin), right: (ri...</div>
<div class="long">
An object containing margins to apply to the region in the format {left: (left margin), top: (top margin), right: (right margin), bottom: (bottom margin)} </div>
</div>
</td>
<td class="msource">BorderLayout.Region</td>
</tr>
<tr class="config-row alt">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.layout.BorderLayout.Region-minHeight"></a>
<b>minHeight</b> : Number <div class="mdesc">
The minimum allowable height in pixels for this region (defaults to 50) </div>
</td>
<td class="msource">BorderLayout.Region</td>
</tr>
<tr class="config-row">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.layout.BorderLayout.Region-minWidth"></a>
<b>minWidth</b> : Number <div class="mdesc">
The minimum allowable width in pixels for this region (defaults to 50) </div>
</td>
<td class="msource">BorderLayout.Region</td>
</tr>
<tr class="config-row alt expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.layout.BorderLayout.Region-split"></a>
<b>split</b> : Boolean <div class="mdesc">
<div class="short">True to display a Ext.SplitBar between this region and its neighbor, allowing the user to resize the regions dynamica...</div>
<div class="long">
True to display a <a ext:cls="Ext.SplitBar" href="output/Ext.SplitBar.html">Ext.SplitBar</a> between this region and its neighbor, allowing the user to resize the regions dynamically (defaults to false). When split = true, it is common to specify a <a ext:cls="Ext.layout.BorderLayout.Region" ext:member="minSize" href="output/Ext.layout.BorderLayout.Region.html#minSize">minSize</a> and <a ext:cls="Ext.layout.BorderLayout.Region" ext:member="maxSize" href="output/Ext.layout.BorderLayout.Region.html#maxSize">maxSize</a> for the region. </div>
</div>
</td>
<td class="msource">BorderLayout.Region</td>
</tr>
</table>
<a id="Ext.layout.BorderLayout.Region-props"></a>
<h2>Public Properties</h2>
<table cellspacing="0" class="member-table">
<tr>
<th class="sig-header" colspan="2">Property</th>
<th class="msource-header">Defined By</th>
</tr>
<tr class="property-row">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.layout.BorderLayout.Region-isCollapsed"></a>
<b>isCollapsed</b> : Boolean <div class="mdesc">
True if this region is collapsed. Read-only. </div>
</td>
<td class="msource">BorderLayout.Region</td>
</tr>
<tr class="property-row alt">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.layout.BorderLayout.Region-position"></a>
<b>position</b> : String <div class="mdesc">
This region's layout position (north, south, east, west or center). Read-only. </div>
</td>
<td class="msource">BorderLayout.Region</td>
</tr>
</table>
<a id="Ext.layout.BorderLayout.Region-methods"></a>
<h2>Public Methods</h2>
<table cellspacing="0" class="member-table">
<tr>
<th class="sig-header" colspan="2">Method</th>
<th class="msource-header">Defined By</th>
</tr>
<tr class="method-row expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.layout.BorderLayout.Region-BorderLayout.Region"></a>
<b>BorderLayout.Region</b>( <code>Layout layout</code>, <code>Object config</code>, <code>String position</code> ) <div class="mdesc">
<div class="short">Create a new Region.</div>
<div class="long">
Create a new Region. <div class="mdetail-params">
<strong>Parameters:</strong>
<ul><li><code>layout</code> : Layout<div class="sub-desc">Any valid Ext layout class</div></li><li><code>config</code> : Object<div class="sub-desc">The configuration options</div></li><li><code>position</code> : String<div class="sub-desc">The region position. Valid values are: north, south, east, west and center. Every
BorderLayout must have a center region for the primary content -- all other regions are optional.</div></li> </ul>
<strong>Returns:</strong>
<ul>
<li><code></code></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource">BorderLayout.Region</td>
</tr>
<tr class="method-row alt expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.layout.BorderLayout.Region-getMargins"></a>
<b>getMargins</b>() : Object <div class="mdesc">
<div class="short">Returns the current margins for this region. If the region is collapsed, the cmargins (collapsed
margins) value will...</div>
<div class="long">
Returns the current margins for this region. If the region is collapsed, the cmargins (collapsed
margins) value will be returned, otherwise the margins value will be returned. <div class="mdetail-params">
<strong>Parameters:</strong>
<ul><li>None.</li> </ul>
<strong>Returns:</strong>
<ul>
<li><code>Object</code><div class="sub-desc">An object containing the element's margins: {left: (left margin), top: (top margin), right: (right margin), bottom: (bottom margin)}</div></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource">BorderLayout.Region</td>
</tr>
<tr class="method-row expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.layout.BorderLayout.Region-getMinHeight"></a>
<b>getMinHeight</b>() : Number <div class="mdesc">
<div class="short">Returns the minimum allowable height for this region.</div>
<div class="long">
Returns the minimum allowable height for this region. <div class="mdetail-params">
<strong>Parameters:</strong>
<ul><li>None.</li> </ul>
<strong>Returns:</strong>
<ul>
<li><code>Number</code><div class="sub-desc">The minimum height</div></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource">BorderLayout.Region</td>
</tr>
<tr class="method-row alt expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.layout.BorderLayout.Region-getMinWidth"></a>
<b>getMinWidth</b>() : Number <div class="mdesc">
<div class="short">Returns the minimum allowable width for this region.</div>
<div class="long">
Returns the minimum allowable width for this region. <div class="mdetail-params">
<strong>Parameters:</strong>
<ul><li>None.</li> </ul>
<strong>Returns:</strong>
<ul>
<li><code>Number</code><div class="sub-desc">The minimum width</div></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource">BorderLayout.Region</td>
</tr>
<tr class="method-row expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.layout.BorderLayout.Region-getSize"></a>
<b>getSize</b>() : Object <div class="mdesc">
<div class="short">Returns the current size of this region. If the region is collapsed, the size of the collapsedEl will
be returned, o...</div>
<div class="long">
Returns the current size of this region. If the region is collapsed, the size of the collapsedEl will
be returned, otherwise the size of the region's panel will be returned. <div class="mdetail-params">
<strong>Parameters:</strong>
<ul><li>None.</li> </ul>
<strong>Returns:</strong>
<ul>
<li><code>Object</code><div class="sub-desc">An object containing the element's size: {width: (element width), height: (element height)}</div></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource">BorderLayout.Region</td>
</tr>
<tr class="method-row alt expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.layout.BorderLayout.Region-isVisible"></a>
<b>isVisible</b>() : Boolean <div class="mdesc">
<div class="short">True if this region is currently visible, else false.</div>
<div class="long">
True if this region is currently visible, else false. <div class="mdetail-params">
<strong>Parameters:</strong>
<ul><li>None.</li> </ul>
<strong>Returns:</strong>
<ul>
<li><code>Boolean</code></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource">BorderLayout.Region</td>
</tr>
<tr class="method-row expandable">
<td class="micon"><a class="exi" href="#expand"> </a></td>
<td class="sig">
<a id="Ext.layout.BorderLayout.Region-setPanel"></a>
<b>setPanel</b>( <code>Ext.Panel panel</code> ) : void <div class="mdesc">
<div class="short">Sets the specified panel as the container element for this region.</div>
<div class="long">
Sets the specified panel as the container element for this region. <div class="mdetail-params">
<strong>Parameters:</strong>
<ul><li><code>panel</code> : Ext.Panel<div class="sub-desc">The new panel</div></li> </ul>
<strong>Returns:</strong>
<ul>
<li><code>void</code></li>
</ul>
</div>
</div>
</div>
</td>
<td class="msource">BorderLayout.Region</td>
</tr>
</table>
<a id="Ext.layout.BorderLayout.Region-events"></a>
<h2>Public Events</h2>
<div class="no-members">This class has no public events.</div>
</div>