Upgrade to ExtJS 4.0.0 - Released 04/26/2011
[extjs.git] / docs / source / HBox.html
1 <!DOCTYPE html><html><head><title>Sencha Documentation Project</title><link rel="stylesheet" href="../reset.css" type="text/css"><link rel="stylesheet" href="../prettify.css" type="text/css"><link rel="stylesheet" href="../prettify_sa.css" type="text/css"><script type="text/javascript" src="../prettify.js"></script></head><body onload="prettyPrint()"><pre class="prettyprint"><pre><span id='Ext-layout.container.HBox'>/**
2 </span> * @class Ext.layout.container.HBox
3  * @extends Ext.layout.container.Box
4  * &lt;p&gt;A layout that arranges items horizontally across a Container. This layout optionally divides available horizontal
5  * space between child items containing a numeric &lt;code&gt;flex&lt;/code&gt; configuration.&lt;/p&gt;
6  * This layout may also be used to set the heights of child items by configuring it with the {@link #align} option.
7  * {@img Ext.layout.container.HBox/Ext.layout.container.HBox.png Ext.layout.container.HBox container layout}
8  * Example usage:
9     Ext.create('Ext.Panel', {
10         width: 500,
11         height: 300,
12         title: &quot;HBoxLayout Panel&quot;,
13         layout: {
14             type: 'hbox',
15             align: 'stretch'
16         },
17         renderTo: document.body,
18         items: [{
19             xtype: 'panel',
20             title: 'Inner Panel One',
21             flex: 2
22         },{
23             xtype: 'panel',
24             title: 'Inner Panel Two',
25             flex: 1
26         },{
27             xtype: 'panel',
28             title: 'Inner Panel Three',
29             flex: 1
30         }]
31     });
32  */
33 Ext.define('Ext.layout.container.HBox', {
34
35     /* Begin Definitions */
36
37     alias: ['layout.hbox'],
38     extend: 'Ext.layout.container.Box',
39     alternateClassName: 'Ext.layout.HBoxLayout',
40     
41     /* End Definitions */
42
43 <span id='Ext-layout.container.HBox-cfg-align'>    /**
44 </span>     * @cfg {String} align
45      * Controls how the child items of the container are aligned. Acceptable configuration values for this
46      * property are:
47      * &lt;div class=&quot;mdetail-params&quot;&gt;&lt;ul&gt;
48      * &lt;li&gt;&lt;b&gt;&lt;tt&gt;top&lt;/tt&gt;&lt;/b&gt; : &lt;b&gt;Default&lt;/b&gt;&lt;div class=&quot;sub-desc&quot;&gt;child items are aligned vertically
49      * at the &lt;b&gt;top&lt;/b&gt; of the container&lt;/div&gt;&lt;/li&gt;
50      * &lt;li&gt;&lt;b&gt;&lt;tt&gt;middle&lt;/tt&gt;&lt;/b&gt; : &lt;div class=&quot;sub-desc&quot;&gt;child items are aligned vertically in the
51      * &lt;b&gt;middle&lt;/b&gt; of the container&lt;/div&gt;&lt;/li&gt;
52      * &lt;li&gt;&lt;b&gt;&lt;tt&gt;stretch&lt;/tt&gt;&lt;/b&gt; : &lt;div class=&quot;sub-desc&quot;&gt;child items are stretched vertically to fill
53      * the height of the container&lt;/div&gt;&lt;/li&gt;
54      * &lt;li&gt;&lt;b&gt;&lt;tt&gt;stretchmax&lt;/tt&gt;&lt;/b&gt; : &lt;div class=&quot;sub-desc&quot;&gt;child items are stretched vertically to
55      * the height of the largest item.&lt;/div&gt;&lt;/li&gt;
56      * &lt;/ul&gt;&lt;/div&gt;
57      */
58     align: 'top', // top, middle, stretch, strechmax
59
60     //@private
61     alignCenteringString: 'middle',
62
63     type : 'hbox',
64
65     direction: 'horizontal',
66
67     // When creating an argument list to setSize, use this order
68     parallelSizeIndex: 0,
69     perpendicularSizeIndex: 1,
70
71     parallelPrefix: 'width',
72     parallelPrefixCap: 'Width',
73     parallelLT: 'l',
74     parallelRB: 'r',
75     parallelBefore: 'left',
76     parallelBeforeCap: 'Left',
77     parallelAfter: 'right',
78     parallelPosition: 'x',
79
80     perpendicularPrefix: 'height',
81     perpendicularPrefixCap: 'Height',
82     perpendicularLT: 't',
83     perpendicularRB: 'b',
84     perpendicularLeftTop: 'top',
85     perpendicularRightBottom: 'bottom',
86     perpendicularPosition: 'y'
87 });</pre></pre></body></html>