commit extjs-2.2.1
[extjs.git] / docs / output / Ext.Toolbar.TextItem.html
1         <div class="body-wrap">
2         <div class="top-tools">
3             <a class="inner-link" href="#Ext.Toolbar.TextItem-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
4             <a class="inner-link" href="#Ext.Toolbar.TextItem-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
5             <a class="inner-link" href="#Ext.Toolbar.TextItem-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
6                         <a class="bookmark" href="../docs/?class=Ext.Toolbar.TextItem"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
7         </div>
8                 <div class="inheritance res-block">
9 <pre class="res-block-inner"><a ext:cls="Ext.Toolbar.Item" ext:member="" href="output/Ext.Toolbar.Item.html">Toolbar.Item</a>
10   <img src="resources/elbow-end.gif"/>Toolbar.TextItem</pre></div>
11                 <h1>Class Ext.Toolbar.TextItem</h1>
12         <table cellspacing="0">
13             <tr><td class="label">Package:</td><td class="hd-info">Ext</td></tr>
14             <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/Toolbar.js" target="_blank">Toolbar.js</a></td></tr>
15             <tr><td class="label">Class:</td><td class="hd-info">Toolbar.TextItem</td></tr>
16                                     <tr><td class="label">Extends:</td><td class="hd-info"><a ext:cls="Ext.Toolbar.Item" ext:member="" href="output/Ext.Toolbar.Item.html">Toolbar.Item</a></td></tr>
17                     </table>
18         <div class="description">
19             A simple class that renders text directly into a toolbar.
20 <pre><code>new Ext.Panel({
21         tbar : [
22                 {xtype: <em>'tbtext'</em>, text: <em>'Item 1'</em>} <i>// or simply <em>'Item 1'</em></i>
23         ]
24 });</code></pre>        </div>
25         
26         <div class="hr"></div>
27                 <a id="Ext.Toolbar.TextItem-props"></a>
28         <h2>Public Properties</h2>
29         <div class="no-members">This class has no public properties.</div>        <a id="Ext.Toolbar.TextItem-methods"></a>
30         <h2>Public Methods</h2>
31                 <table cellspacing="0" class="member-table">
32             <tr>
33                 <th class="sig-header" colspan="2">Method</th>
34                 <th class="msource-header">Defined By</th>
35             </tr>
36                 <tr class="method-row expandable">\r
37         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
38         <td class="sig">\r
39         <a id="Ext.Toolbar.TextItem-Toolbar.TextItem"></a>\r
40             <b>Toolbar.TextItem</b>(&nbsp;<code>String/Object text</code>&nbsp;)            <div class="mdesc">\r
41                         <div class="short">Creates a new TextItem</div>\r
42             <div class="long">\r
43                 Creates a new TextItem    <div class="mdetail-params">\r
44         <strong>Parameters:</strong>\r
45         <ul><li><code>text</code> : String/Object<div class="sub-desc">A text string, or a config object containing a <tt>text</tt> property</div></li>        </ul>\r
46         <strong>Returns:</strong>\r
47         <ul>\r
48             <li><code></code></li>\r
49         </ul>\r
50     </div>\r
51                 </div>\r
52                         </div>\r
53         </td>\r
54         <td class="msource">Toolbar.TextItem</td>\r
55     </tr>\r
56         <tr class="method-row inherited alt expandable">\r
57         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
58         <td class="sig">\r
59         <a id="Ext.Toolbar.TextItem-destroy"></a>\r
60             <b>destroy</b>() : void            <div class="mdesc">\r
61                         <div class="short">Removes and destroys this item.</div>\r
62             <div class="long">\r
63                 Removes and destroys this item.    <div class="mdetail-params">\r
64         <strong>Parameters:</strong>\r
65         <ul><li>None.</li>        </ul>\r
66         <strong>Returns:</strong>\r
67         <ul>\r
68             <li><code>void</code></li>\r
69         </ul>\r
70     </div>\r
71                 </div>\r
72                         </div>\r
73         </td>\r
74         <td class="msource"><a ext:cls="Ext.Toolbar.Item" ext:member="#destroy" href="output/Ext.Toolbar.Item.html#destroy">Toolbar.Item</a></td>\r
75     </tr>\r
76         <tr class="method-row inherited expandable">\r
77         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
78         <td class="sig">\r
79         <a id="Ext.Toolbar.TextItem-disable"></a>\r
80             <b>disable</b>() : void            <div class="mdesc">\r
81                         <div class="short">Disables this item.</div>\r
82             <div class="long">\r
83                 Disables this item.    <div class="mdetail-params">\r
84         <strong>Parameters:</strong>\r
85         <ul><li>None.</li>        </ul>\r
86         <strong>Returns:</strong>\r
87         <ul>\r
88             <li><code>void</code></li>\r
89         </ul>\r
90     </div>\r
91                 </div>\r
92                         </div>\r
93         </td>\r
94         <td class="msource"><a ext:cls="Ext.Toolbar.Item" ext:member="#disable" href="output/Ext.Toolbar.Item.html#disable">Toolbar.Item</a></td>\r
95     </tr>\r
96         <tr class="method-row inherited alt expandable">\r
97         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
98         <td class="sig">\r
99         <a id="Ext.Toolbar.TextItem-enable"></a>\r
100             <b>enable</b>() : void            <div class="mdesc">\r
101                         <div class="short">Enables this item.</div>\r
102             <div class="long">\r
103                 Enables this item.    <div class="mdetail-params">\r
104         <strong>Parameters:</strong>\r
105         <ul><li>None.</li>        </ul>\r
106         <strong>Returns:</strong>\r
107         <ul>\r
108             <li><code>void</code></li>\r
109         </ul>\r
110     </div>\r
111                 </div>\r
112                         </div>\r
113         </td>\r
114         <td class="msource"><a ext:cls="Ext.Toolbar.Item" ext:member="#enable" href="output/Ext.Toolbar.Item.html#enable">Toolbar.Item</a></td>\r
115     </tr>\r
116         <tr class="method-row inherited expandable">\r
117         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
118         <td class="sig">\r
119         <a id="Ext.Toolbar.TextItem-focus"></a>\r
120             <b>focus</b>() : void            <div class="mdesc">\r
121                         <div class="short">Try to focus this item</div>\r
122             <div class="long">\r
123                 Try to focus this item    <div class="mdetail-params">\r
124         <strong>Parameters:</strong>\r
125         <ul><li>None.</li>        </ul>\r
126         <strong>Returns:</strong>\r
127         <ul>\r
128             <li><code>void</code></li>\r
129         </ul>\r
130     </div>\r
131                 </div>\r
132                         </div>\r
133         </td>\r
134         <td class="msource"><a ext:cls="Ext.Toolbar.Item" ext:member="#focus" href="output/Ext.Toolbar.Item.html#focus">Toolbar.Item</a></td>\r
135     </tr>\r
136         <tr class="method-row inherited alt expandable">\r
137         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
138         <td class="sig">\r
139         <a id="Ext.Toolbar.TextItem-getEl"></a>\r
140             <b>getEl</b>() : HTMLElement            <div class="mdesc">\r
141                         <div class="short">Get this item's HTML Element</div>\r
142             <div class="long">\r
143                 Get this item's HTML Element    <div class="mdetail-params">\r
144         <strong>Parameters:</strong>\r
145         <ul><li>None.</li>        </ul>\r
146         <strong>Returns:</strong>\r
147         <ul>\r
148             <li><code>HTMLElement</code></li>\r
149         </ul>\r
150     </div>\r
151                 </div>\r
152                         </div>\r
153         </td>\r
154         <td class="msource"><a ext:cls="Ext.Toolbar.Item" ext:member="#getEl" href="output/Ext.Toolbar.Item.html#getEl">Toolbar.Item</a></td>\r
155     </tr>\r
156         <tr class="method-row inherited expandable">\r
157         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
158         <td class="sig">\r
159         <a id="Ext.Toolbar.TextItem-hide"></a>\r
160             <b>hide</b>() : void            <div class="mdesc">\r
161                         <div class="short">Hides this item.</div>\r
162             <div class="long">\r
163                 Hides this item.    <div class="mdetail-params">\r
164         <strong>Parameters:</strong>\r
165         <ul><li>None.</li>        </ul>\r
166         <strong>Returns:</strong>\r
167         <ul>\r
168             <li><code>void</code></li>\r
169         </ul>\r
170     </div>\r
171                 </div>\r
172                         </div>\r
173         </td>\r
174         <td class="msource"><a ext:cls="Ext.Toolbar.Item" ext:member="#hide" href="output/Ext.Toolbar.Item.html#hide">Toolbar.Item</a></td>\r
175     </tr>\r
176         <tr class="method-row inherited alt expandable">\r
177         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
178         <td class="sig">\r
179         <a id="Ext.Toolbar.TextItem-setVisible"></a>\r
180             <b>setVisible</b>(&nbsp;<code>Boolean visible</code>&nbsp;) : void            <div class="mdesc">\r
181                         <div class="short">Convenience function for boolean show/hide.</div>\r
182             <div class="long">\r
183                 Convenience function for boolean show/hide.    <div class="mdetail-params">\r
184         <strong>Parameters:</strong>\r
185         <ul><li><code>visible</code> : Boolean<div class="sub-desc">true to show/false to hide</div></li>        </ul>\r
186         <strong>Returns:</strong>\r
187         <ul>\r
188             <li><code>void</code></li>\r
189         </ul>\r
190     </div>\r
191                 </div>\r
192                         </div>\r
193         </td>\r
194         <td class="msource"><a ext:cls="Ext.Toolbar.Item" ext:member="#setVisible" href="output/Ext.Toolbar.Item.html#setVisible">Toolbar.Item</a></td>\r
195     </tr>\r
196         <tr class="method-row inherited expandable">\r
197         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
198         <td class="sig">\r
199         <a id="Ext.Toolbar.TextItem-show"></a>\r
200             <b>show</b>() : void            <div class="mdesc">\r
201                         <div class="short">Shows this item.</div>\r
202             <div class="long">\r
203                 Shows this item.    <div class="mdetail-params">\r
204         <strong>Parameters:</strong>\r
205         <ul><li>None.</li>        </ul>\r
206         <strong>Returns:</strong>\r
207         <ul>\r
208             <li><code>void</code></li>\r
209         </ul>\r
210     </div>\r
211                 </div>\r
212                         </div>\r
213         </td>\r
214         <td class="msource"><a ext:cls="Ext.Toolbar.Item" ext:member="#show" href="output/Ext.Toolbar.Item.html#show">Toolbar.Item</a></td>\r
215     </tr>\r
216             </table>
217                 <a id="Ext.Toolbar.TextItem-events"></a>
218         <h2>Public Events</h2>
219         <div class="no-members">This class has no public events.</div>
220         </div>