| 2 |
aperonnet |
1 |
<div class="body-wrap">
|
|
|
2 |
<div class="top-tools">
|
|
|
3 |
<a class="inner-link" href="#Ext.BoxComponent-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
|
|
|
4 |
<a class="inner-link" href="#Ext.BoxComponent-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
|
|
|
5 |
<a class="inner-link" href="#Ext.BoxComponent-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
|
|
|
6 |
<a class="inner-link" href="#Ext.BoxComponent-configs"><img src="../resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>
|
|
|
7 |
<a class="bookmark" href="../docs/?class=Ext.BoxComponent"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
|
|
|
8 |
</div>
|
|
|
9 |
<div class="inheritance res-block">
|
|
|
10 |
<pre class="res-block-inner"><a ext:cls="Ext.util.Observable" ext:member="" href="output/Ext.util.Observable.html">Observable</a>
|
|
|
11 |
<img src="resources/elbow-end.gif"/><a ext:cls="Ext.Component" ext:member="" href="output/Ext.Component.html">Component</a>
|
|
|
12 |
<img src="resources/elbow-end.gif"/>BoxComponent</pre></div>
|
|
|
13 |
<h1>Class Ext.BoxComponent</h1>
|
|
|
14 |
<table cellspacing="0">
|
|
|
15 |
<tr><td class="label">Package:</td><td class="hd-info">Ext</td></tr>
|
|
|
16 |
<tr><td class="label">Defined In:</td><td class="hd-info"><a href="../source/widgets/BoxComponent.js" target="_blank">BoxComponent.js</a></td></tr>
|
|
|
17 |
<tr><td class="label">Class:</td><td class="hd-info">BoxComponent</td></tr>
|
|
|
18 |
<tr><td class="label">Subclasses:</td><td class="hd-info"><a ext:cls="Ext.Container" href="output/Ext.Container.html">Container</a>, <a ext:cls="Ext.DataView" href="output/Ext.DataView.html">DataView</a>, <a ext:cls="Ext.ProgressBar" href="output/Ext.ProgressBar.html">ProgressBar</a>, <a ext:cls="Ext.Toolbar" href="output/Ext.Toolbar.html">Toolbar</a>, <a ext:cls="Ext.form.Field" href="output/Ext.form.Field.html">Field</a></td></tr>
|
|
|
19 |
<tr><td class="label">Extends:</td><td class="hd-info"><a ext:cls="Ext.Component" ext:member="" href="output/Ext.Component.html">Component</a></td></tr>
|
|
|
20 |
</table>
|
|
|
21 |
<div class="description">
|
|
|
22 |
Base class for any visual <a ext:cls="Ext.Component" href="output/Ext.Component.html">Ext.Component</a> that uses a box container. BoxComponent provides automatic box
|
|
|
23 |
model adjustments for sizing and positioning and will work correctly withnin the Component rendering model. All
|
|
|
24 |
container classes should subclass BoxComponent so that they will work consistently when nested within other Ext
|
|
|
25 |
layout containers. </div>
|
|
|
26 |
|
|
|
27 |
<div class="hr"></div>
|
|
|
28 |
<a id="Ext.BoxComponent-configs"></a>
|
|
|
29 |
<h2>Config Options</h2>
|
|
|
30 |
<table cellspacing="0" class="member-table">
|
|
|
31 |
<tr>
|
|
|
32 |
<th class="sig-header" colspan="2">Config Options</th>
|
|
|
33 |
<th class="msource-header">Defined By</th>
|
|
|
34 |
</tr>
|
|
|
35 |
<tr class="config-row inherited">
|
|
|
36 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
37 |
<td class="sig">
|
|
|
38 |
<a id="Ext.BoxComponent-allowDomMove"></a>
|
|
|
39 |
<b>allowDomMove</b> : Boolean <div class="mdesc">
|
|
|
40 |
Whether the component can move the Dom node when rendering (defaults to true). </div>
|
|
|
41 |
</td>
|
|
|
42 |
<td class="msource"><a ext:cls="Ext.Component" ext:member="#allowDomMove" href="output/Ext.Component.html#allowDomMove">Component</a></td>
|
|
|
43 |
</tr>
|
|
|
44 |
<tr class="config-row inherited alt expandable">
|
|
|
45 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
46 |
<td class="sig">
|
|
|
47 |
<a id="Ext.BoxComponent-applyTo"></a>
|
|
|
48 |
<b>applyTo</b> : Mixed <div class="mdesc">
|
|
|
49 |
<div class="short">The id of the node, a DOM node or an existing Element corresponding to a DIV that is already present in the document ...</div>
|
|
|
50 |
<div class="long">
|
|
|
51 |
The id of the node, a DOM node or an existing Element corresponding to a DIV that is already present in the document that specifies some structural markup for this component. When applyTo is used, constituent parts of the component can also be specified by id or CSS class name within the main element, and the component being created may attempt to create its subcomponents from that markup if applicable. Using this config, a call to render() is not required. If applyTo is specified, any value passed for <a ext:cls="Ext.Component" ext:member="renderTo" href="output/Ext.Component.html#renderTo">renderTo</a> will be ignored and the target element's parent node will automatically be used as the component's container. </div>
|
|
|
52 |
</div>
|
|
|
53 |
</td>
|
|
|
54 |
<td class="msource"><a ext:cls="Ext.Component" ext:member="#applyTo" href="output/Ext.Component.html#applyTo">Component</a></td>
|
|
|
55 |
</tr>
|
|
|
56 |
<tr class="config-row inherited expandable">
|
|
|
57 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
58 |
<td class="sig">
|
|
|
59 |
<a id="Ext.BoxComponent-autoEl"></a>
|
|
|
60 |
<b>autoEl</b> : String/Object <div class="mdesc">
|
|
|
61 |
<div class="short">A tag name or DomHelper spec to create an element with. This is intended to create shorthand utility components inlin...</div>
|
|
|
62 |
<div class="long">
|
|
|
63 |
A tag name or DomHelper spec to create an element with. This is intended to create shorthand utility components inline via JSON. It should not be used for higher level components which already create their own elements. Example usage: <pre><code>{xtype:<em>'box'</em>, autoEl: <em>'div'</em>, cls:<em>'my-class'</em>}
|
|
|
64 |
{xtype:<em>'box'</em>, autoEl: {tag:<em>'blockquote'</em>, html:<em>'autoEl is cool!'</em>}} // <b>with</b> DomHelper</code></pre> </div>
|
|
|
65 |
</div>
|
|
|
66 |
</td>
|
|
|
67 |
<td class="msource"><a ext:cls="Ext.Component" ext:member="#autoEl" href="output/Ext.Component.html#autoEl">Component</a></td>
|
|
|
68 |
</tr>
|
|
|
69 |
<tr class="config-row alt expandable">
|
|
|
70 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
71 |
<td class="sig">
|
|
|
72 |
<a id="Ext.BoxComponent-autoHeight"></a>
|
|
|
73 |
<b>autoHeight</b> : Boolean <div class="mdesc">
|
|
|
74 |
<div class="short">True to use height:'auto', false to use fixed height. Note: although many components inherit this config option, not ...</div>
|
|
|
75 |
<div class="long">
|
|
|
76 |
True to use height:'auto', false to use fixed height. Note: although many components inherit this config option, not all will function as expected with a height of 'auto'. (defaults to false). </div>
|
|
|
77 |
</div>
|
|
|
78 |
</td>
|
|
|
79 |
<td class="msource">BoxComponent</td>
|
|
|
80 |
</tr>
|
|
|
81 |
<tr class="config-row inherited expandable">
|
|
|
82 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
83 |
<td class="sig">
|
|
|
84 |
<a id="Ext.BoxComponent-autoShow"></a>
|
|
|
85 |
<b>autoShow</b> : Boolean <div class="mdesc">
|
|
|
86 |
<div class="short">True if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove them on render...</div>
|
|
|
87 |
<div class="long">
|
|
|
88 |
True if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove them on render (defaults to false). </div>
|
|
|
89 |
</div>
|
|
|
90 |
</td>
|
|
|
91 |
<td class="msource"><a ext:cls="Ext.Component" ext:member="#autoShow" href="output/Ext.Component.html#autoShow">Component</a></td>
|
|
|
92 |
</tr>
|
|
|
93 |
<tr class="config-row alt expandable">
|
|
|
94 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
95 |
<td class="sig">
|
|
|
96 |
<a id="Ext.BoxComponent-autoWidth"></a>
|
|
|
97 |
<b>autoWidth</b> : Boolean <div class="mdesc">
|
|
|
98 |
<div class="short">True to use width:'auto', false to use fixed width. Note: although many components inherit this config option, not al...</div>
|
|
|
99 |
<div class="long">
|
|
|
100 |
True to use width:'auto', false to use fixed width. Note: although many components inherit this config option, not all will function as expected with a width of 'auto'. (defaults to false). </div>
|
|
|
101 |
</div>
|
|
|
102 |
</td>
|
|
|
103 |
<td class="msource">BoxComponent</td>
|
|
|
104 |
</tr>
|
|
|
105 |
<tr class="config-row inherited expandable">
|
|
|
106 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
107 |
<td class="sig">
|
|
|
108 |
<a id="Ext.BoxComponent-cls"></a>
|
|
|
109 |
<b>cls</b> : String <div class="mdesc">
|
|
|
110 |
<div class="short">An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be useful for a...</div>
|
|
|
111 |
<div class="long">
|
|
|
112 |
An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be useful for adding customized styles to the component or any of its children using standard CSS rules. </div>
|
|
|
113 |
</div>
|
|
|
114 |
</td>
|
|
|
115 |
<td class="msource"><a ext:cls="Ext.Component" ext:member="#cls" href="output/Ext.Component.html#cls">Component</a></td>
|
|
|
116 |
</tr>
|
|
|
117 |
<tr class="config-row inherited alt expandable">
|
|
|
118 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
119 |
<td class="sig">
|
|
|
120 |
<a id="Ext.BoxComponent-ctCls"></a>
|
|
|
121 |
<b>ctCls</b> : String <div class="mdesc">
|
|
|
122 |
<div class="short">An optional extra CSS class that will be added to this component's container (defaults to ''). This can be useful for...</div>
|
|
|
123 |
<div class="long">
|
|
|
124 |
An optional extra CSS class that will be added to this component's container (defaults to ''). This can be useful for adding customized styles to the container or any of its children using standard CSS rules. </div>
|
|
|
125 |
</div>
|
|
|
126 |
</td>
|
|
|
127 |
<td class="msource"><a ext:cls="Ext.Component" ext:member="#ctCls" href="output/Ext.Component.html#ctCls">Component</a></td>
|
|
|
128 |
</tr>
|
|
|
129 |
<tr class="config-row inherited">
|
|
|
130 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
131 |
<td class="sig">
|
|
|
132 |
<a id="Ext.BoxComponent-disabledClass"></a>
|
|
|
133 |
<b>disabledClass</b> : String <div class="mdesc">
|
|
|
134 |
CSS class added to the component when it is disabled (defaults to "x-item-disabled"). </div>
|
|
|
135 |
</td>
|
|
|
136 |
<td class="msource"><a ext:cls="Ext.Component" ext:member="#disabledClass" href="output/Ext.Component.html#disabledClass">Component</a></td>
|
|
|
137 |
</tr>
|
|
|
138 |
<tr class="config-row alt">
|
|
|
139 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
140 |
<td class="sig">
|
|
|
141 |
<a id="Ext.BoxComponent-height"></a>
|
|
|
142 |
<b>height</b> : Number <div class="mdesc">
|
|
|
143 |
The height of this component in pixels (defaults to auto). </div>
|
|
|
144 |
</td>
|
|
|
145 |
<td class="msource">BoxComponent</td>
|
|
|
146 |
</tr>
|
|
|
147 |
<tr class="config-row inherited expandable">
|
|
|
148 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
149 |
<td class="sig">
|
|
|
150 |
<a id="Ext.BoxComponent-hideMode"></a>
|
|
|
151 |
<b>hideMode</b> : String <div class="mdesc">
|
|
|
152 |
<div class="short">How this component should hidden. Supported values are "visibility" (css visibility), "offsets" (negative offset posi...</div>
|
|
|
153 |
<div class="long">
|
|
|
154 |
How this component should hidden. Supported values are "visibility" (css visibility), "offsets" (negative offset position) and "display" (css display) - defaults to "display". </div>
|
|
|
155 |
</div>
|
|
|
156 |
</td>
|
|
|
157 |
<td class="msource"><a ext:cls="Ext.Component" ext:member="#hideMode" href="output/Ext.Component.html#hideMode">Component</a></td>
|
|
|
158 |
</tr>
|
|
|
159 |
<tr class="config-row inherited alt expandable">
|
|
|
160 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
161 |
<td class="sig">
|
|
|
162 |
<a id="Ext.BoxComponent-hideParent"></a>
|
|
|
163 |
<b>hideParent</b> : Boolean <div class="mdesc">
|
|
|
164 |
<div class="short">True to hide and show the component's container when hide/show is called on the component, false to hide and show the...</div>
|
|
|
165 |
<div class="long">
|
|
|
166 |
True to hide and show the component's container when hide/show is called on the component, false to hide and show the component itself (defaults to false). For example, this can be used as a shortcut for a hide button on a window by setting hide:true on the button when adding it to its parent container. </div>
|
|
|
167 |
</div>
|
|
|
168 |
</td>
|
|
|
169 |
<td class="msource"><a ext:cls="Ext.Component" ext:member="#hideParent" href="output/Ext.Component.html#hideParent">Component</a></td>
|
|
|
170 |
</tr>
|
|
|
171 |
<tr class="config-row inherited">
|
|
|
172 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
173 |
<td class="sig">
|
|
|
174 |
<a id="Ext.BoxComponent-id"></a>
|
|
|
175 |
<b>id</b> : String <div class="mdesc">
|
|
|
176 |
The unique id of this component (defaults to an auto-assigned id). </div>
|
|
|
177 |
</td>
|
|
|
178 |
<td class="msource"><a ext:cls="Ext.Component" ext:member="#id" href="output/Ext.Component.html#id">Component</a></td>
|
|
|
179 |
</tr>
|
|
|
180 |
<tr class="config-row inherited alt expandable">
|
|
|
181 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
182 |
<td class="sig">
|
|
|
183 |
<a id="Ext.BoxComponent-listeners"></a>
|
|
|
184 |
<b>listeners</b> : Object <div class="mdesc">
|
|
|
185 |
<div class="short">A config object containing one or more event handlers to be added to this object during initialization. This should b...</div>
|
|
|
186 |
<div class="long">
|
|
|
187 |
A config object containing one or more event handlers to be added to this object during initialization. This should be a valid listeners config object as specified in the <a ext:cls="Ext.util.Observable" ext:member="addListener" href="output/Ext.util.Observable.html#addListener">addListener</a> example for attaching multiple handlers at once. </div>
|
|
|
188 |
</div>
|
|
|
189 |
</td>
|
|
|
190 |
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#listeners" href="output/Ext.util.Observable.html#listeners">Observable</a></td>
|
|
|
191 |
</tr>
|
|
|
192 |
<tr class="config-row">
|
|
|
193 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
194 |
<td class="sig">
|
|
|
195 |
<a id="Ext.BoxComponent-pageX"></a>
|
|
|
196 |
<b>pageX</b> : Number <div class="mdesc">
|
|
|
197 |
The page level x coordinate for this component if contained within a positioning container. </div>
|
|
|
198 |
</td>
|
|
|
199 |
<td class="msource">BoxComponent</td>
|
|
|
200 |
</tr>
|
|
|
201 |
<tr class="config-row alt">
|
|
|
202 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
203 |
<td class="sig">
|
|
|
204 |
<a id="Ext.BoxComponent-pageY"></a>
|
|
|
205 |
<b>pageY</b> : Number <div class="mdesc">
|
|
|
206 |
The page level y coordinate for this component if contained within a positioning container. </div>
|
|
|
207 |
</td>
|
|
|
208 |
<td class="msource">BoxComponent</td>
|
|
|
209 |
</tr>
|
|
|
210 |
<tr class="config-row inherited expandable">
|
|
|
211 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
212 |
<td class="sig">
|
|
|
213 |
<a id="Ext.BoxComponent-plugins"></a>
|
|
|
214 |
<b>plugins</b> : Object/Array <div class="mdesc">
|
|
|
215 |
<div class="short">An object or array of objects that will provide custom functionality for this component. The only requirement for a v...</div>
|
|
|
216 |
<div class="long">
|
|
|
217 |
An object or array of objects that will provide custom functionality for this component. The only requirement for a valid plugin is that it contain an init method that accepts a reference of type Ext.Component. When a component is created, if any plugins are available, the component will call the init method on each plugin, passing a reference to itself. Each plugin can then call methods or respond to events on the component as needed to provide its functionality. </div>
|
|
|
218 |
</div>
|
|
|
219 |
</td>
|
|
|
220 |
<td class="msource"><a ext:cls="Ext.Component" ext:member="#plugins" href="output/Ext.Component.html#plugins">Component</a></td>
|
|
|
221 |
</tr>
|
|
|
222 |
<tr class="config-row inherited alt expandable">
|
|
|
223 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
224 |
<td class="sig">
|
|
|
225 |
<a id="Ext.BoxComponent-renderTo"></a>
|
|
|
226 |
<b>renderTo</b> : Mixed <div class="mdesc">
|
|
|
227 |
<div class="short">The id of the node, a DOM node or an existing Element that will be the container to render this component into. Using...</div>
|
|
|
228 |
<div class="long">
|
|
|
229 |
The id of the node, a DOM node or an existing Element that will be the container to render this component into. Using this config, a call to render() is not required. </div>
|
|
|
230 |
</div>
|
|
|
231 |
</td>
|
|
|
232 |
<td class="msource"><a ext:cls="Ext.Component" ext:member="#renderTo" href="output/Ext.Component.html#renderTo">Component</a></td>
|
|
|
233 |
</tr>
|
|
|
234 |
<tr class="config-row inherited expandable">
|
|
|
235 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
236 |
<td class="sig">
|
|
|
237 |
<a id="Ext.BoxComponent-stateEvents"></a>
|
|
|
238 |
<b>stateEvents</b> : Array <div class="mdesc">
|
|
|
239 |
<div class="short">An array of events that, when fired, should trigger this component to save its state (defaults to none). These can be...</div>
|
|
|
240 |
<div class="long">
|
|
|
241 |
An array of events that, when fired, should trigger this component to save its state (defaults to none). These can be any types of events supported by this component, including browser or custom events (e.g., ['click', 'customerchange']). <p>See <a ext:cls="Ext.Component" ext:member="stateful" href="output/Ext.Component.html#stateful">stateful</a> for an explanation of saving and restoring Component state.</p> </div>
|
|
|
242 |
</div>
|
|
|
243 |
</td>
|
|
|
244 |
<td class="msource"><a ext:cls="Ext.Component" ext:member="#stateEvents" href="output/Ext.Component.html#stateEvents">Component</a></td>
|
|
|
245 |
</tr>
|
|
|
246 |
<tr class="config-row inherited alt expandable">
|
|
|
247 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
248 |
<td class="sig">
|
|
|
249 |
<a id="Ext.BoxComponent-stateId"></a>
|
|
|
250 |
<b>stateId</b> : String <div class="mdesc">
|
|
|
251 |
<div class="short">The unique id for this component to use for state management purposes (defaults to the component id). See stateful fo...</div>
|
|
|
252 |
<div class="long">
|
|
|
253 |
The unique id for this component to use for state management purposes (defaults to the component id). <p>See <a ext:cls="Ext.Component" ext:member="stateful" href="output/Ext.Component.html#stateful">stateful</a> for an explanation of saving and restoring Component state.</p> </div>
|
|
|
254 |
</div>
|
|
|
255 |
</td>
|
|
|
256 |
<td class="msource"><a ext:cls="Ext.Component" ext:member="#stateId" href="output/Ext.Component.html#stateId">Component</a></td>
|
|
|
257 |
</tr>
|
|
|
258 |
<tr class="config-row inherited expandable">
|
|
|
259 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
260 |
<td class="sig">
|
|
|
261 |
<a id="Ext.BoxComponent-stateful"></a>
|
|
|
262 |
<b>stateful</b> : Boolean <div class="mdesc">
|
|
|
263 |
<div class="short">A flag which causes the Component to attempt to restore the state of internal properties from a saved state on startu...</div>
|
|
|
264 |
<div class="long">
|
|
|
265 |
A flag which causes the Component to attempt to restore the state of internal properties from a saved state on startup.<p> For state saving to work, the state manager's provider must have been set to an implementation of <a ext:cls="Ext.state.Provider" href="output/Ext.state.Provider.html">Ext.state.Provider</a> which overrides the <a ext:cls="Ext.state.Provider" ext:member="set" href="output/Ext.state.Provider.html#set">set</a> and <a ext:cls="Ext.state.Provider" ext:member="get" href="output/Ext.state.Provider.html#get">get</a> methods to save and recall name/value pairs. A built-in implementation, <a ext:cls="Ext.state.CookieProvider" href="output/Ext.state.CookieProvider.html">Ext.state.CookieProvider</a> is available.</p> <p>To set the state provider for the current page:</p> <pre><code>Ext.state.Manager.setProvider(<b>new</b> Ext.state.CookieProvider());</code></pre> <p>Components attempt to save state when one of the events listed in the <a ext:cls="Ext.Component" ext:member="stateEvents" href="output/Ext.Component.html#stateEvents">stateEvents</a> configuration fires.</p> <p>You can perform extra processing on state save and restore by attaching handlers to the <a ext:cls="Ext.Component" ext:member="beforestaterestore" href="output/Ext.Component.html#beforestaterestore">beforestaterestore</a>, <a ext:cls="staterestore" href="output/staterestore.html">staterestore</a>, <a ext:cls="beforestatesave" href="output/beforestatesave.html">beforestatesave</a> and <a ext:cls="statesave" href="output/statesave.html">statesave</a> events</p> </div>
|
|
|
266 |
</div>
|
|
|
267 |
</td>
|
|
|
268 |
<td class="msource"><a ext:cls="Ext.Component" ext:member="#stateful" href="output/Ext.Component.html#stateful">Component</a></td>
|
|
|
269 |
</tr>
|
|
|
270 |
<tr class="config-row inherited alt expandable">
|
|
|
271 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
272 |
<td class="sig">
|
|
|
273 |
<a id="Ext.BoxComponent-style"></a>
|
|
|
274 |
<b>style</b> : String <div class="mdesc">
|
|
|
275 |
<div class="short">A custom style specification to be applied to this component's Element. Should be a valid argument to Ext.Element.app...</div>
|
|
|
276 |
<div class="long">
|
|
|
277 |
A custom style specification to be applied to this component's Element. Should be a valid argument to <a ext:cls="Ext.Element" ext:member="applyStyles" href="output/Ext.Element.html#applyStyles">Ext.Element.applyStyles</a>. </div>
|
|
|
278 |
</div>
|
|
|
279 |
</td>
|
|
|
280 |
<td class="msource"><a ext:cls="Ext.Component" ext:member="#style" href="output/Ext.Component.html#style">Component</a></td>
|
|
|
281 |
</tr>
|
|
|
282 |
<tr class="config-row">
|
|
|
283 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
284 |
<td class="sig">
|
|
|
285 |
<a id="Ext.BoxComponent-width"></a>
|
|
|
286 |
<b>width</b> : Number <div class="mdesc">
|
|
|
287 |
The width of this component in pixels (defaults to auto). </div>
|
|
|
288 |
</td>
|
|
|
289 |
<td class="msource">BoxComponent</td>
|
|
|
290 |
</tr>
|
|
|
291 |
<tr class="config-row alt">
|
|
|
292 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
293 |
<td class="sig">
|
|
|
294 |
<a id="Ext.BoxComponent-x"></a>
|
|
|
295 |
<b>x</b> : Number <div class="mdesc">
|
|
|
296 |
The local x (left) coordinate for this component if contained within a positioning container. </div>
|
|
|
297 |
</td>
|
|
|
298 |
<td class="msource">BoxComponent</td>
|
|
|
299 |
</tr>
|
|
|
300 |
<tr class="config-row inherited expandable">
|
|
|
301 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
302 |
<td class="sig">
|
|
|
303 |
<a id="Ext.BoxComponent-xtype"></a>
|
|
|
304 |
<b>xtype</b> : String <div class="mdesc">
|
|
|
305 |
<div class="short">The registered xtype to create. This config option is not used when passing a config object into a constructor. This ...</div>
|
|
|
306 |
<div class="long">
|
|
|
307 |
The registered xtype to create. This config option is not used when passing a config object into a constructor. This config option is used only when lazy instantiation is being used, and a child item of a Container is being specified not as a fully instantiated Component, but as a <i>Component config object</i>. The xtype will be looked up at render time up to determine what type of child Component to create.<br><br> The predefined xtypes are listed <a ext:cls="Ext.Component" href="output/Ext.Component.html">here</a>. <br><br> If you subclass Components to create your own Components, you may register them using <a ext:cls="Ext.ComponentMgr" ext:member="registerType" href="output/Ext.ComponentMgr.html#registerType">Ext.ComponentMgr.registerType</a> in order to be able to take advantage of lazy instantiation and rendering. </div>
|
|
|
308 |
</div>
|
|
|
309 |
</td>
|
|
|
310 |
<td class="msource"><a ext:cls="Ext.Component" ext:member="#xtype" href="output/Ext.Component.html#xtype">Component</a></td>
|
|
|
311 |
</tr>
|
|
|
312 |
<tr class="config-row alt">
|
|
|
313 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
314 |
<td class="sig">
|
|
|
315 |
<a id="Ext.BoxComponent-y"></a>
|
|
|
316 |
<b>y</b> : Number <div class="mdesc">
|
|
|
317 |
The local y (top) coordinate for this component if contained within a positioning container. </div>
|
|
|
318 |
</td>
|
|
|
319 |
<td class="msource">BoxComponent</td>
|
|
|
320 |
</tr>
|
|
|
321 |
</table>
|
|
|
322 |
<a id="Ext.BoxComponent-props"></a>
|
|
|
323 |
<h2>Public Properties</h2>
|
|
|
324 |
<table cellspacing="0" class="member-table">
|
|
|
325 |
<tr>
|
|
|
326 |
<th class="sig-header" colspan="2">Property</th>
|
|
|
327 |
<th class="msource-header">Defined By</th>
|
|
|
328 |
</tr>
|
|
|
329 |
<tr class="property-row inherited">
|
|
|
330 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
331 |
<td class="sig">
|
|
|
332 |
<a id="Ext.BoxComponent-disabled"></a>
|
|
|
333 |
<b>disabled</b> : Boolean <div class="mdesc">
|
|
|
334 |
True if this component is disabled. Read-only. </div>
|
|
|
335 |
</td>
|
|
|
336 |
<td class="msource"><a ext:cls="Ext.Component" ext:member="#disabled" href="output/Ext.Component.html#disabled">Component</a></td>
|
|
|
337 |
</tr>
|
|
|
338 |
<tr class="property-row inherited alt">
|
|
|
339 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
340 |
<td class="sig">
|
|
|
341 |
<a id="Ext.BoxComponent-hidden"></a>
|
|
|
342 |
<b>hidden</b> : Boolean <div class="mdesc">
|
|
|
343 |
|
|
|
344 |
True if this component is hidden. Read-only. </div>
|
|
|
345 |
</td>
|
|
|
346 |
<td class="msource"><a ext:cls="Ext.Component" ext:member="#hidden" href="output/Ext.Component.html#hidden">Component</a></td>
|
|
|
347 |
</tr>
|
|
|
348 |
<tr class="property-row inherited">
|
|
|
349 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
350 |
<td class="sig">
|
|
|
351 |
<a id="Ext.BoxComponent-initialConfig"></a>
|
|
|
352 |
<b>initialConfig</b> : Object <div class="mdesc">
|
|
|
353 |
This Component's initial configuration specification. Read-only. </div>
|
|
|
354 |
</td>
|
|
|
355 |
<td class="msource"><a ext:cls="Ext.Component" ext:member="#initialConfig" href="output/Ext.Component.html#initialConfig">Component</a></td>
|
|
|
356 |
</tr>
|
|
|
357 |
<tr class="property-row inherited alt expandable">
|
|
|
358 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
359 |
<td class="sig">
|
|
|
360 |
<a id="Ext.BoxComponent-ownerCt"></a>
|
|
|
361 |
<b>ownerCt</b> : Ext.Container <div class="mdesc">
|
|
|
362 |
<div class="short">The component's owner Ext.Container (defaults to undefined, and is set automatically when
|
|
|
363 |
the component is added to a...</div>
|
|
|
364 |
<div class="long">
|
|
|
365 |
The component's owner <a ext:cls="Ext.Container" href="output/Ext.Container.html">Ext.Container</a> (defaults to undefined, and is set automatically when
|
|
|
366 |
the component is added to a container). Read-only. </div>
|
|
|
367 |
</div>
|
|
|
368 |
</td>
|
|
|
369 |
<td class="msource"><a ext:cls="Ext.Component" ext:member="#ownerCt" href="output/Ext.Component.html#ownerCt">Component</a></td>
|
|
|
370 |
</tr>
|
|
|
371 |
<tr class="property-row inherited">
|
|
|
372 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
373 |
<td class="sig">
|
|
|
374 |
<a id="Ext.BoxComponent-rendered"></a>
|
|
|
375 |
<b>rendered</b> : Boolean <div class="mdesc">
|
|
|
376 |
True if this component has been rendered. Read-only. </div>
|
|
|
377 |
</td>
|
|
|
378 |
<td class="msource"><a ext:cls="Ext.Component" ext:member="#rendered" href="output/Ext.Component.html#rendered">Component</a></td>
|
|
|
379 |
</tr>
|
|
|
380 |
</table>
|
|
|
381 |
<a id="Ext.BoxComponent-methods"></a>
|
|
|
382 |
<h2>Public Methods</h2>
|
|
|
383 |
<table cellspacing="0" class="member-table">
|
|
|
384 |
<tr>
|
|
|
385 |
<th class="sig-header" colspan="2">Method</th>
|
|
|
386 |
<th class="msource-header">Defined By</th>
|
|
|
387 |
</tr>
|
|
|
388 |
<tr class="method-row expandable">
|
|
|
389 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
390 |
<td class="sig">
|
|
|
391 |
<a id="Ext.BoxComponent-BoxComponent"></a>
|
|
|
392 |
<b>BoxComponent</b>( <code>Ext.Element/String/Object config</code> ) <div class="mdesc">
|
|
|
393 |
<div class="short"></div>
|
|
|
394 |
<div class="long">
|
|
|
395 |
<div class="mdetail-params">
|
|
|
396 |
<strong>Parameters:</strong>
|
|
|
397 |
<ul><li><code>config</code> : Ext.Element/String/Object<div class="sub-desc">The configuration options.</div></li> </ul>
|
|
|
398 |
<strong>Returns:</strong>
|
|
|
399 |
<ul>
|
|
|
400 |
<li><code></code></li>
|
|
|
401 |
</ul>
|
|
|
402 |
</div>
|
|
|
403 |
</div>
|
|
|
404 |
</div>
|
|
|
405 |
</td>
|
|
|
406 |
<td class="msource">BoxComponent</td>
|
|
|
407 |
</tr>
|
|
|
408 |
<tr class="method-row inherited alt expandable">
|
|
|
409 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
410 |
<td class="sig">
|
|
|
411 |
<a id="Ext.BoxComponent-addClass"></a>
|
|
|
412 |
<b>addClass</b>( <code>string cls</code> ) : void <div class="mdesc">
|
|
|
413 |
<div class="short">Adds a CSS class to the component's underlying element.</div>
|
|
|
414 |
<div class="long">
|
|
|
415 |
Adds a CSS class to the component's underlying element. <div class="mdetail-params">
|
|
|
416 |
<strong>Parameters:</strong>
|
|
|
417 |
<ul><li><code>cls</code> : string<div class="sub-desc">The CSS class name to add</div></li> </ul>
|
|
|
418 |
<strong>Returns:</strong>
|
|
|
419 |
<ul>
|
|
|
420 |
<li><code>void</code></li>
|
|
|
421 |
</ul>
|
|
|
422 |
</div>
|
|
|
423 |
</div>
|
|
|
424 |
</div>
|
|
|
425 |
</td>
|
|
|
426 |
<td class="msource"><a ext:cls="Ext.Component" ext:member="#addClass" href="output/Ext.Component.html#addClass">Component</a></td>
|
|
|
427 |
</tr>
|
|
|
428 |
<tr class="method-row inherited expandable">
|
|
|
429 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
430 |
<td class="sig">
|
|
|
431 |
<a id="Ext.BoxComponent-addEvents"></a>
|
|
|
432 |
<b>addEvents</b>( <code>Object object</code> ) : void <div class="mdesc">
|
|
|
433 |
<div class="short">Used to define events on this Observable</div>
|
|
|
434 |
<div class="long">
|
|
|
435 |
Used to define events on this Observable <div class="mdetail-params">
|
|
|
436 |
<strong>Parameters:</strong>
|
|
|
437 |
<ul><li><code>object</code> : Object<div class="sub-desc">The object with the events defined</div></li> </ul>
|
|
|
438 |
<strong>Returns:</strong>
|
|
|
439 |
<ul>
|
|
|
440 |
<li><code>void</code></li>
|
|
|
441 |
</ul>
|
|
|
442 |
</div>
|
|
|
443 |
</div>
|
|
|
444 |
</div>
|
|
|
445 |
</td>
|
|
|
446 |
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addEvents" href="output/Ext.util.Observable.html#addEvents">Observable</a></td>
|
|
|
447 |
</tr>
|
|
|
448 |
<tr class="method-row inherited alt expandable">
|
|
|
449 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
450 |
<td class="sig">
|
|
|
451 |
<a id="Ext.BoxComponent-addListener"></a>
|
|
|
452 |
<b>addListener</b>( <code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Object options</code>]</span> ) : void <div class="mdesc">
|
|
|
453 |
<div class="short">Appends an event handler to this component</div>
|
|
|
454 |
<div class="long">
|
|
|
455 |
Appends an event handler to this component <div class="mdetail-params">
|
|
|
456 |
<strong>Parameters:</strong>
|
|
|
457 |
<ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope in which to execute the handler
|
|
|
458 |
function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration
|
|
|
459 |
properties. This may contain any of the following properties:<ul>
|
|
|
460 |
<li><b>scope</b> : Object<p class="sub-desc">The scope in which to execute the handler function. The handler function's "this" context.</p></li>
|
|
|
461 |
<li><b>delay</b> : Number<p class="sub-desc">The number of milliseconds to delay the invocation of the handler after the event fires.</p></li>
|
|
|
462 |
<li><b>single</b> : Boolean<p class="sub-desc">True to add a handler to handle just the next firing of the event, and then remove itself.</p></li>
|
|
|
463 |
<li><b>buffer</b> : Number<p class="sub-desc">Causes the handler to be scheduled to run in an <a ext:cls="Ext.util.DelayedTask" href="output/Ext.util.DelayedTask.html">Ext.util.DelayedTask</a> delayed
|
|
|
464 |
by the specified number of milliseconds. If the event fires again within that time, the original
|
|
|
465 |
handler is <em>not</em> invoked, but the new handler is scheduled in its place.</p></li>
|
|
|
466 |
</ul><br>
|
|
|
467 |
<p>
|
|
|
468 |
<b>Combining Options</b><br>
|
|
|
469 |
Using the options argument, it is possible to combine different types of listeners:<br>
|
|
|
470 |
<br>
|
|
|
471 |
A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)
|
|
|
472 |
<pre><code>el.on(<em>'click'</em>, <b>this</b>.onClick, <b>this</b>, {
|
|
|
473 |
single: true,
|
|
|
474 |
delay: 100,
|
|
|
475 |
forumId: 4
|
|
|
476 |
});</code></pre>
|
|
|
477 |
<p>
|
|
|
478 |
<b>Attaching multiple handlers in 1 call</b><br>
|
|
|
479 |
The method also allows for a single argument to be passed which is a config object containing properties
|
|
|
480 |
which specify multiple handlers.
|
|
|
481 |
<p>
|
|
|
482 |
<pre><code>foo.on({
|
|
|
483 |
<em>'click'</em> : {
|
|
|
484 |
fn: <b>this</b>.onClick,
|
|
|
485 |
scope: <b>this</b>,
|
|
|
486 |
delay: 100
|
|
|
487 |
},
|
|
|
488 |
<em>'mouseover'</em> : {
|
|
|
489 |
fn: <b>this</b>.onMouseOver,
|
|
|
490 |
scope: <b>this</b>
|
|
|
491 |
},
|
|
|
492 |
<em>'mouseout'</em> : {
|
|
|
493 |
fn: <b>this</b>.onMouseOut,
|
|
|
494 |
scope: <b>this</b>
|
|
|
495 |
}
|
|
|
496 |
});</code></pre>
|
|
|
497 |
<p>
|
|
|
498 |
Or a shorthand syntax:<br>
|
|
|
499 |
<pre><code>foo.on({
|
|
|
500 |
<em>'click'</em> : <b>this</b>.onClick,
|
|
|
501 |
<em>'mouseover'</em> : <b>this</b>.onMouseOver,
|
|
|
502 |
<em>'mouseout'</em> : <b>this</b>.onMouseOut,
|
|
|
503 |
scope: <b>this</b>
|
|
|
504 |
});</code></pre></div></li> </ul>
|
|
|
505 |
<strong>Returns:</strong>
|
|
|
506 |
<ul>
|
|
|
507 |
<li><code>void</code></li>
|
|
|
508 |
</ul>
|
|
|
509 |
</div>
|
|
|
510 |
</div>
|
|
|
511 |
</div>
|
|
|
512 |
</td>
|
|
|
513 |
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addListener" href="output/Ext.util.Observable.html#addListener">Observable</a></td>
|
|
|
514 |
</tr>
|
|
|
515 |
<tr class="method-row inherited expandable">
|
|
|
516 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
517 |
<td class="sig">
|
|
|
518 |
<a id="Ext.BoxComponent-applyToMarkup"></a>
|
|
|
519 |
<b>applyToMarkup</b>( <code>String/HTMLElement el</code> ) : void <div class="mdesc">
|
|
|
520 |
<div class="short">Apply this component to existing markup that is valid. With this function, no call to render() is required.</div>
|
|
|
521 |
<div class="long">
|
|
|
522 |
Apply this component to existing markup that is valid. With this function, no call to render() is required. <div class="mdetail-params">
|
|
|
523 |
<strong>Parameters:</strong>
|
|
|
524 |
<ul><li><code>el</code> : String/HTMLElement<div class="sub-desc"></div></li> </ul>
|
|
|
525 |
<strong>Returns:</strong>
|
|
|
526 |
<ul>
|
|
|
527 |
<li><code>void</code></li>
|
|
|
528 |
</ul>
|
|
|
529 |
</div>
|
|
|
530 |
</div>
|
|
|
531 |
</div>
|
|
|
532 |
</td>
|
|
|
533 |
<td class="msource"><a ext:cls="Ext.Component" ext:member="#applyToMarkup" href="output/Ext.Component.html#applyToMarkup">Component</a></td>
|
|
|
534 |
</tr>
|
|
|
535 |
<tr class="method-row inherited alt expandable">
|
|
|
536 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
537 |
<td class="sig">
|
|
|
538 |
<a id="Ext.BoxComponent-cloneConfig"></a>
|
|
|
539 |
<b>cloneConfig</b>( <code>Object overrides</code> ) : Ext.Component <div class="mdesc">
|
|
|
540 |
<div class="short">Clone the current component using the original config values passed into this instance by default.</div>
|
|
|
541 |
<div class="long">
|
|
|
542 |
Clone the current component using the original config values passed into this instance by default. <div class="mdetail-params">
|
|
|
543 |
<strong>Parameters:</strong>
|
|
|
544 |
<ul><li><code>overrides</code> : Object<div class="sub-desc">A new config containing any properties to override in the cloned version.
|
|
|
545 |
An id property can be passed on this object, otherwise one will be generated to avoid duplicates.</div></li> </ul>
|
|
|
546 |
<strong>Returns:</strong>
|
|
|
547 |
<ul>
|
|
|
548 |
<li><code>Ext.Component</code><div class="sub-desc">clone The cloned copy of this component</div></li>
|
|
|
549 |
</ul>
|
|
|
550 |
</div>
|
|
|
551 |
</div>
|
|
|
552 |
</div>
|
|
|
553 |
</td>
|
|
|
554 |
<td class="msource"><a ext:cls="Ext.Component" ext:member="#cloneConfig" href="output/Ext.Component.html#cloneConfig">Component</a></td>
|
|
|
555 |
</tr>
|
|
|
556 |
<tr class="method-row inherited expandable">
|
|
|
557 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
558 |
<td class="sig">
|
|
|
559 |
<a id="Ext.BoxComponent-destroy"></a>
|
|
|
560 |
<b>destroy</b>() : void <div class="mdesc">
|
|
|
561 |
<div class="short">Destroys this component by purging any event listeners, removing the component's element from the DOM,
|
|
|
562 |
removing the c...</div>
|
|
|
563 |
<div class="long">
|
|
|
564 |
Destroys this component by purging any event listeners, removing the component's element from the DOM,
|
|
|
565 |
removing the component from its <a ext:cls="Ext.Container" href="output/Ext.Container.html">Ext.Container</a> (if applicable) and unregistering it from
|
|
|
566 |
<a ext:cls="Ext.ComponentMgr" href="output/Ext.ComponentMgr.html">Ext.ComponentMgr</a>. Destruction is generally handled automatically by the framework and this method
|
|
|
567 |
should usually not need to be called directly. <div class="mdetail-params">
|
|
|
568 |
<strong>Parameters:</strong>
|
|
|
569 |
<ul><li>None.</li> </ul>
|
|
|
570 |
<strong>Returns:</strong>
|
|
|
571 |
<ul>
|
|
|
572 |
<li><code>void</code></li>
|
|
|
573 |
</ul>
|
|
|
574 |
</div>
|
|
|
575 |
</div>
|
|
|
576 |
</div>
|
|
|
577 |
</td>
|
|
|
578 |
<td class="msource"><a ext:cls="Ext.Component" ext:member="#destroy" href="output/Ext.Component.html#destroy">Component</a></td>
|
|
|
579 |
</tr>
|
|
|
580 |
<tr class="method-row inherited alt expandable">
|
|
|
581 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
582 |
<td class="sig">
|
|
|
583 |
<a id="Ext.BoxComponent-disable"></a>
|
|
|
584 |
<b>disable</b>() : Ext.Component <div class="mdesc">
|
|
|
585 |
<div class="short">Disable this component.</div>
|
|
|
586 |
<div class="long">
|
|
|
587 |
Disable this component. <div class="mdetail-params">
|
|
|
588 |
<strong>Parameters:</strong>
|
|
|
589 |
<ul><li>None.</li> </ul>
|
|
|
590 |
<strong>Returns:</strong>
|
|
|
591 |
<ul>
|
|
|
592 |
<li><code>Ext.Component</code><div class="sub-desc">this</div></li>
|
|
|
593 |
</ul>
|
|
|
594 |
</div>
|
|
|
595 |
</div>
|
|
|
596 |
</div>
|
|
|
597 |
</td>
|
|
|
598 |
<td class="msource"><a ext:cls="Ext.Component" ext:member="#disable" href="output/Ext.Component.html#disable">Component</a></td>
|
|
|
599 |
</tr>
|
|
|
600 |
<tr class="method-row inherited expandable">
|
|
|
601 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
602 |
<td class="sig">
|
|
|
603 |
<a id="Ext.BoxComponent-enable"></a>
|
|
|
604 |
<b>enable</b>() : Ext.Component <div class="mdesc">
|
|
|
605 |
<div class="short">Enable this component.</div>
|
|
|
606 |
<div class="long">
|
|
|
607 |
Enable this component. <div class="mdetail-params">
|
|
|
608 |
<strong>Parameters:</strong>
|
|
|
609 |
<ul><li>None.</li> </ul>
|
|
|
610 |
<strong>Returns:</strong>
|
|
|
611 |
<ul>
|
|
|
612 |
<li><code>Ext.Component</code><div class="sub-desc">this</div></li>
|
|
|
613 |
</ul>
|
|
|
614 |
</div>
|
|
|
615 |
</div>
|
|
|
616 |
</div>
|
|
|
617 |
</td>
|
|
|
618 |
<td class="msource"><a ext:cls="Ext.Component" ext:member="#enable" href="output/Ext.Component.html#enable">Component</a></td>
|
|
|
619 |
</tr>
|
|
|
620 |
<tr class="method-row inherited alt expandable">
|
|
|
621 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
622 |
<td class="sig">
|
|
|
623 |
<a id="Ext.BoxComponent-findParentBy"></a>
|
|
|
624 |
<b>findParentBy</b>( <code>Function fcn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span> ) : Array <div class="mdesc">
|
|
|
625 |
<div class="short">Find a container above this component at any level by a custom function. If the passed function returns
|
|
|
626 |
true, the con...</div>
|
|
|
627 |
<div class="long">
|
|
|
628 |
Find a container above this component at any level by a custom function. If the passed function returns
|
|
|
629 |
true, the container will be returned. The passed function is called with the arguments (container, this component). <div class="mdetail-params">
|
|
|
630 |
<strong>Parameters:</strong>
|
|
|
631 |
<ul><li><code>fcn</code> : Function<div class="sub-desc"></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional)</div></li> </ul>
|
|
|
632 |
<strong>Returns:</strong>
|
|
|
633 |
<ul>
|
|
|
634 |
<li><code>Array</code><div class="sub-desc">Array of Ext.Components</div></li>
|
|
|
635 |
</ul>
|
|
|
636 |
</div>
|
|
|
637 |
</div>
|
|
|
638 |
</div>
|
|
|
639 |
</td>
|
|
|
640 |
<td class="msource"><a ext:cls="Ext.Component" ext:member="#findParentBy" href="output/Ext.Component.html#findParentBy">Component</a></td>
|
|
|
641 |
</tr>
|
|
|
642 |
<tr class="method-row inherited expandable">
|
|
|
643 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
644 |
<td class="sig">
|
|
|
645 |
<a id="Ext.BoxComponent-findParentByType"></a>
|
|
|
646 |
<b>findParentByType</b>( <code>String/Class xtype</code> ) : Container <div class="mdesc">
|
|
|
647 |
<div class="short">Find a container above this component at any level by xtype or class</div>
|
|
|
648 |
<div class="long">
|
|
|
649 |
Find a container above this component at any level by xtype or class <div class="mdetail-params">
|
|
|
650 |
<strong>Parameters:</strong>
|
|
|
651 |
<ul><li><code>xtype</code> : String/Class<div class="sub-desc">The xtype string for a component, or the class of the component directly</div></li> </ul>
|
|
|
652 |
<strong>Returns:</strong>
|
|
|
653 |
<ul>
|
|
|
654 |
<li><code>Container</code><div class="sub-desc">The found container</div></li>
|
|
|
655 |
</ul>
|
|
|
656 |
</div>
|
|
|
657 |
</div>
|
|
|
658 |
</div>
|
|
|
659 |
</td>
|
|
|
660 |
<td class="msource"><a ext:cls="Ext.Component" ext:member="#findParentByType" href="output/Ext.Component.html#findParentByType">Component</a></td>
|
|
|
661 |
</tr>
|
|
|
662 |
<tr class="method-row inherited alt expandable">
|
|
|
663 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
664 |
<td class="sig">
|
|
|
665 |
<a id="Ext.BoxComponent-fireEvent"></a>
|
|
|
666 |
<b>fireEvent</b>( <code>String eventName</code>, <code>Object... args</code> ) : Boolean <div class="mdesc">
|
|
|
667 |
<div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
|
|
|
668 |
<div class="long">
|
|
|
669 |
Fires the specified event with the passed parameters (minus the event name). <div class="mdetail-params">
|
|
|
670 |
<strong>Parameters:</strong>
|
|
|
671 |
<ul><li><code>eventName</code> : String<div class="sub-desc"></div></li><li><code>args</code> : Object...<div class="sub-desc">Variable number of parameters are passed to handlers</div></li> </ul>
|
|
|
672 |
<strong>Returns:</strong>
|
|
|
673 |
<ul>
|
|
|
674 |
<li><code>Boolean</code><div class="sub-desc">returns false if any of the handlers return false otherwise it returns true</div></li>
|
|
|
675 |
</ul>
|
|
|
676 |
</div>
|
|
|
677 |
</div>
|
|
|
678 |
</div>
|
|
|
679 |
</td>
|
|
|
680 |
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#fireEvent" href="output/Ext.util.Observable.html#fireEvent">Observable</a></td>
|
|
|
681 |
</tr>
|
|
|
682 |
<tr class="method-row inherited expandable">
|
|
|
683 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
684 |
<td class="sig">
|
|
|
685 |
<a id="Ext.BoxComponent-focus"></a>
|
|
|
686 |
<b>focus</b>( <span class="optional" title="Optional">[<code>Boolean selectText</code>]</span>, <span class="optional" title="Optional">[<code>Boolean/Number delay</code>]</span> ) : Ext.Component <div class="mdesc">
|
|
|
687 |
<div class="short">Try to focus this component.</div>
|
|
|
688 |
<div class="long">
|
|
|
689 |
Try to focus this component. <div class="mdetail-params">
|
|
|
690 |
<strong>Parameters:</strong>
|
|
|
691 |
<ul><li><code>selectText</code> : Boolean<div class="sub-desc">(optional) If applicable, true to also select the text in this component</div></li><li><code>delay</code> : Boolean/Number<div class="sub-desc">(optional) Delay the focus this number of milliseconds (true for 10 milliseconds)</div></li> </ul>
|
|
|
692 |
<strong>Returns:</strong>
|
|
|
693 |
<ul>
|
|
|
694 |
<li><code>Ext.Component</code><div class="sub-desc">this</div></li>
|
|
|
695 |
</ul>
|
|
|
696 |
</div>
|
|
|
697 |
</div>
|
|
|
698 |
</div>
|
|
|
699 |
</td>
|
|
|
700 |
<td class="msource"><a ext:cls="Ext.Component" ext:member="#focus" href="output/Ext.Component.html#focus">Component</a></td>
|
|
|
701 |
</tr>
|
|
|
702 |
<tr class="method-row alt expandable">
|
|
|
703 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
704 |
<td class="sig">
|
|
|
705 |
<a id="Ext.BoxComponent-getBox"></a>
|
|
|
706 |
<b>getBox</b>( <span class="optional" title="Optional">[<code>Boolean local</code>]</span> ) : Object <div class="mdesc">
|
|
|
707 |
<div class="short">Gets the current box measurements of the component's underlying element.</div>
|
|
|
708 |
<div class="long">
|
|
|
709 |
Gets the current box measurements of the component's underlying element. <div class="mdetail-params">
|
|
|
710 |
<strong>Parameters:</strong>
|
|
|
711 |
<ul><li><code>local</code> : Boolean<div class="sub-desc">(optional) If true the element's left and top are returned instead of page XY (defaults to false)</div></li> </ul>
|
|
|
712 |
<strong>Returns:</strong>
|
|
|
713 |
<ul>
|
|
|
714 |
<li><code>Object</code><div class="sub-desc">box An object in the format {x, y, width, height}</div></li>
|
|
|
715 |
</ul>
|
|
|
716 |
</div>
|
|
|
717 |
</div>
|
|
|
718 |
</div>
|
|
|
719 |
</td>
|
|
|
720 |
<td class="msource">BoxComponent</td>
|
|
|
721 |
</tr>
|
|
|
722 |
<tr class="method-row inherited expandable">
|
|
|
723 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
724 |
<td class="sig">
|
|
|
725 |
<a id="Ext.BoxComponent-getEl"></a>
|
|
|
726 |
<b>getEl</b>() : Ext.Element <div class="mdesc">
|
|
|
727 |
<div class="short">Returns the underlying <a ext:cls="Ext.Element" href="output/Ext.Element.html">Ext.Element</a>.</div>
|
|
|
728 |
<div class="long">
|
|
|
729 |
Returns the underlying <a ext:cls="Ext.Element" href="output/Ext.Element.html">Ext.Element</a>. <div class="mdetail-params">
|
|
|
730 |
<strong>Parameters:</strong>
|
|
|
731 |
<ul><li>None.</li> </ul>
|
|
|
732 |
<strong>Returns:</strong>
|
|
|
733 |
<ul>
|
|
|
734 |
<li><code>Ext.Element</code><div class="sub-desc">The element</div></li>
|
|
|
735 |
</ul>
|
|
|
736 |
</div>
|
|
|
737 |
</div>
|
|
|
738 |
</div>
|
|
|
739 |
</td>
|
|
|
740 |
<td class="msource"><a ext:cls="Ext.Component" ext:member="#getEl" href="output/Ext.Component.html#getEl">Component</a></td>
|
|
|
741 |
</tr>
|
|
|
742 |
<tr class="method-row inherited alt expandable">
|
|
|
743 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
744 |
<td class="sig">
|
|
|
745 |
<a id="Ext.BoxComponent-getId"></a>
|
|
|
746 |
<b>getId</b>() : String <div class="mdesc">
|
|
|
747 |
<div class="short">Returns the id of this component.</div>
|
|
|
748 |
<div class="long">
|
|
|
749 |
Returns the id of this component. <div class="mdetail-params">
|
|
|
750 |
<strong>Parameters:</strong>
|
|
|
751 |
<ul><li>None.</li> </ul>
|
|
|
752 |
<strong>Returns:</strong>
|
|
|
753 |
<ul>
|
|
|
754 |
<li><code>String</code></li>
|
|
|
755 |
</ul>
|
|
|
756 |
</div>
|
|
|
757 |
</div>
|
|
|
758 |
</div>
|
|
|
759 |
</td>
|
|
|
760 |
<td class="msource"><a ext:cls="Ext.Component" ext:member="#getId" href="output/Ext.Component.html#getId">Component</a></td>
|
|
|
761 |
</tr>
|
|
|
762 |
<tr class="method-row inherited expandable">
|
|
|
763 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
764 |
<td class="sig">
|
|
|
765 |
<a id="Ext.BoxComponent-getItemId"></a>
|
|
|
766 |
<b>getItemId</b>() : String <div class="mdesc">
|
|
|
767 |
<div class="short">Returns the item id of this component.</div>
|
|
|
768 |
<div class="long">
|
|
|
769 |
Returns the item id of this component. <div class="mdetail-params">
|
|
|
770 |
<strong>Parameters:</strong>
|
|
|
771 |
<ul><li>None.</li> </ul>
|
|
|
772 |
<strong>Returns:</strong>
|
|
|
773 |
<ul>
|
|
|
774 |
<li><code>String</code></li>
|
|
|
775 |
</ul>
|
|
|
776 |
</div>
|
|
|
777 |
</div>
|
|
|
778 |
</div>
|
|
|
779 |
</td>
|
|
|
780 |
<td class="msource"><a ext:cls="Ext.Component" ext:member="#getItemId" href="output/Ext.Component.html#getItemId">Component</a></td>
|
|
|
781 |
</tr>
|
|
|
782 |
<tr class="method-row alt expandable">
|
|
|
783 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
784 |
<td class="sig">
|
|
|
785 |
<a id="Ext.BoxComponent-getPosition"></a>
|
|
|
786 |
<b>getPosition</b>( <span class="optional" title="Optional">[<code>Boolean local</code>]</span> ) : Array <div class="mdesc">
|
|
|
787 |
<div class="short">Gets the current XY position of the component's underlying element.</div>
|
|
|
788 |
<div class="long">
|
|
|
789 |
Gets the current XY position of the component's underlying element. <div class="mdetail-params">
|
|
|
790 |
<strong>Parameters:</strong>
|
|
|
791 |
<ul><li><code>local</code> : Boolean<div class="sub-desc">(optional) If true the element's left and top are returned instead of page XY (defaults to false)</div></li> </ul>
|
|
|
792 |
<strong>Returns:</strong>
|
|
|
793 |
<ul>
|
|
|
794 |
<li><code>Array</code><div class="sub-desc">The XY position of the element (e.g., [100, 200])</div></li>
|
|
|
795 |
</ul>
|
|
|
796 |
</div>
|
|
|
797 |
</div>
|
|
|
798 |
</div>
|
|
|
799 |
</td>
|
|
|
800 |
<td class="msource">BoxComponent</td>
|
|
|
801 |
</tr>
|
|
|
802 |
<tr class="method-row expandable">
|
|
|
803 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
804 |
<td class="sig">
|
|
|
805 |
<a id="Ext.BoxComponent-getSize"></a>
|
|
|
806 |
<b>getSize</b>() : Object <div class="mdesc">
|
|
|
807 |
<div class="short">Gets the current size of the component's underlying element.</div>
|
|
|
808 |
<div class="long">
|
|
|
809 |
Gets the current size of the component's underlying element. <div class="mdetail-params">
|
|
|
810 |
<strong>Parameters:</strong>
|
|
|
811 |
<ul><li>None.</li> </ul>
|
|
|
812 |
<strong>Returns:</strong>
|
|
|
813 |
<ul>
|
|
|
814 |
<li><code>Object</code><div class="sub-desc">An object containing the element's size {width: (element width), height: (element height)}</div></li>
|
|
|
815 |
</ul>
|
|
|
816 |
</div>
|
|
|
817 |
</div>
|
|
|
818 |
</div>
|
|
|
819 |
</td>
|
|
|
820 |
<td class="msource">BoxComponent</td>
|
|
|
821 |
</tr>
|
|
|
822 |
<tr class="method-row inherited alt expandable">
|
|
|
823 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
824 |
<td class="sig">
|
|
|
825 |
<a id="Ext.BoxComponent-getXType"></a>
|
|
|
826 |
<b>getXType</b>() : String <div class="mdesc">
|
|
|
827 |
<div class="short">Gets the xtype for this component as registered with Ext.ComponentMgr. For a list of all
|
|
|
828 |
available xtypes, see the Ex...</div>
|
|
|
829 |
<div class="long">
|
|
|
830 |
Gets the xtype for this component as registered with <a ext:cls="Ext.ComponentMgr" href="output/Ext.ComponentMgr.html">Ext.ComponentMgr</a>. For a list of all
|
|
|
831 |
available xtypes, see the <a ext:cls="Ext.Component" href="output/Ext.Component.html">Ext.Component</a> header. Example usage:
|
|
|
832 |
<pre><code>var t = <b>new</b> Ext.form.TextField();
|
|
|
833 |
alert(t.getXType()); // alerts <em>'textfield'</em></code></pre> <div class="mdetail-params">
|
|
|
834 |
<strong>Parameters:</strong>
|
|
|
835 |
<ul><li>None.</li> </ul>
|
|
|
836 |
<strong>Returns:</strong>
|
|
|
837 |
<ul>
|
|
|
838 |
<li><code>String</code><div class="sub-desc">The xtype</div></li>
|
|
|
839 |
</ul>
|
|
|
840 |
</div>
|
|
|
841 |
</div>
|
|
|
842 |
</div>
|
|
|
843 |
</td>
|
|
|
844 |
<td class="msource"><a ext:cls="Ext.Component" ext:member="#getXType" href="output/Ext.Component.html#getXType">Component</a></td>
|
|
|
845 |
</tr>
|
|
|
846 |
<tr class="method-row inherited expandable">
|
|
|
847 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
848 |
<td class="sig">
|
|
|
849 |
<a id="Ext.BoxComponent-getXTypes"></a>
|
|
|
850 |
<b>getXTypes</b>() : String <div class="mdesc">
|
|
|
851 |
<div class="short">Returns this component's xtype hierarchy as a slash-delimited string. For a list of all
|
|
|
852 |
available xtypes, see the Ext...</div>
|
|
|
853 |
<div class="long">
|
|
|
854 |
Returns this component's xtype hierarchy as a slash-delimited string. For a list of all
|
|
|
855 |
available xtypes, see the <a ext:cls="Ext.Component" href="output/Ext.Component.html">Ext.Component</a> header. Example usage:
|
|
|
856 |
<pre><code>
|
|
|
857 |
var t = new Ext.form.TextField();
|
|
|
858 |
alert(t.getXTypes()); // alerts 'component/box/field/textfield'</pre></code> <div class="mdetail-params">
|
|
|
859 |
<strong>Parameters:</strong>
|
|
|
860 |
<ul><li>None.</li> </ul>
|
|
|
861 |
<strong>Returns:</strong>
|
|
|
862 |
<ul>
|
|
|
863 |
<li><code>String</code><div class="sub-desc">The xtype hierarchy string</div></li>
|
|
|
864 |
</ul>
|
|
|
865 |
</div>
|
|
|
866 |
</div>
|
|
|
867 |
</div>
|
|
|
868 |
</td>
|
|
|
869 |
<td class="msource"><a ext:cls="Ext.Component" ext:member="#getXTypes" href="output/Ext.Component.html#getXTypes">Component</a></td>
|
|
|
870 |
</tr>
|
|
|
871 |
<tr class="method-row inherited alt expandable">
|
|
|
872 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
873 |
<td class="sig">
|
|
|
874 |
<a id="Ext.BoxComponent-hasListener"></a>
|
|
|
875 |
<b>hasListener</b>( <code>String eventName</code> ) : Boolean <div class="mdesc">
|
|
|
876 |
<div class="short">Checks to see if this object has any listeners for a specified event</div>
|
|
|
877 |
<div class="long">
|
|
|
878 |
Checks to see if this object has any listeners for a specified event <div class="mdetail-params">
|
|
|
879 |
<strong>Parameters:</strong>
|
|
|
880 |
<ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to check for</div></li> </ul>
|
|
|
881 |
<strong>Returns:</strong>
|
|
|
882 |
<ul>
|
|
|
883 |
<li><code>Boolean</code><div class="sub-desc">True if the event is being listened for, else false</div></li>
|
|
|
884 |
</ul>
|
|
|
885 |
</div>
|
|
|
886 |
</div>
|
|
|
887 |
</div>
|
|
|
888 |
</td>
|
|
|
889 |
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#hasListener" href="output/Ext.util.Observable.html#hasListener">Observable</a></td>
|
|
|
890 |
</tr>
|
|
|
891 |
<tr class="method-row inherited expandable">
|
|
|
892 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
893 |
<td class="sig">
|
|
|
894 |
<a id="Ext.BoxComponent-hide"></a>
|
|
|
895 |
<b>hide</b>() : Ext.Component <div class="mdesc">
|
|
|
896 |
<div class="short">Hide this component.</div>
|
|
|
897 |
<div class="long">
|
|
|
898 |
Hide this component. <div class="mdetail-params">
|
|
|
899 |
<strong>Parameters:</strong>
|
|
|
900 |
<ul><li>None.</li> </ul>
|
|
|
901 |
<strong>Returns:</strong>
|
|
|
902 |
<ul>
|
|
|
903 |
<li><code>Ext.Component</code><div class="sub-desc">this</div></li>
|
|
|
904 |
</ul>
|
|
|
905 |
</div>
|
|
|
906 |
</div>
|
|
|
907 |
</div>
|
|
|
908 |
</td>
|
|
|
909 |
<td class="msource"><a ext:cls="Ext.Component" ext:member="#hide" href="output/Ext.Component.html#hide">Component</a></td>
|
|
|
910 |
</tr>
|
|
|
911 |
<tr class="method-row alt expandable">
|
|
|
912 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
913 |
<td class="sig">
|
|
|
914 |
<a id="Ext.BoxComponent-initComponent"></a>
|
|
|
915 |
<b>initComponent</b>() : void <div class="mdesc">
|
|
|
916 |
<div class="short">// private internal config</div>
|
|
|
917 |
<div class="long">
|
|
|
918 |
// private internal config <div class="mdetail-params">
|
|
|
919 |
<strong>Parameters:</strong>
|
|
|
920 |
<ul><li>None.</li> </ul>
|
|
|
921 |
<strong>Returns:</strong>
|
|
|
922 |
<ul>
|
|
|
923 |
<li><code>void</code></li>
|
|
|
924 |
</ul>
|
|
|
925 |
</div>
|
|
|
926 |
</div>
|
|
|
927 |
</div>
|
|
|
928 |
</td>
|
|
|
929 |
<td class="msource">BoxComponent</td>
|
|
|
930 |
</tr>
|
|
|
931 |
<tr class="method-row inherited expandable">
|
|
|
932 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
933 |
<td class="sig">
|
|
|
934 |
<a id="Ext.BoxComponent-isVisible"></a>
|
|
|
935 |
<b>isVisible</b>() : void <div class="mdesc">
|
|
|
936 |
<div class="short">Returns true if this component is visible.</div>
|
|
|
937 |
<div class="long">
|
|
|
938 |
Returns true if this component is visible. <div class="mdetail-params">
|
|
|
939 |
<strong>Parameters:</strong>
|
|
|
940 |
<ul><li>None.</li> </ul>
|
|
|
941 |
<strong>Returns:</strong>
|
|
|
942 |
<ul>
|
|
|
943 |
<li><code>void</code></li>
|
|
|
944 |
</ul>
|
|
|
945 |
</div>
|
|
|
946 |
</div>
|
|
|
947 |
</div>
|
|
|
948 |
</td>
|
|
|
949 |
<td class="msource"><a ext:cls="Ext.Component" ext:member="#isVisible" href="output/Ext.Component.html#isVisible">Component</a></td>
|
|
|
950 |
</tr>
|
|
|
951 |
<tr class="method-row inherited alt expandable">
|
|
|
952 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
953 |
<td class="sig">
|
|
|
954 |
<a id="Ext.BoxComponent-isXType"></a>
|
|
|
955 |
<b>isXType</b>( <code>String xtype</code>, <span class="optional" title="Optional">[<code>Boolean shallow</code>]</span> ) : void <div class="mdesc">
|
|
|
956 |
<div class="short">Tests whether or not this component is of a specific xtype. This can test whether this component is descended
|
|
|
957 |
from th...</div>
|
|
|
958 |
<div class="long">
|
|
|
959 |
Tests whether or not this component is of a specific xtype. This can test whether this component is descended
|
|
|
960 |
from the xtype (default) or whether it is directly of the xtype specified (shallow = true). For a list of all
|
|
|
961 |
available xtypes, see the <a ext:cls="Ext.Component" href="output/Ext.Component.html">Ext.Component</a> header. Example usage:
|
|
|
962 |
<pre><code>var t = <b>new</b> Ext.form.TextField();
|
|
|
963 |
<b>var</b> isText = t.isXType(<em>'textfield'</em>); <i>// true</i>
|
|
|
964 |
<b>var</b> isBoxSubclass = t.isXType(<em>'box'</em>); <i>// true, descended from BoxComponent</i>
|
|
|
965 |
<b>var</b> isBoxInstance = t.isXType(<em>'box'</em>, true); // false, not a direct BoxComponent instance</code></pre> <div class="mdetail-params">
|
|
|
966 |
<strong>Parameters:</strong>
|
|
|
967 |
<ul><li><code>xtype</code> : String<div class="sub-desc">The xtype to check for this component</div></li><li><code>shallow</code> : Boolean<div class="sub-desc">(optional) False to check whether this component is descended from the xtype (this is
|
|
|
968 |
the default), or true to check whether this component is directly of the specified xtype.</div></li> </ul>
|
|
|
969 |
<strong>Returns:</strong>
|
|
|
970 |
<ul>
|
|
|
971 |
<li><code>void</code></li>
|
|
|
972 |
</ul>
|
|
|
973 |
</div>
|
|
|
974 |
</div>
|
|
|
975 |
</div>
|
|
|
976 |
</td>
|
|
|
977 |
<td class="msource"><a ext:cls="Ext.Component" ext:member="#isXType" href="output/Ext.Component.html#isXType">Component</a></td>
|
|
|
978 |
</tr>
|
|
|
979 |
<tr class="method-row inherited expandable">
|
|
|
980 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
981 |
<td class="sig">
|
|
|
982 |
<a id="Ext.BoxComponent-on"></a>
|
|
|
983 |
<b>on</b>( <code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Object options</code>]</span> ) : void <div class="mdesc">
|
|
|
984 |
<div class="short">Appends an event handler to this element (shorthand for addListener)</div>
|
|
|
985 |
<div class="long">
|
|
|
986 |
Appends an event handler to this element (shorthand for addListener) <div class="mdetail-params">
|
|
|
987 |
<strong>Parameters:</strong>
|
|
|
988 |
<ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope in which to execute the handler
|
|
|
989 |
function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional)</div></li> </ul>
|
|
|
990 |
<strong>Returns:</strong>
|
|
|
991 |
<ul>
|
|
|
992 |
<li><code>void</code></li>
|
|
|
993 |
</ul>
|
|
|
994 |
</div>
|
|
|
995 |
</div>
|
|
|
996 |
</div>
|
|
|
997 |
</td>
|
|
|
998 |
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#on" href="output/Ext.util.Observable.html#on">Observable</a></td>
|
|
|
999 |
</tr>
|
|
|
1000 |
<tr class="method-row inherited alt expandable">
|
|
|
1001 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
1002 |
<td class="sig">
|
|
|
1003 |
<a id="Ext.BoxComponent-purgeListeners"></a>
|
|
|
1004 |
<b>purgeListeners</b>() : void <div class="mdesc">
|
|
|
1005 |
<div class="short">Removes all listeners for this object</div>
|
|
|
1006 |
<div class="long">
|
|
|
1007 |
Removes all listeners for this object <div class="mdetail-params">
|
|
|
1008 |
<strong>Parameters:</strong>
|
|
|
1009 |
<ul><li>None.</li> </ul>
|
|
|
1010 |
<strong>Returns:</strong>
|
|
|
1011 |
<ul>
|
|
|
1012 |
<li><code>void</code></li>
|
|
|
1013 |
</ul>
|
|
|
1014 |
</div>
|
|
|
1015 |
</div>
|
|
|
1016 |
</div>
|
|
|
1017 |
</td>
|
|
|
1018 |
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#purgeListeners" href="output/Ext.util.Observable.html#purgeListeners">Observable</a></td>
|
|
|
1019 |
</tr>
|
|
|
1020 |
<tr class="method-row inherited expandable">
|
|
|
1021 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
1022 |
<td class="sig">
|
|
|
1023 |
<a id="Ext.BoxComponent-removeClass"></a>
|
|
|
1024 |
<b>removeClass</b>( <code>string cls</code> ) : void <div class="mdesc">
|
|
|
1025 |
<div class="short">Removes a CSS class from the component's underlying element.</div>
|
|
|
1026 |
<div class="long">
|
|
|
1027 |
Removes a CSS class from the component's underlying element. <div class="mdetail-params">
|
|
|
1028 |
<strong>Parameters:</strong>
|
|
|
1029 |
<ul><li><code>cls</code> : string<div class="sub-desc">The CSS class name to remove</div></li> </ul>
|
|
|
1030 |
<strong>Returns:</strong>
|
|
|
1031 |
<ul>
|
|
|
1032 |
<li><code>void</code></li>
|
|
|
1033 |
</ul>
|
|
|
1034 |
</div>
|
|
|
1035 |
</div>
|
|
|
1036 |
</div>
|
|
|
1037 |
</td>
|
|
|
1038 |
<td class="msource"><a ext:cls="Ext.Component" ext:member="#removeClass" href="output/Ext.Component.html#removeClass">Component</a></td>
|
|
|
1039 |
</tr>
|
|
|
1040 |
<tr class="method-row inherited alt expandable">
|
|
|
1041 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
1042 |
<td class="sig">
|
|
|
1043 |
<a id="Ext.BoxComponent-removeListener"></a>
|
|
|
1044 |
<b>removeListener</b>( <code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span> ) : void <div class="mdesc">
|
|
|
1045 |
<div class="short">Removes a listener</div>
|
|
|
1046 |
<div class="long">
|
|
|
1047 |
Removes a listener <div class="mdetail-params">
|
|
|
1048 |
<strong>Parameters:</strong>
|
|
|
1049 |
<ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (this object) for the handler</div></li> </ul>
|
|
|
1050 |
<strong>Returns:</strong>
|
|
|
1051 |
<ul>
|
|
|
1052 |
<li><code>void</code></li>
|
|
|
1053 |
</ul>
|
|
|
1054 |
</div>
|
|
|
1055 |
</div>
|
|
|
1056 |
</div>
|
|
|
1057 |
</td>
|
|
|
1058 |
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#removeListener" href="output/Ext.util.Observable.html#removeListener">Observable</a></td>
|
|
|
1059 |
</tr>
|
|
|
1060 |
<tr class="method-row inherited expandable">
|
|
|
1061 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
1062 |
<td class="sig">
|
|
|
1063 |
<a id="Ext.BoxComponent-render"></a>
|
|
|
1064 |
<b>render</b>( <span class="optional" title="Optional">[<code>Mixed container</code>]</span>, <span class="optional" title="Optional">[<code>String/Number position</code>]</span> ) : void <div class="mdesc">
|
|
|
1065 |
<div class="short">If this is a lazy rendering component, render it to its container element.</div>
|
|
|
1066 |
<div class="long">
|
|
|
1067 |
If this is a lazy rendering component, render it to its container element. <div class="mdetail-params">
|
|
|
1068 |
<strong>Parameters:</strong>
|
|
|
1069 |
<ul><li><code>container</code> : Mixed<div class="sub-desc">(optional) The element this component should be rendered into. If it is being
|
|
|
1070 |
applied to existing markup, this should be left off.</div></li><li><code>position</code> : String/Number<div class="sub-desc">(optional) The element ID or DOM node index within the container <b>before</b>
|
|
|
1071 |
which this component will be inserted (defaults to appending to the end of the container)</div></li> </ul>
|
|
|
1072 |
<strong>Returns:</strong>
|
|
|
1073 |
<ul>
|
|
|
1074 |
<li><code>void</code></li>
|
|
|
1075 |
</ul>
|
|
|
1076 |
</div>
|
|
|
1077 |
</div>
|
|
|
1078 |
</div>
|
|
|
1079 |
</td>
|
|
|
1080 |
<td class="msource"><a ext:cls="Ext.Component" ext:member="#render" href="output/Ext.Component.html#render">Component</a></td>
|
|
|
1081 |
</tr>
|
|
|
1082 |
<tr class="method-row inherited alt expandable">
|
|
|
1083 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
1084 |
<td class="sig">
|
|
|
1085 |
<a id="Ext.BoxComponent-resumeEvents"></a>
|
|
|
1086 |
<b>resumeEvents</b>() : void <div class="mdesc">
|
|
|
1087 |
<div class="short">Resume firing events. (see <a ext:cls="Ext.util.Observable" ext:member="suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">suspendEvents</a>)</div>
|
|
|
1088 |
<div class="long">
|
|
|
1089 |
Resume firing events. (see <a ext:cls="Ext.util.Observable" ext:member="suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">suspendEvents</a>) <div class="mdetail-params">
|
|
|
1090 |
<strong>Parameters:</strong>
|
|
|
1091 |
<ul><li>None.</li> </ul>
|
|
|
1092 |
<strong>Returns:</strong>
|
|
|
1093 |
<ul>
|
|
|
1094 |
<li><code>void</code></li>
|
|
|
1095 |
</ul>
|
|
|
1096 |
</div>
|
|
|
1097 |
</div>
|
|
|
1098 |
</div>
|
|
|
1099 |
</td>
|
|
|
1100 |
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">Observable</a></td>
|
|
|
1101 |
</tr>
|
|
|
1102 |
<tr class="method-row inherited expandable">
|
|
|
1103 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
1104 |
<td class="sig">
|
|
|
1105 |
<a id="Ext.BoxComponent-setDisabled"></a>
|
|
|
1106 |
<b>setDisabled</b>( <code>Boolean disabled</code> ) : void <div class="mdesc">
|
|
|
1107 |
<div class="short">Convenience function for setting disabled/enabled by boolean.</div>
|
|
|
1108 |
<div class="long">
|
|
|
1109 |
Convenience function for setting disabled/enabled by boolean. <div class="mdetail-params">
|
|
|
1110 |
<strong>Parameters:</strong>
|
|
|
1111 |
<ul><li><code>disabled</code> : Boolean<div class="sub-desc"></div></li> </ul>
|
|
|
1112 |
<strong>Returns:</strong>
|
|
|
1113 |
<ul>
|
|
|
1114 |
<li><code>void</code></li>
|
|
|
1115 |
</ul>
|
|
|
1116 |
</div>
|
|
|
1117 |
</div>
|
|
|
1118 |
</div>
|
|
|
1119 |
</td>
|
|
|
1120 |
<td class="msource"><a ext:cls="Ext.Component" ext:member="#setDisabled" href="output/Ext.Component.html#setDisabled">Component</a></td>
|
|
|
1121 |
</tr>
|
|
|
1122 |
<tr class="method-row alt expandable">
|
|
|
1123 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
1124 |
<td class="sig">
|
|
|
1125 |
<a id="Ext.BoxComponent-setHeight"></a>
|
|
|
1126 |
<b>setHeight</b>( <code>Number height</code> ) : Ext.BoxComponent <div class="mdesc">
|
|
|
1127 |
<div class="short">Sets the height of the component. This method fires the resize event.</div>
|
|
|
1128 |
<div class="long">
|
|
|
1129 |
Sets the height of the component. This method fires the resize event. <div class="mdetail-params">
|
|
|
1130 |
<strong>Parameters:</strong>
|
|
|
1131 |
<ul><li><code>height</code> : Number<div class="sub-desc">The new height to set</div></li> </ul>
|
|
|
1132 |
<strong>Returns:</strong>
|
|
|
1133 |
<ul>
|
|
|
1134 |
<li><code>Ext.BoxComponent</code><div class="sub-desc">this</div></li>
|
|
|
1135 |
</ul>
|
|
|
1136 |
</div>
|
|
|
1137 |
</div>
|
|
|
1138 |
</div>
|
|
|
1139 |
</td>
|
|
|
1140 |
<td class="msource">BoxComponent</td>
|
|
|
1141 |
</tr>
|
|
|
1142 |
<tr class="method-row expandable">
|
|
|
1143 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
1144 |
<td class="sig">
|
|
|
1145 |
<a id="Ext.BoxComponent-setPagePosition"></a>
|
|
|
1146 |
<b>setPagePosition</b>( <code>Number x</code>, <code>Number y</code> ) : Ext.BoxComponent <div class="mdesc">
|
|
|
1147 |
<div class="short">Sets the page XY position of the component. To set the left and top instead, use setPosition.
|
|
|
1148 |
This method fires the ...</div>
|
|
|
1149 |
<div class="long">
|
|
|
1150 |
Sets the page XY position of the component. To set the left and top instead, use <a ext:cls="Ext.BoxComponent" ext:member="setPosition" href="output/Ext.BoxComponent.html#setPosition">setPosition</a>.
|
|
|
1151 |
This method fires the move event. <div class="mdetail-params">
|
|
|
1152 |
<strong>Parameters:</strong>
|
|
|
1153 |
<ul><li><code>x</code> : Number<div class="sub-desc">The new x position</div></li><li><code>y</code> : Number<div class="sub-desc">The new y position</div></li> </ul>
|
|
|
1154 |
<strong>Returns:</strong>
|
|
|
1155 |
<ul>
|
|
|
1156 |
<li><code>Ext.BoxComponent</code><div class="sub-desc">this</div></li>
|
|
|
1157 |
</ul>
|
|
|
1158 |
</div>
|
|
|
1159 |
</div>
|
|
|
1160 |
</div>
|
|
|
1161 |
</td>
|
|
|
1162 |
<td class="msource">BoxComponent</td>
|
|
|
1163 |
</tr>
|
|
|
1164 |
<tr class="method-row alt expandable">
|
|
|
1165 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
1166 |
<td class="sig">
|
|
|
1167 |
<a id="Ext.BoxComponent-setPosition"></a>
|
|
|
1168 |
<b>setPosition</b>( <code>Number left</code>, <code>Number top</code> ) : Ext.BoxComponent <div class="mdesc">
|
|
|
1169 |
<div class="short">Sets the left and top of the component. To set the page XY position instead, use setPagePosition.
|
|
|
1170 |
This method fires ...</div>
|
|
|
1171 |
<div class="long">
|
|
|
1172 |
Sets the left and top of the component. To set the page XY position instead, use <a ext:cls="Ext.BoxComponent" ext:member="setPagePosition" href="output/Ext.BoxComponent.html#setPagePosition">setPagePosition</a>.
|
|
|
1173 |
This method fires the move event. <div class="mdetail-params">
|
|
|
1174 |
<strong>Parameters:</strong>
|
|
|
1175 |
<ul><li><code>left</code> : Number<div class="sub-desc">The new left</div></li><li><code>top</code> : Number<div class="sub-desc">The new top</div></li> </ul>
|
|
|
1176 |
<strong>Returns:</strong>
|
|
|
1177 |
<ul>
|
|
|
1178 |
<li><code>Ext.BoxComponent</code><div class="sub-desc">this</div></li>
|
|
|
1179 |
</ul>
|
|
|
1180 |
</div>
|
|
|
1181 |
</div>
|
|
|
1182 |
</div>
|
|
|
1183 |
</td>
|
|
|
1184 |
<td class="msource">BoxComponent</td>
|
|
|
1185 |
</tr>
|
|
|
1186 |
<tr class="method-row expandable">
|
|
|
1187 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
1188 |
<td class="sig">
|
|
|
1189 |
<a id="Ext.BoxComponent-setSize"></a>
|
|
|
1190 |
<b>setSize</b>( <code>Number/Object width</code>, <code>Number height</code> ) : Ext.BoxComponent <div class="mdesc">
|
|
|
1191 |
<div class="short">Sets the width and height of the component. This method fires the resize event. This method can accept
|
|
|
1192 |
either width...</div>
|
|
|
1193 |
<div class="long">
|
|
|
1194 |
Sets the width and height of the component. This method fires the resize event. This method can accept
|
|
|
1195 |
either width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}. <div class="mdetail-params">
|
|
|
1196 |
<strong>Parameters:</strong>
|
|
|
1197 |
<ul><li><code>width</code> : Number/Object<div class="sub-desc">The new width to set, or a size object in the format {width, height}</div></li><li><code>height</code> : Number<div class="sub-desc">The new height to set (not required if a size object is passed as the first arg)</div></li> </ul>
|
|
|
1198 |
<strong>Returns:</strong>
|
|
|
1199 |
<ul>
|
|
|
1200 |
<li><code>Ext.BoxComponent</code><div class="sub-desc">this</div></li>
|
|
|
1201 |
</ul>
|
|
|
1202 |
</div>
|
|
|
1203 |
</div>
|
|
|
1204 |
</div>
|
|
|
1205 |
</td>
|
|
|
1206 |
<td class="msource">BoxComponent</td>
|
|
|
1207 |
</tr>
|
|
|
1208 |
<tr class="method-row inherited alt expandable">
|
|
|
1209 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
1210 |
<td class="sig">
|
|
|
1211 |
<a id="Ext.BoxComponent-setVisible"></a>
|
|
|
1212 |
<b>setVisible</b>( <code>Boolean visible</code> ) : Ext.Component <div class="mdesc">
|
|
|
1213 |
<div class="short">Convenience function to hide or show this component by boolean.</div>
|
|
|
1214 |
<div class="long">
|
|
|
1215 |
Convenience function to hide or show this component by boolean. <div class="mdetail-params">
|
|
|
1216 |
<strong>Parameters:</strong>
|
|
|
1217 |
<ul><li><code>visible</code> : Boolean<div class="sub-desc">True to show, false to hide</div></li> </ul>
|
|
|
1218 |
<strong>Returns:</strong>
|
|
|
1219 |
<ul>
|
|
|
1220 |
<li><code>Ext.Component</code><div class="sub-desc">this</div></li>
|
|
|
1221 |
</ul>
|
|
|
1222 |
</div>
|
|
|
1223 |
</div>
|
|
|
1224 |
</div>
|
|
|
1225 |
</td>
|
|
|
1226 |
<td class="msource"><a ext:cls="Ext.Component" ext:member="#setVisible" href="output/Ext.Component.html#setVisible">Component</a></td>
|
|
|
1227 |
</tr>
|
|
|
1228 |
<tr class="method-row expandable">
|
|
|
1229 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
1230 |
<td class="sig">
|
|
|
1231 |
<a id="Ext.BoxComponent-setWidth"></a>
|
|
|
1232 |
<b>setWidth</b>( <code>Number width</code> ) : Ext.BoxComponent <div class="mdesc">
|
|
|
1233 |
<div class="short">Sets the width of the component. This method fires the resize event.</div>
|
|
|
1234 |
<div class="long">
|
|
|
1235 |
Sets the width of the component. This method fires the resize event. <div class="mdetail-params">
|
|
|
1236 |
<strong>Parameters:</strong>
|
|
|
1237 |
<ul><li><code>width</code> : Number<div class="sub-desc">The new width to set</div></li> </ul>
|
|
|
1238 |
<strong>Returns:</strong>
|
|
|
1239 |
<ul>
|
|
|
1240 |
<li><code>Ext.BoxComponent</code><div class="sub-desc">this</div></li>
|
|
|
1241 |
</ul>
|
|
|
1242 |
</div>
|
|
|
1243 |
</div>
|
|
|
1244 |
</div>
|
|
|
1245 |
</td>
|
|
|
1246 |
<td class="msource">BoxComponent</td>
|
|
|
1247 |
</tr>
|
|
|
1248 |
<tr class="method-row inherited alt expandable">
|
|
|
1249 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
1250 |
<td class="sig">
|
|
|
1251 |
<a id="Ext.BoxComponent-show"></a>
|
|
|
1252 |
<b>show</b>() : Ext.Component <div class="mdesc">
|
|
|
1253 |
<div class="short">Show this component.</div>
|
|
|
1254 |
<div class="long">
|
|
|
1255 |
Show this component. <div class="mdetail-params">
|
|
|
1256 |
<strong>Parameters:</strong>
|
|
|
1257 |
<ul><li>None.</li> </ul>
|
|
|
1258 |
<strong>Returns:</strong>
|
|
|
1259 |
<ul>
|
|
|
1260 |
<li><code>Ext.Component</code><div class="sub-desc">this</div></li>
|
|
|
1261 |
</ul>
|
|
|
1262 |
</div>
|
|
|
1263 |
</div>
|
|
|
1264 |
</div>
|
|
|
1265 |
</td>
|
|
|
1266 |
<td class="msource"><a ext:cls="Ext.Component" ext:member="#show" href="output/Ext.Component.html#show">Component</a></td>
|
|
|
1267 |
</tr>
|
|
|
1268 |
<tr class="method-row inherited expandable">
|
|
|
1269 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
1270 |
<td class="sig">
|
|
|
1271 |
<a id="Ext.BoxComponent-suspendEvents"></a>
|
|
|
1272 |
<b>suspendEvents</b>() : void <div class="mdesc">
|
|
|
1273 |
<div class="short">Suspend the firing of all events. (see <a ext:cls="Ext.util.Observable" ext:member="resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">resumeEvents</a>)</div>
|
|
|
1274 |
<div class="long">
|
|
|
1275 |
Suspend the firing of all events. (see <a ext:cls="Ext.util.Observable" ext:member="resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">resumeEvents</a>) <div class="mdetail-params">
|
|
|
1276 |
<strong>Parameters:</strong>
|
|
|
1277 |
<ul><li>None.</li> </ul>
|
|
|
1278 |
<strong>Returns:</strong>
|
|
|
1279 |
<ul>
|
|
|
1280 |
<li><code>void</code></li>
|
|
|
1281 |
</ul>
|
|
|
1282 |
</div>
|
|
|
1283 |
</div>
|
|
|
1284 |
</div>
|
|
|
1285 |
</td>
|
|
|
1286 |
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">Observable</a></td>
|
|
|
1287 |
</tr>
|
|
|
1288 |
<tr class="method-row alt expandable">
|
|
|
1289 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
1290 |
<td class="sig">
|
|
|
1291 |
<a id="Ext.BoxComponent-syncSize"></a>
|
|
|
1292 |
<b>syncSize</b>() : Ext.BoxComponent <div class="mdesc">
|
|
|
1293 |
<div class="short">Force the component's size to recalculate based on the underlying element's current height and width.</div>
|
|
|
1294 |
<div class="long">
|
|
|
1295 |
Force the component's size to recalculate based on the underlying element's current height and width. <div class="mdetail-params">
|
|
|
1296 |
<strong>Parameters:</strong>
|
|
|
1297 |
<ul><li>None.</li> </ul>
|
|
|
1298 |
<strong>Returns:</strong>
|
|
|
1299 |
<ul>
|
|
|
1300 |
<li><code>Ext.BoxComponent</code><div class="sub-desc">this</div></li>
|
|
|
1301 |
</ul>
|
|
|
1302 |
</div>
|
|
|
1303 |
</div>
|
|
|
1304 |
</div>
|
|
|
1305 |
</td>
|
|
|
1306 |
<td class="msource">BoxComponent</td>
|
|
|
1307 |
</tr>
|
|
|
1308 |
<tr class="method-row inherited expandable">
|
|
|
1309 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
1310 |
<td class="sig">
|
|
|
1311 |
<a id="Ext.BoxComponent-un"></a>
|
|
|
1312 |
<b>un</b>( <code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span> ) : void <div class="mdesc">
|
|
|
1313 |
<div class="short">Removes a listener (shorthand for removeListener)</div>
|
|
|
1314 |
<div class="long">
|
|
|
1315 |
Removes a listener (shorthand for removeListener) <div class="mdetail-params">
|
|
|
1316 |
<strong>Parameters:</strong>
|
|
|
1317 |
<ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (this object) for the handler</div></li> </ul>
|
|
|
1318 |
<strong>Returns:</strong>
|
|
|
1319 |
<ul>
|
|
|
1320 |
<li><code>void</code></li>
|
|
|
1321 |
</ul>
|
|
|
1322 |
</div>
|
|
|
1323 |
</div>
|
|
|
1324 |
</div>
|
|
|
1325 |
</td>
|
|
|
1326 |
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#un" href="output/Ext.util.Observable.html#un">Observable</a></td>
|
|
|
1327 |
</tr>
|
|
|
1328 |
<tr class="method-row alt expandable">
|
|
|
1329 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
1330 |
<td class="sig">
|
|
|
1331 |
<a id="Ext.BoxComponent-updateBox"></a>
|
|
|
1332 |
<b>updateBox</b>( <code>Object box</code> ) : Ext.BoxComponent <div class="mdesc">
|
|
|
1333 |
<div class="short">Sets the current box measurements of the component's underlying element.</div>
|
|
|
1334 |
<div class="long">
|
|
|
1335 |
Sets the current box measurements of the component's underlying element. <div class="mdetail-params">
|
|
|
1336 |
<strong>Parameters:</strong>
|
|
|
1337 |
<ul><li><code>box</code> : Object<div class="sub-desc">An object in the format {x, y, width, height}</div></li> </ul>
|
|
|
1338 |
<strong>Returns:</strong>
|
|
|
1339 |
<ul>
|
|
|
1340 |
<li><code>Ext.BoxComponent</code><div class="sub-desc">this</div></li>
|
|
|
1341 |
</ul>
|
|
|
1342 |
</div>
|
|
|
1343 |
</div>
|
|
|
1344 |
</div>
|
|
|
1345 |
</td>
|
|
|
1346 |
<td class="msource">BoxComponent</td>
|
|
|
1347 |
</tr>
|
|
|
1348 |
</table>
|
|
|
1349 |
<a id="Ext.BoxComponent-events"></a>
|
|
|
1350 |
<h2>Public Events</h2>
|
|
|
1351 |
<table cellspacing="0" class="member-table">
|
|
|
1352 |
<tr>
|
|
|
1353 |
<th class="sig-header" colspan="2">Event</th>
|
|
|
1354 |
<th class="msource-header">Defined By</th>
|
|
|
1355 |
</tr>
|
|
|
1356 |
<tr class="event-row inherited expandable">
|
|
|
1357 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
1358 |
<td class="sig">
|
|
|
1359 |
<a id="Ext.BoxComponent-beforedestroy"></a>
|
|
|
1360 |
<b>beforedestroy</b> : ( <code>Ext.Component this</code> ) <div class="mdesc">
|
|
|
1361 |
<div class="short">Fires before the component is destroyed. Return false to stop the destroy.</div>
|
|
|
1362 |
<div class="long">
|
|
|
1363 |
Fires before the component is destroyed. Return false to stop the destroy. <div class="mdetail-params">
|
|
|
1364 |
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
|
|
|
1365 |
<ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li> </ul>
|
|
|
1366 |
</div>
|
|
|
1367 |
</div>
|
|
|
1368 |
</div>
|
|
|
1369 |
</td>
|
|
|
1370 |
<td class="msource"><a ext:cls="Ext.Component" ext:member="#event-beforedestroy" href="output/Ext.Component.html#event-beforedestroy">Component</a></td>
|
|
|
1371 |
</tr>
|
|
|
1372 |
<tr class="event-row inherited alt expandable">
|
|
|
1373 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
1374 |
<td class="sig">
|
|
|
1375 |
<a id="Ext.BoxComponent-beforehide"></a>
|
|
|
1376 |
<b>beforehide</b> : ( <code>Ext.Component this</code> ) <div class="mdesc">
|
|
|
1377 |
<div class="short">Fires before the component is hidden. Return false to stop the hide.</div>
|
|
|
1378 |
<div class="long">
|
|
|
1379 |
Fires before the component is hidden. Return false to stop the hide. <div class="mdetail-params">
|
|
|
1380 |
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
|
|
|
1381 |
<ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li> </ul>
|
|
|
1382 |
</div>
|
|
|
1383 |
</div>
|
|
|
1384 |
</div>
|
|
|
1385 |
</td>
|
|
|
1386 |
<td class="msource"><a ext:cls="Ext.Component" ext:member="#event-beforehide" href="output/Ext.Component.html#event-beforehide">Component</a></td>
|
|
|
1387 |
</tr>
|
|
|
1388 |
<tr class="event-row inherited expandable">
|
|
|
1389 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
1390 |
<td class="sig">
|
|
|
1391 |
<a id="Ext.BoxComponent-beforerender"></a>
|
|
|
1392 |
<b>beforerender</b> : ( <code>Ext.Component this</code> ) <div class="mdesc">
|
|
|
1393 |
<div class="short">Fires before the component is rendered. Return false to stop the render.</div>
|
|
|
1394 |
<div class="long">
|
|
|
1395 |
Fires before the component is rendered. Return false to stop the render. <div class="mdetail-params">
|
|
|
1396 |
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
|
|
|
1397 |
<ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li> </ul>
|
|
|
1398 |
</div>
|
|
|
1399 |
</div>
|
|
|
1400 |
</div>
|
|
|
1401 |
</td>
|
|
|
1402 |
<td class="msource"><a ext:cls="Ext.Component" ext:member="#event-beforerender" href="output/Ext.Component.html#event-beforerender">Component</a></td>
|
|
|
1403 |
</tr>
|
|
|
1404 |
<tr class="event-row inherited alt expandable">
|
|
|
1405 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
1406 |
<td class="sig">
|
|
|
1407 |
<a id="Ext.BoxComponent-beforeshow"></a>
|
|
|
1408 |
<b>beforeshow</b> : ( <code>Ext.Component this</code> ) <div class="mdesc">
|
|
|
1409 |
<div class="short">Fires before the component is shown. Return false to stop the show.</div>
|
|
|
1410 |
<div class="long">
|
|
|
1411 |
Fires before the component is shown. Return false to stop the show. <div class="mdetail-params">
|
|
|
1412 |
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
|
|
|
1413 |
<ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li> </ul>
|
|
|
1414 |
</div>
|
|
|
1415 |
</div>
|
|
|
1416 |
</div>
|
|
|
1417 |
</td>
|
|
|
1418 |
<td class="msource"><a ext:cls="Ext.Component" ext:member="#event-beforeshow" href="output/Ext.Component.html#event-beforeshow">Component</a></td>
|
|
|
1419 |
</tr>
|
|
|
1420 |
<tr class="event-row inherited expandable">
|
|
|
1421 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
1422 |
<td class="sig">
|
|
|
1423 |
<a id="Ext.BoxComponent-beforestaterestore"></a>
|
|
|
1424 |
<b>beforestaterestore</b> : ( <code>Ext.Component this</code>, <code>Object state</code> ) <div class="mdesc">
|
|
|
1425 |
<div class="short">Fires before the state of the component is restored. Return false to stop the restore.</div>
|
|
|
1426 |
<div class="long">
|
|
|
1427 |
Fires before the state of the component is restored. Return false to stop the restore. <div class="mdetail-params">
|
|
|
1428 |
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
|
|
|
1429 |
<ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li><li><code>state</code> : Object<div class="sub-desc">The hash of state values</div></li> </ul>
|
|
|
1430 |
</div>
|
|
|
1431 |
</div>
|
|
|
1432 |
</div>
|
|
|
1433 |
</td>
|
|
|
1434 |
<td class="msource"><a ext:cls="Ext.Component" ext:member="#event-beforestaterestore" href="output/Ext.Component.html#event-beforestaterestore">Component</a></td>
|
|
|
1435 |
</tr>
|
|
|
1436 |
<tr class="event-row inherited alt expandable">
|
|
|
1437 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
1438 |
<td class="sig">
|
|
|
1439 |
<a id="Ext.BoxComponent-beforestatesave"></a>
|
|
|
1440 |
<b>beforestatesave</b> : ( <code>Ext.Component this</code>, <code>Object state</code> ) <div class="mdesc">
|
|
|
1441 |
<div class="short">Fires before the state of the component is saved to the configured state provider. Return false to stop the save.</div>
|
|
|
1442 |
<div class="long">
|
|
|
1443 |
Fires before the state of the component is saved to the configured state provider. Return false to stop the save. <div class="mdetail-params">
|
|
|
1444 |
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
|
|
|
1445 |
<ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li><li><code>state</code> : Object<div class="sub-desc">The hash of state values</div></li> </ul>
|
|
|
1446 |
</div>
|
|
|
1447 |
</div>
|
|
|
1448 |
</div>
|
|
|
1449 |
</td>
|
|
|
1450 |
<td class="msource"><a ext:cls="Ext.Component" ext:member="#event-beforestatesave" href="output/Ext.Component.html#event-beforestatesave">Component</a></td>
|
|
|
1451 |
</tr>
|
|
|
1452 |
<tr class="event-row inherited expandable">
|
|
|
1453 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
1454 |
<td class="sig">
|
|
|
1455 |
<a id="Ext.BoxComponent-destroy"></a>
|
|
|
1456 |
<b>destroy</b> : ( <code>Ext.Component this</code> ) <div class="mdesc">
|
|
|
1457 |
<div class="short">Fires after the component is destroyed.</div>
|
|
|
1458 |
<div class="long">
|
|
|
1459 |
Fires after the component is destroyed. <div class="mdetail-params">
|
|
|
1460 |
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
|
|
|
1461 |
<ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li> </ul>
|
|
|
1462 |
</div>
|
|
|
1463 |
</div>
|
|
|
1464 |
</div>
|
|
|
1465 |
</td>
|
|
|
1466 |
<td class="msource"><a ext:cls="Ext.Component" ext:member="#event-destroy" href="output/Ext.Component.html#event-destroy">Component</a></td>
|
|
|
1467 |
</tr>
|
|
|
1468 |
<tr class="event-row inherited alt expandable">
|
|
|
1469 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
1470 |
<td class="sig">
|
|
|
1471 |
<a id="Ext.BoxComponent-disable"></a>
|
|
|
1472 |
<b>disable</b> : ( <code>Ext.Component this</code> ) <div class="mdesc">
|
|
|
1473 |
<div class="short">Fires after the component is disabled.</div>
|
|
|
1474 |
<div class="long">
|
|
|
1475 |
Fires after the component is disabled. <div class="mdetail-params">
|
|
|
1476 |
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
|
|
|
1477 |
<ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li> </ul>
|
|
|
1478 |
</div>
|
|
|
1479 |
</div>
|
|
|
1480 |
</div>
|
|
|
1481 |
</td>
|
|
|
1482 |
<td class="msource"><a ext:cls="Ext.Component" ext:member="#event-disable" href="output/Ext.Component.html#event-disable">Component</a></td>
|
|
|
1483 |
</tr>
|
|
|
1484 |
<tr class="event-row inherited expandable">
|
|
|
1485 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
1486 |
<td class="sig">
|
|
|
1487 |
<a id="Ext.BoxComponent-enable"></a>
|
|
|
1488 |
<b>enable</b> : ( <code>Ext.Component this</code> ) <div class="mdesc">
|
|
|
1489 |
<div class="short">Fires after the component is enabled.</div>
|
|
|
1490 |
<div class="long">
|
|
|
1491 |
Fires after the component is enabled. <div class="mdetail-params">
|
|
|
1492 |
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
|
|
|
1493 |
<ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li> </ul>
|
|
|
1494 |
</div>
|
|
|
1495 |
</div>
|
|
|
1496 |
</div>
|
|
|
1497 |
</td>
|
|
|
1498 |
<td class="msource"><a ext:cls="Ext.Component" ext:member="#event-enable" href="output/Ext.Component.html#event-enable">Component</a></td>
|
|
|
1499 |
</tr>
|
|
|
1500 |
<tr class="event-row inherited alt expandable">
|
|
|
1501 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
1502 |
<td class="sig">
|
|
|
1503 |
<a id="Ext.BoxComponent-hide"></a>
|
|
|
1504 |
<b>hide</b> : ( <code>Ext.Component this</code> ) <div class="mdesc">
|
|
|
1505 |
<div class="short">Fires after the component is hidden.</div>
|
|
|
1506 |
<div class="long">
|
|
|
1507 |
Fires after the component is hidden. <div class="mdetail-params">
|
|
|
1508 |
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
|
|
|
1509 |
<ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li> </ul>
|
|
|
1510 |
</div>
|
|
|
1511 |
</div>
|
|
|
1512 |
</div>
|
|
|
1513 |
</td>
|
|
|
1514 |
<td class="msource"><a ext:cls="Ext.Component" ext:member="#event-hide" href="output/Ext.Component.html#event-hide">Component</a></td>
|
|
|
1515 |
</tr>
|
|
|
1516 |
<tr class="event-row expandable">
|
|
|
1517 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
1518 |
<td class="sig">
|
|
|
1519 |
<a id="Ext.BoxComponent-move"></a>
|
|
|
1520 |
<b>move</b> : ( <code>Ext.Component this</code>, <code>Number x</code>, <code>Number y</code> ) <div class="mdesc">
|
|
|
1521 |
<div class="short">Fires after the component is moved.</div>
|
|
|
1522 |
<div class="long">
|
|
|
1523 |
Fires after the component is moved. <div class="mdetail-params">
|
|
|
1524 |
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
|
|
|
1525 |
<ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li><li><code>x</code> : Number<div class="sub-desc">The new x position</div></li><li><code>y</code> : Number<div class="sub-desc">The new y position</div></li> </ul>
|
|
|
1526 |
</div>
|
|
|
1527 |
</div>
|
|
|
1528 |
</div>
|
|
|
1529 |
</td>
|
|
|
1530 |
<td class="msource">BoxComponent</td>
|
|
|
1531 |
</tr>
|
|
|
1532 |
<tr class="event-row inherited alt expandable">
|
|
|
1533 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
1534 |
<td class="sig">
|
|
|
1535 |
<a id="Ext.BoxComponent-render"></a>
|
|
|
1536 |
<b>render</b> : ( <code>Ext.Component this</code> ) <div class="mdesc">
|
|
|
1537 |
<div class="short">Fires after the component is rendered.</div>
|
|
|
1538 |
<div class="long">
|
|
|
1539 |
Fires after the component is rendered. <div class="mdetail-params">
|
|
|
1540 |
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
|
|
|
1541 |
<ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li> </ul>
|
|
|
1542 |
</div>
|
|
|
1543 |
</div>
|
|
|
1544 |
</div>
|
|
|
1545 |
</td>
|
|
|
1546 |
<td class="msource"><a ext:cls="Ext.Component" ext:member="#event-render" href="output/Ext.Component.html#event-render">Component</a></td>
|
|
|
1547 |
</tr>
|
|
|
1548 |
<tr class="event-row expandable">
|
|
|
1549 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
1550 |
<td class="sig">
|
|
|
1551 |
<a id="Ext.BoxComponent-resize"></a>
|
|
|
1552 |
<b>resize</b> : ( <code>Ext.Component this</code>, <code>Number adjWidth</code>, <code>Number adjHeight</code>, <code>Number rawWidth</code>, <code>Number rawHeight</code> ) <div class="mdesc">
|
|
|
1553 |
<div class="short">Fires after the component is resized.</div>
|
|
|
1554 |
<div class="long">
|
|
|
1555 |
Fires after the component is resized. <div class="mdetail-params">
|
|
|
1556 |
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
|
|
|
1557 |
<ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li><li><code>adjWidth</code> : Number<div class="sub-desc">The box-adjusted width that was set</div></li><li><code>adjHeight</code> : Number<div class="sub-desc">The box-adjusted height that was set</div></li><li><code>rawWidth</code> : Number<div class="sub-desc">The width that was originally specified</div></li><li><code>rawHeight</code> : Number<div class="sub-desc">The height that was originally specified</div></li> </ul>
|
|
|
1558 |
</div>
|
|
|
1559 |
</div>
|
|
|
1560 |
</div>
|
|
|
1561 |
</td>
|
|
|
1562 |
<td class="msource">BoxComponent</td>
|
|
|
1563 |
</tr>
|
|
|
1564 |
<tr class="event-row inherited alt expandable">
|
|
|
1565 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
1566 |
<td class="sig">
|
|
|
1567 |
<a id="Ext.BoxComponent-show"></a>
|
|
|
1568 |
<b>show</b> : ( <code>Ext.Component this</code> ) <div class="mdesc">
|
|
|
1569 |
<div class="short">Fires after the component is shown.</div>
|
|
|
1570 |
<div class="long">
|
|
|
1571 |
Fires after the component is shown. <div class="mdetail-params">
|
|
|
1572 |
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
|
|
|
1573 |
<ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li> </ul>
|
|
|
1574 |
</div>
|
|
|
1575 |
</div>
|
|
|
1576 |
</div>
|
|
|
1577 |
</td>
|
|
|
1578 |
<td class="msource"><a ext:cls="Ext.Component" ext:member="#event-show" href="output/Ext.Component.html#event-show">Component</a></td>
|
|
|
1579 |
</tr>
|
|
|
1580 |
<tr class="event-row inherited expandable">
|
|
|
1581 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
1582 |
<td class="sig">
|
|
|
1583 |
<a id="Ext.BoxComponent-staterestore"></a>
|
|
|
1584 |
<b>staterestore</b> : ( <code>Ext.Component this</code>, <code>Object state</code> ) <div class="mdesc">
|
|
|
1585 |
<div class="short">Fires after the state of the component is restored.</div>
|
|
|
1586 |
<div class="long">
|
|
|
1587 |
Fires after the state of the component is restored. <div class="mdetail-params">
|
|
|
1588 |
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
|
|
|
1589 |
<ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li><li><code>state</code> : Object<div class="sub-desc">The hash of state values</div></li> </ul>
|
|
|
1590 |
</div>
|
|
|
1591 |
</div>
|
|
|
1592 |
</div>
|
|
|
1593 |
</td>
|
|
|
1594 |
<td class="msource"><a ext:cls="Ext.Component" ext:member="#event-staterestore" href="output/Ext.Component.html#event-staterestore">Component</a></td>
|
|
|
1595 |
</tr>
|
|
|
1596 |
<tr class="event-row inherited alt expandable">
|
|
|
1597 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
1598 |
<td class="sig">
|
|
|
1599 |
<a id="Ext.BoxComponent-statesave"></a>
|
|
|
1600 |
<b>statesave</b> : ( <code>Ext.Component this</code>, <code>Object state</code> ) <div class="mdesc">
|
|
|
1601 |
<div class="short">Fires after the state of the component is saved to the configured state provider.</div>
|
|
|
1602 |
<div class="long">
|
|
|
1603 |
Fires after the state of the component is saved to the configured state provider. <div class="mdetail-params">
|
|
|
1604 |
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
|
|
|
1605 |
<ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li><li><code>state</code> : Object<div class="sub-desc">The hash of state values</div></li> </ul>
|
|
|
1606 |
</div>
|
|
|
1607 |
</div>
|
|
|
1608 |
</div>
|
|
|
1609 |
</td>
|
|
|
1610 |
<td class="msource"><a ext:cls="Ext.Component" ext:member="#event-statesave" href="output/Ext.Component.html#event-statesave">Component</a></td>
|
|
|
1611 |
</tr>
|
|
|
1612 |
</table>
|
|
|
1613 |
|
|
|
1614 |
</div>
|