source: trunk/web/addons/job_monarch/lib/extjs/docs/output/Ext.layout.BorderLayout.Region.html @ 619

Last change on this file since 619 was 619, checked in by ramonb, 15 years ago

lib/:

  • added new AJAX dependancies: ExtJS, pChart, Lightbox2
File size: 23.0 KB
Line 
1        <div class="body-wrap">
2        <div class="top-tools">
3            <a class="inner-link" href="#Ext.layout.BorderLayout.Region-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
4            <a class="inner-link" href="#Ext.layout.BorderLayout.Region-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
5            <a class="inner-link" href="#Ext.layout.BorderLayout.Region-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
6                            <a class="inner-link" href="#Ext.layout.BorderLayout.Region-configs"><img src="../resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>
7                        <a class="bookmark" href="../docs/?class=Ext.layout.BorderLayout.Region"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
8        </div>
9                <h1>Class Ext.layout.BorderLayout.Region</h1>
10        <table cellspacing="0">
11            <tr><td class="label">Package:</td><td class="hd-info">Ext.layout</td></tr>
12            <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/BorderLayout.js" target="_blank">BorderLayout.js</a></td></tr>
13            <tr><td class="label">Class:</td><td class="hd-info">BorderLayout.Region</td></tr>
14                        <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>
15                                    <tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr>
16                    </table>
17        <div class="description">
18            This is a region of a BorderLayout that acts as a subcontainer within the layout.  Each region has its own
19layout that is independent of other regions and the containing BorderLayout, and can be any of the valid
20Ext layout types.  Region size is managed automatically and cannot be changed by the user -- for resizable
21regions, see <a ext:cls="Ext.layout.BorderLayout.SplitRegion" href="output/Ext.layout.BorderLayout.SplitRegion.html">Ext.layout.BorderLayout.SplitRegion</a>.        </div>
22       
23        <div class="hr"></div>
24                <a id="Ext.layout.BorderLayout.Region-configs"></a>
25        <h2>Config Options</h2>
26        <table cellspacing="0" class="member-table">
27            <tr>
28                <th class="sig-header" colspan="2">Config Options</th>
29                <th class="msource-header">Defined By</th>
30            </tr>
31                <tr class="config-row expandable">
32        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
33        <td class="sig">
34        <a id="Ext.layout.BorderLayout.Region-animFloat"></a>
35            <b>animFloat</b> : Boolean            <div class="mdesc">
36                        <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>
37            <div class="long">
38                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>
39                        </div>
40        </td>
41        <td class="msource">BorderLayout.Region</td>
42    </tr>
43        <tr class="config-row alt expandable">
44        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
45        <td class="sig">
46        <a id="Ext.layout.BorderLayout.Region-autoHide"></a>
47            <b>autoHide</b> : Boolean            <div class="mdesc">
48                        <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>
49            <div class="long">
50                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>
51                        </div>
52        </td>
53        <td class="msource">BorderLayout.Region</td>
54    </tr>
55        <tr class="config-row expandable">
56        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
57        <td class="sig">
58        <a id="Ext.layout.BorderLayout.Region-cmargins"></a>
59            <b>cmargins</b> : Object            <div class="mdesc">
60                        <div class="short">An object containing margins to apply to the region when in the collapsed state in the format:{
61    top: (top margin)...</div>
62            <div class="long">
63                An object containing margins to apply to the region when in the collapsed state in the format:<pre><code>{
64    top: (top margin),
65    right: (right margin),
66    bottom: (bottom margin)
67    left: (left margin),
68}</code></pre> <p>May also be a string containing space-separated, numeric margin values. The order of the sides associated with each value matches the way CSS processes margin values.</p> <p><ul> <li>If there is only one value, it applies to all sides.</li> <li>If there are two values, the top and bottom borders are set to the first value and the right and left are set to the second.</li> <li>If there are three values, the top is set to the first value, the left and right are set to the second, and the bottom is set to the third.</li> <li>If there are four values, they apply to the top, right, bottom, and left, respectively.</li> </ul></p>            </div>
69                        </div>
70        </td>
71        <td class="msource">BorderLayout.Region</td>
72    </tr>
73        <tr class="config-row alt expandable">
74        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
75        <td class="sig">
76        <a id="Ext.layout.BorderLayout.Region-collapseMode"></a>
77            <b>collapseMode</b> : String            <div class="mdesc">
78                        <div class="short">By default, collapsible regions are collapsed by clicking the expand/collapse tool button that renders into the regio...</div>
79            <div class="long">
80                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>
81                        </div>
82        </td>
83        <td class="msource">BorderLayout.Region</td>
84    </tr>
85        <tr class="config-row expandable">
86        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
87        <td class="sig">
88        <a id="Ext.layout.BorderLayout.Region-collapsed"></a>
89            <b>collapsed</b> : Boolean            <div class="mdesc">
90                        <div class="short">By default, collapsible regions will be visible when rendered. Set the collapsed config to true to render the region ...</div>
91            <div class="long">
92                By default, collapsible regions will be visible when rendered. Set the collapsed config to true to render the region as collapsed.            </div>
93                        </div>
94        </td>
95        <td class="msource">BorderLayout.Region</td>
96    </tr>
97        <tr class="config-row alt expandable">
98        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
99        <td class="sig">
100        <a id="Ext.layout.BorderLayout.Region-collapsible"></a>
101            <b>collapsible</b> : Boolean            <div class="mdesc">
102                        <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>
103            <div class="long">
104                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>
105                        </div>
106        </td>
107        <td class="msource">BorderLayout.Region</td>
108    </tr>
109        <tr class="config-row expandable">
110        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
111        <td class="sig">
112        <a id="Ext.layout.BorderLayout.Region-floatable"></a>
113            <b>floatable</b> : Boolean            <div class="mdesc">
114                        <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>
115            <div class="long">
116                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>
117                        </div>
118        </td>
119        <td class="msource">BorderLayout.Region</td>
120    </tr>
121        <tr class="config-row alt expandable">
122        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
123        <td class="sig">
124        <a id="Ext.layout.BorderLayout.Region-margins"></a>
125            <b>margins</b> : Object            <div class="mdesc">
126                        <div class="short">An object containing margins to apply to the region when in the expanded state in the format:{
127    top: (top margin),...</div>
128            <div class="long">
129                An object containing margins to apply to the region when in the expanded state in the format:<pre><code>{
130    top: (top margin),
131    right: (right margin),
132    bottom: (bottom margin)
133    left: (left margin),
134}</code></pre> <p>May also be a string containing space-separated, numeric margin values. The order of the sides associated with each value matches the way CSS processes margin values:</p> <p><ul> <li>If there is only one value, it applies to all sides.</li> <li>If there are two values, the top and bottom borders are set to the first value and the right and left are set to the second.</li> <li>If there are three values, the top is set to the first value, the left and right are set to the second, and the bottom is set to the third.</li> <li>If there are four values, they apply to the top, right, bottom, and left, respectively.</li> </ul></p>            </div>
135                        </div>
136        </td>
137        <td class="msource">BorderLayout.Region</td>
138    </tr>
139        <tr class="config-row">
140        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
141        <td class="sig">
142        <a id="Ext.layout.BorderLayout.Region-minHeight"></a>
143            <b>minHeight</b> : Number            <div class="mdesc">
144                            The minimum allowable height in pixels for this region (defaults to 50)                        </div>
145        </td>
146        <td class="msource">BorderLayout.Region</td>
147    </tr>
148        <tr class="config-row alt">
149        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
150        <td class="sig">
151        <a id="Ext.layout.BorderLayout.Region-minWidth"></a>
152            <b>minWidth</b> : Number            <div class="mdesc">
153                            The minimum allowable width in pixels for this region (defaults to 50)                        </div>
154        </td>
155        <td class="msource">BorderLayout.Region</td>
156    </tr>
157        <tr class="config-row expandable">
158        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
159        <td class="sig">
160        <a id="Ext.layout.BorderLayout.Region-split"></a>
161            <b>split</b> : Boolean            <div class="mdesc">
162                        <div class="short">True to display a Ext.SplitBar between this region and its neighbor, allowing the user to resize the regions dynamica...</div>
163            <div class="long">
164                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 minSize and maxSize for the BoxComponent representing the region. These are not native configs of BoxComponent, and are used only by this class.            </div>
165                        </div>
166        </td>
167        <td class="msource">BorderLayout.Region</td>
168    </tr>
169            </table>
170                <a id="Ext.layout.BorderLayout.Region-props"></a>
171        <h2>Public Properties</h2>
172                <table cellspacing="0" class="member-table">
173            <tr>
174                <th class="sig-header" colspan="2">Property</th>
175                <th class="msource-header">Defined By</th>
176            </tr>
177                <tr class="property-row">
178        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
179        <td class="sig">
180        <a id="Ext.layout.BorderLayout.Region-isCollapsed"></a>
181            <b>isCollapsed</b> : Boolean            <div class="mdesc">
182                            True if this region is collapsed. Read-only.                        </div>
183        </td>
184        <td class="msource">BorderLayout.Region</td>
185    </tr>
186        <tr class="property-row alt">
187        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
188        <td class="sig">
189        <a id="Ext.layout.BorderLayout.Region-layout"></a>
190            <b>layout</b> : Layout            <div class="mdesc">
191                           
192This region's layout.  Read-only.                        </div>
193        </td>
194        <td class="msource">BorderLayout.Region</td>
195    </tr>
196        <tr class="property-row">
197        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
198        <td class="sig">
199        <a id="Ext.layout.BorderLayout.Region-panel"></a>
200            <b>panel</b> : Ext.Panel            <div class="mdesc">
201                            This region's panel.  Read-only.                        </div>
202        </td>
203        <td class="msource">BorderLayout.Region</td>
204    </tr>
205        <tr class="property-row alt">
206        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
207        <td class="sig">
208        <a id="Ext.layout.BorderLayout.Region-position"></a>
209            <b>position</b> : String            <div class="mdesc">
210                           
211This region's layout position (north, south, east, west or center).  Read-only.                        </div>
212        </td>
213        <td class="msource">BorderLayout.Region</td>
214    </tr>
215            </table>
216                <a id="Ext.layout.BorderLayout.Region-methods"></a>
217        <h2>Public Methods</h2>
218                <table cellspacing="0" class="member-table">
219            <tr>
220                <th class="sig-header" colspan="2">Method</th>
221                <th class="msource-header">Defined By</th>
222            </tr>
223                <tr class="method-row expandable">
224        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
225        <td class="sig">
226        <a id="Ext.layout.BorderLayout.Region-BorderLayout.Region"></a>
227            <b>BorderLayout.Region</b>(&nbsp;<code>Layout layout</code>, <code>Object config</code>, <code>String position</code>&nbsp;)            <div class="mdesc">
228                        <div class="short">Create a new Region.</div>
229            <div class="long">
230                Create a new Region.    <div class="mdetail-params">
231        <strong>Parameters:</strong>
232        <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
233BorderLayout must have a center region for the primary content -- all other regions are optional.</div></li>        </ul>
234        <strong>Returns:</strong>
235        <ul>
236            <li><code></code></li>
237        </ul>
238    </div>
239                </div>
240                        </div>
241        </td>
242        <td class="msource">BorderLayout.Region</td>
243    </tr>
244        <tr class="method-row alt expandable">
245        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
246        <td class="sig">
247        <a id="Ext.layout.BorderLayout.Region-getMargins"></a>
248            <b>getMargins</b>() : Object            <div class="mdesc">
249                        <div class="short">Returns the current margins for this region.  If the region is collapsed, the cmargins (collapsed
250margins) value will...</div>
251            <div class="long">
252                Returns the current margins for this region.  If the region is collapsed, the cmargins (collapsed
253margins) value will be returned, otherwise the margins value will be returned.    <div class="mdetail-params">
254        <strong>Parameters:</strong>
255        <ul><li>None.</li>        </ul>
256        <strong>Returns:</strong>
257        <ul>
258            <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>
259        </ul>
260    </div>
261                </div>
262                        </div>
263        </td>
264        <td class="msource">BorderLayout.Region</td>
265    </tr>
266        <tr class="method-row expandable">
267        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
268        <td class="sig">
269        <a id="Ext.layout.BorderLayout.Region-getMinHeight"></a>
270            <b>getMinHeight</b>() : Number            <div class="mdesc">
271                        <div class="short">Returns the minimum allowable height for this region.</div>
272            <div class="long">
273                Returns the minimum allowable height for this region.    <div class="mdetail-params">
274        <strong>Parameters:</strong>
275        <ul><li>None.</li>        </ul>
276        <strong>Returns:</strong>
277        <ul>
278            <li><code>Number</code><div class="sub-desc">The minimum height</div></li>
279        </ul>
280    </div>
281                </div>
282                        </div>
283        </td>
284        <td class="msource">BorderLayout.Region</td>
285    </tr>
286        <tr class="method-row alt expandable">
287        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
288        <td class="sig">
289        <a id="Ext.layout.BorderLayout.Region-getMinWidth"></a>
290            <b>getMinWidth</b>() : Number            <div class="mdesc">
291                        <div class="short">Returns the minimum allowable width for this region.</div>
292            <div class="long">
293                Returns the minimum allowable width for this region.    <div class="mdetail-params">
294        <strong>Parameters:</strong>
295        <ul><li>None.</li>        </ul>
296        <strong>Returns:</strong>
297        <ul>
298            <li><code>Number</code><div class="sub-desc">The minimum width</div></li>
299        </ul>
300    </div>
301                </div>
302                        </div>
303        </td>
304        <td class="msource">BorderLayout.Region</td>
305    </tr>
306        <tr class="method-row expandable">
307        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
308        <td class="sig">
309        <a id="Ext.layout.BorderLayout.Region-getSize"></a>
310            <b>getSize</b>() : Object            <div class="mdesc">
311                        <div class="short">Returns the current size of this region.  If the region is collapsed, the size of the collapsedEl will
312be returned, o...</div>
313            <div class="long">
314                Returns the current size of this region.  If the region is collapsed, the size of the collapsedEl will
315be returned, otherwise the size of the region's panel will be returned.    <div class="mdetail-params">
316        <strong>Parameters:</strong>
317        <ul><li>None.</li>        </ul>
318        <strong>Returns:</strong>
319        <ul>
320            <li><code>Object</code><div class="sub-desc">An object containing the element's size: {width: (element width), height: (element height)}</div></li>
321        </ul>
322    </div>
323                </div>
324                        </div>
325        </td>
326        <td class="msource">BorderLayout.Region</td>
327    </tr>
328        <tr class="method-row alt expandable">
329        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
330        <td class="sig">
331        <a id="Ext.layout.BorderLayout.Region-isVisible"></a>
332            <b>isVisible</b>() : Boolean            <div class="mdesc">
333                        <div class="short">True if this region is currently visible, else false.</div>
334            <div class="long">
335                True if this region is currently visible, else false.    <div class="mdetail-params">
336        <strong>Parameters:</strong>
337        <ul><li>None.</li>        </ul>
338        <strong>Returns:</strong>
339        <ul>
340            <li><code>Boolean</code></li>
341        </ul>
342    </div>
343                </div>
344                        </div>
345        </td>
346        <td class="msource">BorderLayout.Region</td>
347    </tr>
348        <tr class="method-row expandable">
349        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
350        <td class="sig">
351        <a id="Ext.layout.BorderLayout.Region-setPanel"></a>
352            <b>setPanel</b>(&nbsp;<code>Ext.Panel panel</code>&nbsp;) : void            <div class="mdesc">
353                        <div class="short">Sets the specified panel as the container element for this region.</div>
354            <div class="long">
355                Sets the specified panel as the container element for this region.    <div class="mdetail-params">
356        <strong>Parameters:</strong>
357        <ul><li><code>panel</code> : Ext.Panel<div class="sub-desc">The new panel</div></li>        </ul>
358        <strong>Returns:</strong>
359        <ul>
360            <li><code>void</code></li>
361        </ul>
362    </div>
363                </div>
364                        </div>
365        </td>
366        <td class="msource">BorderLayout.Region</td>
367    </tr>
368            </table>
369                <a id="Ext.layout.BorderLayout.Region-events"></a>
370        <h2>Public Events</h2>
371        <div class="no-members">This class has no public events.</div>
372        </div>
Note: See TracBrowser for help on using the repository browser.