1 <div class="body-wrap">
2 <div class="top-tools">
3 <a class="inner-link" href="#Ext.ProgressBar-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
4 <a class="inner-link" href="#Ext.ProgressBar-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
5 <a class="inner-link" href="#Ext.ProgressBar-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
6 <a class="inner-link" href="#Ext.ProgressBar-configs"><img src="../resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>
7 <a class="bookmark" href="../docs/?class=Ext.ProgressBar"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
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"/><a ext:cls="Ext.BoxComponent" ext:member="" href="output/Ext.BoxComponent.html">BoxComponent</a>
13 <img src="resources/elbow-end.gif"/>ProgressBar</pre></div>
14 <h1>Class Ext.ProgressBar</h1>
15 <table cellspacing="0">
16 <tr><td class="label">Package:</td><td class="hd-info">Ext</td></tr>
17 <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/ProgressBar.js" target="_blank">ProgressBar.js</a></td></tr>
18 <tr><td class="label">Class:</td><td class="hd-info">ProgressBar</td></tr>
19 <tr><td class="label">Extends:</td><td class="hd-info"><a ext:cls="Ext.BoxComponent" ext:member="" href="output/Ext.BoxComponent.html">BoxComponent</a></td></tr>
21 <div class="description">
23 <p>An updateable progress bar component. The progress bar supports two different modes: manual and automatic.</p>
24 <p>In manual mode, you are responsible for showing, updating (via <a ext:cls="Ext.ProgressBar" ext:member="updateProgress" href="output/Ext.ProgressBar.html#updateProgress">updateProgress</a>) and clearing the
25 progress bar as needed from your own code. This method is most appropriate when you want to show progress
26 throughout an operation that has predictable points of interest at which you can update the control.</p>
27 <p>In automatic mode, you simply call <a ext:cls="Ext.ProgressBar" ext:member="wait" href="output/Ext.ProgressBar.html#wait">wait</a> and let the progress bar run indefinitely, only clearing it
28 once the operation is complete. You can optionally have the progress bar wait for a specific amount of time
29 and then clear itself. Automatic mode is most appropriate for timed operations or asynchronous operations in
30 which you have no need for indicating intermediate progress.</p> </div>
32 <div class="hr"></div>
33 <a id="Ext.ProgressBar-configs"></a>
34 <h2>Config Options</h2>
35 <table cellspacing="0" class="member-table">
37 <th class="sig-header" colspan="2">Config Options</th>
38 <th class="msource-header">Defined By</th>
40 <tr class="config-row inherited">
\r
41 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
43 <a id="Ext.ProgressBar-allowDomMove"></a>
\r
44 <b>allowDomMove</b> : Boolean <div class="mdesc">
\r
45 Whether the component can move the Dom node when rendering (defaults to true). </div>
\r
47 <td class="msource"><a ext:cls="Ext.Component" ext:member="#allowDomMove" href="output/Ext.Component.html#allowDomMove">Component</a></td>
\r
49 <tr class="config-row alt">
\r
50 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
52 <a id="Ext.ProgressBar-animate"></a>
\r
53 <b>animate</b> : Boolean <div class="mdesc">
\r
54 True to animate the progress bar during transitions (defaults to false) </div>
\r
56 <td class="msource">ProgressBar</td>
\r
58 <tr class="config-row inherited expandable">
\r
59 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
61 <a id="Ext.ProgressBar-applyTo"></a>
\r
62 <b>applyTo</b> : Mixed <div class="mdesc">
\r
63 <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>
\r
65 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>
\r
68 <td class="msource"><a ext:cls="Ext.Component" ext:member="#applyTo" href="output/Ext.Component.html#applyTo">Component</a></td>
\r
70 <tr class="config-row inherited alt expandable">
\r
71 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
73 <a id="Ext.ProgressBar-autoEl"></a>
\r
74 <b>autoEl</b> : String/Object <div class="mdesc">
\r
75 <div class="short">A tag name or DomHelper spec to create an element with. This is intended to create shorthand utility components inlin...</div>
\r
77 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>}
78 {xtype:<em>'box'</em>, autoEl: {tag:<em>'blockquote'</em>, html:<em>'autoEl is cool!'</em>}} // <b>with</b> DomHelper</code></pre> </div>
\r
81 <td class="msource"><a ext:cls="Ext.Component" ext:member="#autoEl" href="output/Ext.Component.html#autoEl">Component</a></td>
\r
83 <tr class="config-row inherited expandable">
\r
84 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
86 <a id="Ext.ProgressBar-autoHeight"></a>
\r
87 <b>autoHeight</b> : Boolean <div class="mdesc">
\r
88 <div class="short">True to use height:'auto', false to use fixed height (defaults to false). Note: Although many components inherit this...</div>
\r
90 True to use height:'auto', false to use fixed height (defaults to false). <b>Note</b>: Although many components inherit this config option, not all will function as expected with a height of 'auto'. Setting autoHeight:true means that the browser will manage height based on the element's contents, and that Ext will not manage it at all. </div>
\r
93 <td class="msource"><a ext:cls="Ext.BoxComponent" ext:member="#autoHeight" href="output/Ext.BoxComponent.html#autoHeight">BoxComponent</a></td>
\r
95 <tr class="config-row inherited alt expandable">
\r
96 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
98 <a id="Ext.ProgressBar-autoShow"></a>
\r
99 <b>autoShow</b> : Boolean <div class="mdesc">
\r
100 <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>
\r
102 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>
\r
105 <td class="msource"><a ext:cls="Ext.Component" ext:member="#autoShow" href="output/Ext.Component.html#autoShow">Component</a></td>
\r
107 <tr class="config-row inherited expandable">
\r
108 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
110 <a id="Ext.ProgressBar-autoWidth"></a>
\r
111 <b>autoWidth</b> : Boolean <div class="mdesc">
\r
112 <div class="short">True to use width:'auto', false to use fixed width (defaults to false). Note: Although many components inherit this c...</div>
\r
114 True to use width:'auto', false to use fixed width (defaults to false). <b>Note</b>: Although many components inherit this config option, not all will function as expected with a width of 'auto'. Setting autoWidth:true means that the browser will manage width based on the element's contents, and that Ext will not manage it at all. </div>
\r
117 <td class="msource"><a ext:cls="Ext.BoxComponent" ext:member="#autoWidth" href="output/Ext.BoxComponent.html#autoWidth">BoxComponent</a></td>
\r
119 <tr class="config-row alt">
\r
120 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
122 <a id="Ext.ProgressBar-baseCls"></a>
\r
123 <b>baseCls</b> : String <div class="mdesc">
\r
124 The base CSS class to apply to the progress bar's wrapper element (defaults to 'x-progress') </div>
\r
126 <td class="msource">ProgressBar</td>
\r
128 <tr class="config-row inherited expandable">
\r
129 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
131 <a id="Ext.ProgressBar-clearCls"></a>
\r
132 <b>clearCls</b> : String <div class="mdesc">
\r
133 <div class="short">The CSS class used to provide field clearing (defaults to 'x-form-clear-left'). This config is only used when this Co...</div>
\r
135 The CSS class used to provide field clearing (defaults to 'x-form-clear-left'). <p><b>This config is only used when this Component is rendered by a Container which has been configured to use the <a ext:cls="Ext.form.FormLayout" href="output/Ext.form.FormLayout.html">FormLayout</a> layout manager.</b></p> </div>
\r
138 <td class="msource"><a ext:cls="Ext.Component" ext:member="#clearCls" href="output/Ext.Component.html#clearCls">Component</a></td>
\r
140 <tr class="config-row inherited alt expandable">
\r
141 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
143 <a id="Ext.ProgressBar-cls"></a>
\r
144 <b>cls</b> : String <div class="mdesc">
\r
145 <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>
\r
147 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>
\r
150 <td class="msource"><a ext:cls="Ext.Component" ext:member="#cls" href="output/Ext.Component.html#cls">Component</a></td>
\r
152 <tr class="config-row inherited expandable">
\r
153 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
155 <a id="Ext.ProgressBar-ctCls"></a>
\r
156 <b>ctCls</b> : String <div class="mdesc">
\r
157 <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>
\r
159 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>
\r
162 <td class="msource"><a ext:cls="Ext.Component" ext:member="#ctCls" href="output/Ext.Component.html#ctCls">Component</a></td>
\r
164 <tr class="config-row inherited alt">
\r
165 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
167 <a id="Ext.ProgressBar-disabled"></a>
\r
168 <b>disabled</b> : Boolean <div class="mdesc">
\r
169 Render this component disabled (default is false). </div>
\r
171 <td class="msource"><a ext:cls="Ext.Component" ext:member="#disabled" href="output/Ext.Component.html#disabled">Component</a></td>
\r
173 <tr class="config-row inherited">
\r
174 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
176 <a id="Ext.ProgressBar-disabledClass"></a>
\r
177 <b>disabledClass</b> : String <div class="mdesc">
\r
178 CSS class added to the component when it is disabled (defaults to "x-item-disabled"). </div>
\r
180 <td class="msource"><a ext:cls="Ext.Component" ext:member="#disabledClass" href="output/Ext.Component.html#disabledClass">Component</a></td>
\r
182 <tr class="config-row inherited alt expandable">
\r
183 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
185 <a id="Ext.ProgressBar-fieldLabel"></a>
\r
186 <b>fieldLabel</b> : String <div class="mdesc">
\r
187 <div class="short">The label text to display next to this Component (defaults to '') This config is only used when this Component is ren...</div>
\r
189 The label text to display next to this Component (defaults to '') <p><b>This config is only used when this Component is rendered by a Container which has been configured to use the <a ext:cls="Ext.form.FormLayout" href="output/Ext.form.FormLayout.html">FormLayout</a> layout manager.</b></p> Example use:<pre><code>new Ext.FormPanel({
191 renderTo: Ext.getBody(),
193 xtype: <em>'textfield'</em>,
194 fieldLabel: <em>'Name'</em>
196 });</code></pre> </div>
\r
199 <td class="msource"><a ext:cls="Ext.Component" ext:member="#fieldLabel" href="output/Ext.Component.html#fieldLabel">Component</a></td>
\r
201 <tr class="config-row inherited">
\r
202 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
204 <a id="Ext.ProgressBar-height"></a>
\r
205 <b>height</b> : Number <div class="mdesc">
\r
206 The height of this component in pixels (defaults to auto). </div>
\r
208 <td class="msource"><a ext:cls="Ext.BoxComponent" ext:member="#height" href="output/Ext.BoxComponent.html#height">BoxComponent</a></td>
\r
210 <tr class="config-row inherited alt">
\r
211 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
213 <a id="Ext.ProgressBar-hidden"></a>
\r
214 <b>hidden</b> : Boolean <div class="mdesc">
\r
215 Render this component hidden (default is false). </div>
\r
217 <td class="msource"><a ext:cls="Ext.Component" ext:member="#hidden" href="output/Ext.Component.html#hidden">Component</a></td>
\r
219 <tr class="config-row inherited expandable">
\r
220 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
222 <a id="Ext.ProgressBar-hideLabel"></a>
\r
223 <b>hideLabel</b> : Boolean <div class="mdesc">
\r
224 <div class="short">True to completely hide the label element (defaults to false). By default, even if you do not specify a fieldLabel th...</div>
\r
226 True to completely hide the label element (defaults to false). By default, even if you do not specify a <a ext:cls="fieldLabel" href="output/fieldLabel.html">fieldLabel</a> the space will still be reserved so that the field will line up with other fields that do have labels. Setting this to true will cause the field to not reserve that space. <p><b>This config is only used when this Component is rendered by a Container which has been configured to use the <a ext:cls="Ext.form.FormLayout" href="output/Ext.form.FormLayout.html">FormLayout</a> layout manager.</b></p> Example use:<pre><code>new Ext.FormPanel({
228 renderTo: Ext.getBody(),
230 xtype: <em>'textfield'</em>
233 });</code></pre> </div>
\r
236 <td class="msource"><a ext:cls="Ext.Component" ext:member="#hideLabel" href="output/Ext.Component.html#hideLabel">Component</a></td>
\r
238 <tr class="config-row inherited alt expandable">
\r
239 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
241 <a id="Ext.ProgressBar-hideMode"></a>
\r
242 <b>hideMode</b> : String <div class="mdesc">
\r
243 <div class="short">How this component should be hidden. Supported values are "visibility" (css visibility), "offsets" (negative offset p...</div>
\r
245 <p>How this component should be hidden. Supported values are "visibility" (css visibility), "offsets" (negative offset position) and "display" (css display) - defaults to "display".</p> <p>For Containers which may be hidden and shown as part of a <a ext:cls="Ext.layout.CardLayout" href="output/Ext.layout.CardLayout.html">card layout</a> Container such as a <a ext:cls="Ext.TabPanel" href="output/Ext.TabPanel.html">TabPanel</a>, it is recommended that hideMode is configured as "offsets". This ensures that hidden Components still have height and width so that layout managers can perform measurements when calculating layouts.</p> </div>
\r
248 <td class="msource"><a ext:cls="Ext.Component" ext:member="#hideMode" href="output/Ext.Component.html#hideMode">Component</a></td>
\r
250 <tr class="config-row inherited expandable">
\r
251 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
253 <a id="Ext.ProgressBar-hideParent"></a>
\r
254 <b>hideParent</b> : Boolean <div class="mdesc">
\r
255 <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>
\r
257 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>
\r
260 <td class="msource"><a ext:cls="Ext.Component" ext:member="#hideParent" href="output/Ext.Component.html#hideParent">Component</a></td>
\r
262 <tr class="config-row alt">
\r
263 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
265 <a id="Ext.ProgressBar-id"></a>
\r
266 <b>id</b> : String <div class="mdesc">
\r
267 The progress bar element's id (defaults to an auto-generated id) </div>
\r
269 <td class="msource">ProgressBar</td>
\r
271 <tr class="config-row inherited expandable">
\r
272 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
274 <a id="Ext.ProgressBar-itemCls"></a>
\r
275 <b>itemCls</b> : String <div class="mdesc">
\r
276 <div class="short">An additional CSS class to apply to the wrapper's form item element of this field (defaults to the container's itemCl...</div>
\r
278 An additional CSS class to apply to the wrapper's form item element of this field (defaults to the container's itemCls value if set, or ''). Since it is applied to the item wrapper, it allows you to write standard CSS rules that can apply to the field, the label (if specified) or any other element within the markup for the field. <p><b>This config is only used when this Component is rendered by a Container which has been configured to use the <a ext:cls="Ext.form.FormLayout" href="output/Ext.form.FormLayout.html">FormLayout</a> layout manager.</b></p> Example use:<pre><code><i>// Apply a style to the field's label:</i>
280 .required .x-form-item-label {font-weight:bold;color:red;}
283 <b>new</b> Ext.FormPanel({
285 renderTo: Ext.getBody(),
287 xtype: <em>'textfield'</em>,
288 fieldLabel: <em>'Name'</em>,
289 itemCls: <em>'required'</em> <i>//<b>this</b> label will be styled</i>
291 xtype: <em>'textfield'</em>,
292 fieldLabel: <em>'Favorite Color'</em>
294 });</code></pre> </div>
\r
297 <td class="msource"><a ext:cls="Ext.Component" ext:member="#itemCls" href="output/Ext.Component.html#itemCls">Component</a></td>
\r
299 <tr class="config-row inherited alt expandable">
\r
300 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
302 <a id="Ext.ProgressBar-labelSeparator"></a>
\r
303 <b>labelSeparator</b> : String <div class="mdesc">
\r
304 <div class="short">The standard separator to display after the text of each form label (defaults to the value of Ext.layout.FormLayout.l...</div>
\r
306 The standard separator to display after the text of each form label (defaults to the value of <a ext:cls="Ext.layout.FormLayout" ext:member="labelSeparator" href="output/Ext.layout.FormLayout.html#labelSeparator">Ext.layout.FormLayout.labelSeparator</a>, which is a colon ':' by default). To display no separator for this field's label specify empty string ''. <p><b>This config is only used when this Component is rendered by a Container which has been configured to use the <a ext:cls="Ext.form.FormLayout" href="output/Ext.form.FormLayout.html">FormLayout</a> layout manager.</b></p> Example use:<pre><code>new Ext.FormPanel({
308 renderTo: Ext.getBody(),
310 xtype: <em>'textfield'</em>,
311 fieldLabel: <em>'Name'</em>,
312 labelSeparator: <em>'...'</em>
314 });</code></pre> </div>
\r
317 <td class="msource"><a ext:cls="Ext.Component" ext:member="#labelSeparator" href="output/Ext.Component.html#labelSeparator">Component</a></td>
\r
319 <tr class="config-row inherited expandable">
\r
320 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
322 <a id="Ext.ProgressBar-labelStyle"></a>
\r
323 <b>labelStyle</b> : String <div class="mdesc">
\r
324 <div class="short">A CSS style specification to apply directly to this field's label (defaults to the container's labelStyle value if se...</div>
\r
326 A CSS style specification to apply directly to this field's label (defaults to the container's labelStyle value if set, or '').<code></code>. <p><b>This config is only used when this Component is rendered by a Container which has been configured to use the <a ext:cls="Ext.form.FormLayout" href="output/Ext.form.FormLayout.html">FormLayout</a> layout manager.</b></p> Example use:<pre><code>new Ext.FormPanel({
328 renderTo: Ext.getBody(),
330 xtype: <em>'textfield'</em>,
331 fieldLabel: <em>'Name'</em>,
332 labelStyle: <em>'font-weight:bold;'</em>
334 });</code></pre> </div>
\r
337 <td class="msource"><a ext:cls="Ext.Component" ext:member="#labelStyle" href="output/Ext.Component.html#labelStyle">Component</a></td>
\r
339 <tr class="config-row inherited alt expandable">
\r
340 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
342 <a id="Ext.ProgressBar-listeners"></a>
\r
343 <b>listeners</b> : Object <div class="mdesc">
\r
344 <div class="short">(optional) A config object containing one or more event handlers to be added to this object during initialization. Th...</div>
\r
346 (optional) 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>
\r
349 <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#listeners" href="output/Ext.util.Observable.html#listeners">Observable</a></td>
\r
351 <tr class="config-row inherited expandable">
\r
352 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
354 <a id="Ext.ProgressBar-overCls"></a>
\r
355 <b>overCls</b> : String <div class="mdesc">
\r
356 <div class="short">An optional extra CSS class that will be added to this component's Element when the mouse moves over the Element, and...</div>
\r
358 An optional extra CSS class that will be added to this component's Element when the mouse moves over the Element, and removed when the mouse moves out. (defaults to ''). This can be useful for adding customized "active" or "hover" styles to the component or any of its children using standard CSS rules. </div>
\r
361 <td class="msource"><a ext:cls="Ext.Component" ext:member="#overCls" href="output/Ext.Component.html#overCls">Component</a></td>
\r
363 <tr class="config-row inherited alt">
\r
364 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
366 <a id="Ext.ProgressBar-pageX"></a>
\r
367 <b>pageX</b> : Number <div class="mdesc">
\r
368 The page level x coordinate for this component if contained within a positioning container. </div>
\r
370 <td class="msource"><a ext:cls="Ext.BoxComponent" ext:member="#pageX" href="output/Ext.BoxComponent.html#pageX">BoxComponent</a></td>
\r
372 <tr class="config-row inherited">
\r
373 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
375 <a id="Ext.ProgressBar-pageY"></a>
\r
376 <b>pageY</b> : Number <div class="mdesc">
\r
377 The page level y coordinate for this component if contained within a positioning container. </div>
\r
379 <td class="msource"><a ext:cls="Ext.BoxComponent" ext:member="#pageY" href="output/Ext.BoxComponent.html#pageY">BoxComponent</a></td>
\r
381 <tr class="config-row inherited alt expandable">
\r
382 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
384 <a id="Ext.ProgressBar-plugins"></a>
\r
385 <b>plugins</b> : Object/Array <div class="mdesc">
\r
386 <div class="short">An object or array of objects that will provide custom functionality for this component. The only requirement for a v...</div>
\r
388 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>
\r
391 <td class="msource"><a ext:cls="Ext.Component" ext:member="#plugins" href="output/Ext.Component.html#plugins">Component</a></td>
\r
393 <tr class="config-row inherited expandable">
\r
394 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
396 <a id="Ext.ProgressBar-renderTo"></a>
\r
397 <b>renderTo</b> : Mixed <div class="mdesc">
\r
398 <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>
\r
400 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>
\r
403 <td class="msource"><a ext:cls="Ext.Component" ext:member="#renderTo" href="output/Ext.Component.html#renderTo">Component</a></td>
\r
405 <tr class="config-row inherited alt expandable">
\r
406 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
408 <a id="Ext.ProgressBar-stateEvents"></a>
\r
409 <b>stateEvents</b> : Array <div class="mdesc">
\r
410 <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>
\r
412 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>
\r
415 <td class="msource"><a ext:cls="Ext.Component" ext:member="#stateEvents" href="output/Ext.Component.html#stateEvents">Component</a></td>
\r
417 <tr class="config-row inherited expandable">
\r
418 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
420 <a id="Ext.ProgressBar-stateId"></a>
\r
421 <b>stateId</b> : String <div class="mdesc">
\r
422 <div class="short">The unique id for this component to use for state management purposes (defaults to the component id if one was set, o...</div>
\r
424 The unique id for this component to use for state management purposes (defaults to the component id if one was set, otherwise null if the component is using a generated 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>
\r
427 <td class="msource"><a ext:cls="Ext.Component" ext:member="#stateId" href="output/Ext.Component.html#stateId">Component</a></td>
\r
429 <tr class="config-row inherited alt expandable">
\r
430 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
432 <a id="Ext.ProgressBar-stateful"></a>
\r
433 <b>stateful</b> : Boolean <div class="mdesc">
\r
434 <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>
\r
436 <p>A flag which causes the Component to attempt to restore the state of internal properties from a saved state on startup. The component must have either a <a ext:cls="Ext.Component" ext:member="stateId" href="output/Ext.Component.html#stateId">stateId</a> or <a ext:cls="Ext.Component" ext:member="id" href="output/Ext.Component.html#id">id</a> assigned for state to be managed. Auto-generated ids are not guaranteed to be stable across page loads and cannot be relied upon to save and restore the same state for a component.<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="Ext.Component" ext:member="staterestore" href="output/Ext.Component.html#staterestore">staterestore</a>, <a ext:cls="Ext.Component" ext:member="beforestatesave" href="output/Ext.Component.html#beforestatesave">beforestatesave</a> and <a ext:cls="Ext.Component" ext:member="statesave" href="output/Ext.Component.html#statesave">statesave</a> events</p> </div>
\r
439 <td class="msource"><a ext:cls="Ext.Component" ext:member="#stateful" href="output/Ext.Component.html#stateful">Component</a></td>
\r
441 <tr class="config-row inherited expandable">
\r
442 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
444 <a id="Ext.ProgressBar-style"></a>
\r
445 <b>style</b> : String <div class="mdesc">
\r
446 <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>
\r
448 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>
\r
451 <td class="msource"><a ext:cls="Ext.Component" ext:member="#style" href="output/Ext.Component.html#style">Component</a></td>
\r
453 <tr class="config-row alt">
\r
454 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
456 <a id="Ext.ProgressBar-text"></a>
\r
457 <b>text</b> : String <div class="mdesc">
\r
458 The progress bar text (defaults to '') </div>
\r
460 <td class="msource">ProgressBar</td>
\r
462 <tr class="config-row">
\r
463 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
465 <a id="Ext.ProgressBar-textEl"></a>
\r
466 <b>textEl</b> : Mixed <div class="mdesc">
\r
467 The element to render the progress text to (defaults to the progress bar's internal text element) </div>
\r
469 <td class="msource">ProgressBar</td>
\r
471 <tr class="config-row alt">
\r
472 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
474 <a id="Ext.ProgressBar-value"></a>
\r
475 <b>value</b> : Float <div class="mdesc">
\r
476 A floating point value between 0 and 1 (e.g., .5, defaults to 0) </div>
\r
478 <td class="msource">ProgressBar</td>
\r
480 <tr class="config-row inherited">
\r
481 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
483 <a id="Ext.ProgressBar-width"></a>
\r
484 <b>width</b> : Number <div class="mdesc">
\r
485 The width of this component in pixels (defaults to auto). </div>
\r
487 <td class="msource"><a ext:cls="Ext.BoxComponent" ext:member="#width" href="output/Ext.BoxComponent.html#width">BoxComponent</a></td>
\r
489 <tr class="config-row inherited alt">
\r
490 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
492 <a id="Ext.ProgressBar-x"></a>
\r
493 <b>x</b> : Number <div class="mdesc">
\r
494 The local x (left) coordinate for this component if contained within a positioning container. </div>
\r
496 <td class="msource"><a ext:cls="Ext.BoxComponent" ext:member="#x" href="output/Ext.BoxComponent.html#x">BoxComponent</a></td>
\r
498 <tr class="config-row inherited expandable">
\r
499 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
501 <a id="Ext.ProgressBar-xtype"></a>
\r
502 <b>xtype</b> : String <div class="mdesc">
\r
503 <div class="short">The registered xtype to create. This config option is not used when passing a config object into a constructor. This ...</div>
\r
505 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>
\r
508 <td class="msource"><a ext:cls="Ext.Component" ext:member="#xtype" href="output/Ext.Component.html#xtype">Component</a></td>
\r
510 <tr class="config-row inherited alt">
\r
511 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
513 <a id="Ext.ProgressBar-y"></a>
\r
514 <b>y</b> : Number <div class="mdesc">
\r
515 The local y (top) coordinate for this component if contained within a positioning container. </div>
\r
517 <td class="msource"><a ext:cls="Ext.BoxComponent" ext:member="#y" href="output/Ext.BoxComponent.html#y">BoxComponent</a></td>
\r
520 <a id="Ext.ProgressBar-props"></a>
521 <h2>Public Properties</h2>
522 <table cellspacing="0" class="member-table">
524 <th class="sig-header" colspan="2">Property</th>
525 <th class="msource-header">Defined By</th>
527 <tr class="property-row inherited">
\r
528 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
530 <a id="Ext.ProgressBar-disabled"></a>
\r
531 <b>disabled</b> : Boolean <div class="mdesc">
\r
532 True if this component is disabled. Read-only. </div>
\r
534 <td class="msource"><a ext:cls="Ext.Component" ext:member="#disabled" href="output/Ext.Component.html#disabled">Component</a></td>
\r
536 <tr class="property-row inherited alt">
\r
537 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
539 <a id="Ext.ProgressBar-hidden"></a>
\r
540 <b>hidden</b> : Boolean <div class="mdesc">
\r
542 True if this component is hidden. Read-only. </div>
\r
544 <td class="msource"><a ext:cls="Ext.Component" ext:member="#hidden" href="output/Ext.Component.html#hidden">Component</a></td>
\r
546 <tr class="property-row inherited">
\r
547 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
549 <a id="Ext.ProgressBar-initialConfig"></a>
\r
550 <b>initialConfig</b> : Object <div class="mdesc">
\r
551 This Component's initial configuration specification. Read-only. </div>
\r
553 <td class="msource"><a ext:cls="Ext.Component" ext:member="#initialConfig" href="output/Ext.Component.html#initialConfig">Component</a></td>
\r
555 <tr class="property-row inherited alt expandable">
\r
556 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
558 <a id="Ext.ProgressBar-ownerCt"></a>
\r
559 <b>ownerCt</b> : Ext.Container <div class="mdesc">
\r
560 <div class="short">The component's owner Ext.Container (defaults to undefined, and is set automatically when
561 the component is added to a...</div>
\r
563 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
564 the component is added to a container). Read-only. </div>
\r
567 <td class="msource"><a ext:cls="Ext.Component" ext:member="#ownerCt" href="output/Ext.Component.html#ownerCt">Component</a></td>
\r
569 <tr class="property-row inherited">
\r
570 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
572 <a id="Ext.ProgressBar-rendered"></a>
\r
573 <b>rendered</b> : Boolean <div class="mdesc">
\r
574 True if this component has been rendered. Read-only. </div>
\r
576 <td class="msource"><a ext:cls="Ext.Component" ext:member="#rendered" href="output/Ext.Component.html#rendered">Component</a></td>
\r
579 <a id="Ext.ProgressBar-methods"></a>
580 <h2>Public Methods</h2>
581 <table cellspacing="0" class="member-table">
583 <th class="sig-header" colspan="2">Method</th>
584 <th class="msource-header">Defined By</th>
586 <tr class="method-row inherited expandable">
\r
587 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
589 <a id="Ext.ProgressBar-addClass"></a>
\r
590 <b>addClass</b>( <code>string cls</code> ) : void <div class="mdesc">
\r
591 <div class="short">Adds a CSS class to the component's underlying element.</div>
\r
593 Adds a CSS class to the component's underlying element. <div class="mdetail-params">
\r
594 <strong>Parameters:</strong>
\r
595 <ul><li><code>cls</code> : string<div class="sub-desc">The CSS class name to add</div></li> </ul>
\r
596 <strong>Returns:</strong>
\r
598 <li><code>void</code></li>
\r
604 <td class="msource"><a ext:cls="Ext.Component" ext:member="#addClass" href="output/Ext.Component.html#addClass">Component</a></td>
\r
606 <tr class="method-row inherited alt expandable">
\r
607 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
609 <a id="Ext.ProgressBar-addEvents"></a>
\r
610 <b>addEvents</b>( <code>Object object</code> ) : void <div class="mdesc">
\r
611 <div class="short">Used to define events on this Observable</div>
\r
613 Used to define events on this Observable <div class="mdetail-params">
\r
614 <strong>Parameters:</strong>
\r
615 <ul><li><code>object</code> : Object<div class="sub-desc">The object with the events defined</div></li> </ul>
\r
616 <strong>Returns:</strong>
\r
618 <li><code>void</code></li>
\r
624 <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addEvents" href="output/Ext.util.Observable.html#addEvents">Observable</a></td>
\r
626 <tr class="method-row inherited expandable">
\r
627 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
629 <a id="Ext.ProgressBar-addListener"></a>
\r
630 <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">
\r
631 <div class="short">Appends an event handler to this component</div>
\r
633 Appends an event handler to this component <div class="mdetail-params">
\r
634 <strong>Parameters:</strong>
\r
635 <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
636 function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration
637 properties. This may contain any of the following properties:<ul>
638 <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>
639 <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>
640 <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>
641 <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
642 by the specified number of milliseconds. If the event fires again within that time, the original
643 handler is <em>not</em> invoked, but the new handler is scheduled in its place.</p></li>
646 <b>Combining Options</b><br>
647 Using the options argument, it is possible to combine different types of listeners:<br>
649 A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)
650 <pre><code>el.on(<em>'click'</em>, <b>this</b>.onClick, <b>this</b>, {
656 <b>Attaching multiple handlers in 1 call</b><br>
657 The method also allows for a single argument to be passed which is a config object containing properties
658 which specify multiple handlers.
662 fn: <b>this</b>.onClick,
666 <em>'mouseover'</em> : {
667 fn: <b>this</b>.onMouseOver,
670 <em>'mouseout'</em> : {
671 fn: <b>this</b>.onMouseOut,
676 Or a shorthand syntax:<br>
678 <em>'click'</em> : <b>this</b>.onClick,
679 <em>'mouseover'</em> : <b>this</b>.onMouseOver,
680 <em>'mouseout'</em> : <b>this</b>.onMouseOut,
682 });</code></pre></div></li> </ul>
\r
683 <strong>Returns:</strong>
\r
685 <li><code>void</code></li>
\r
691 <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addListener" href="output/Ext.util.Observable.html#addListener">Observable</a></td>
\r
693 <tr class="method-row inherited alt expandable">
\r
694 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
696 <a id="Ext.ProgressBar-applyToMarkup"></a>
\r
697 <b>applyToMarkup</b>( <code>String/HTMLElement el</code> ) : void <div class="mdesc">
\r
698 <div class="short">Apply this component to existing markup that is valid. With this function, no call to render() is required.</div>
\r
700 Apply this component to existing markup that is valid. With this function, no call to render() is required. <div class="mdetail-params">
\r
701 <strong>Parameters:</strong>
\r
702 <ul><li><code>el</code> : String/HTMLElement<div class="sub-desc"></div></li> </ul>
\r
703 <strong>Returns:</strong>
\r
705 <li><code>void</code></li>
\r
711 <td class="msource"><a ext:cls="Ext.Component" ext:member="#applyToMarkup" href="output/Ext.Component.html#applyToMarkup">Component</a></td>
\r
713 <tr class="method-row inherited expandable">
\r
714 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
716 <a id="Ext.ProgressBar-cloneConfig"></a>
\r
717 <b>cloneConfig</b>( <code>Object overrides</code> ) : Ext.Component <div class="mdesc">
\r
718 <div class="short">Clone the current component using the original config values passed into this instance by default.</div>
\r
720 Clone the current component using the original config values passed into this instance by default. <div class="mdetail-params">
\r
721 <strong>Parameters:</strong>
\r
722 <ul><li><code>overrides</code> : Object<div class="sub-desc">A new config containing any properties to override in the cloned version.
723 An id property can be passed on this object, otherwise one will be generated to avoid duplicates.</div></li> </ul>
\r
724 <strong>Returns:</strong>
\r
726 <li><code>Ext.Component</code><div class="sub-desc">clone The cloned copy of this component</div></li>
\r
732 <td class="msource"><a ext:cls="Ext.Component" ext:member="#cloneConfig" href="output/Ext.Component.html#cloneConfig">Component</a></td>
\r
734 <tr class="method-row inherited alt expandable">
\r
735 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
737 <a id="Ext.ProgressBar-destroy"></a>
\r
738 <b>destroy</b>() : void <div class="mdesc">
\r
739 <div class="short">Destroys this component by purging any event listeners, removing the component's element from the DOM,
740 removing the c...</div>
\r
742 Destroys this component by purging any event listeners, removing the component's element from the DOM,
743 removing the component from its <a ext:cls="Ext.Container" href="output/Ext.Container.html">Ext.Container</a> (if applicable) and unregistering it from
744 <a ext:cls="Ext.ComponentMgr" href="output/Ext.ComponentMgr.html">Ext.ComponentMgr</a>. Destruction is generally handled automatically by the framework and this method
745 should usually not need to be called directly. <div class="mdetail-params">
\r
746 <strong>Parameters:</strong>
\r
747 <ul><li>None.</li> </ul>
\r
748 <strong>Returns:</strong>
\r
750 <li><code>void</code></li>
\r
756 <td class="msource"><a ext:cls="Ext.Component" ext:member="#destroy" href="output/Ext.Component.html#destroy">Component</a></td>
\r
758 <tr class="method-row inherited expandable">
\r
759 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
761 <a id="Ext.ProgressBar-disable"></a>
\r
762 <b>disable</b>() : Ext.Component <div class="mdesc">
\r
763 <div class="short">Disable this component.</div>
\r
765 Disable this component. <div class="mdetail-params">
\r
766 <strong>Parameters:</strong>
\r
767 <ul><li>None.</li> </ul>
\r
768 <strong>Returns:</strong>
\r
770 <li><code>Ext.Component</code><div class="sub-desc">this</div></li>
\r
776 <td class="msource"><a ext:cls="Ext.Component" ext:member="#disable" href="output/Ext.Component.html#disable">Component</a></td>
\r
778 <tr class="method-row inherited alt expandable">
\r
779 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
781 <a id="Ext.ProgressBar-enable"></a>
\r
782 <b>enable</b>() : Ext.Component <div class="mdesc">
\r
783 <div class="short">Enable this component.</div>
\r
785 Enable this component. <div class="mdetail-params">
\r
786 <strong>Parameters:</strong>
\r
787 <ul><li>None.</li> </ul>
\r
788 <strong>Returns:</strong>
\r
790 <li><code>Ext.Component</code><div class="sub-desc">this</div></li>
\r
796 <td class="msource"><a ext:cls="Ext.Component" ext:member="#enable" href="output/Ext.Component.html#enable">Component</a></td>
\r
798 <tr class="method-row inherited expandable">
\r
799 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
801 <a id="Ext.ProgressBar-findParentBy"></a>
\r
802 <b>findParentBy</b>( <code>Function fcn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span> ) : Ext.Container <div class="mdesc">
\r
803 <div class="short">Find a container above this component at any level by a custom function. If the passed function returns
804 true, the con...</div>
\r
806 Find a container above this component at any level by a custom function. If the passed function returns
807 true, the container will be returned. The passed function is called with the arguments (container, this component). <div class="mdetail-params">
\r
808 <strong>Parameters:</strong>
\r
809 <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>
\r
810 <strong>Returns:</strong>
\r
812 <li><code>Ext.Container</code><div class="sub-desc">The first Container for which the custom function returns true</div></li>
\r
818 <td class="msource"><a ext:cls="Ext.Component" ext:member="#findParentBy" href="output/Ext.Component.html#findParentBy">Component</a></td>
\r
820 <tr class="method-row inherited alt expandable">
\r
821 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
823 <a id="Ext.ProgressBar-findParentByType"></a>
\r
824 <b>findParentByType</b>( <code>String/Class xtype</code> ) : Ext.Container <div class="mdesc">
\r
825 <div class="short">Find a container above this component at any level by xtype or class</div>
\r
827 Find a container above this component at any level by xtype or class <div class="mdetail-params">
\r
828 <strong>Parameters:</strong>
\r
829 <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>
\r
830 <strong>Returns:</strong>
\r
832 <li><code>Ext.Container</code><div class="sub-desc">The first Container which matches the given xtype or class</div></li>
\r
838 <td class="msource"><a ext:cls="Ext.Component" ext:member="#findParentByType" href="output/Ext.Component.html#findParentByType">Component</a></td>
\r
840 <tr class="method-row inherited expandable">
\r
841 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
843 <a id="Ext.ProgressBar-fireEvent"></a>
\r
844 <b>fireEvent</b>( <code>String eventName</code>, <code>Object... args</code> ) : Boolean <div class="mdesc">
\r
845 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
\r
847 Fires the specified event with the passed parameters (minus the event name). <div class="mdetail-params">
\r
848 <strong>Parameters:</strong>
\r
849 <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>
\r
850 <strong>Returns:</strong>
\r
852 <li><code>Boolean</code><div class="sub-desc">returns false if any of the handlers return false otherwise it returns true</div></li>
\r
858 <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#fireEvent" href="output/Ext.util.Observable.html#fireEvent">Observable</a></td>
\r
860 <tr class="method-row inherited alt expandable">
\r
861 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
863 <a id="Ext.ProgressBar-focus"></a>
\r
864 <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">
\r
865 <div class="short">Try to focus this component.</div>
\r
867 Try to focus this component. <div class="mdetail-params">
\r
868 <strong>Parameters:</strong>
\r
869 <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>
\r
870 <strong>Returns:</strong>
\r
872 <li><code>Ext.Component</code><div class="sub-desc">this</div></li>
\r
878 <td class="msource"><a ext:cls="Ext.Component" ext:member="#focus" href="output/Ext.Component.html#focus">Component</a></td>
\r
880 <tr class="method-row inherited expandable">
\r
881 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
883 <a id="Ext.ProgressBar-getBox"></a>
\r
884 <b>getBox</b>( <span class="optional" title="Optional">[<code>Boolean local</code>]</span> ) : Object <div class="mdesc">
\r
885 <div class="short">Gets the current box measurements of the component's underlying element.</div>
\r
887 Gets the current box measurements of the component's underlying element. <div class="mdetail-params">
\r
888 <strong>Parameters:</strong>
\r
889 <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>
\r
890 <strong>Returns:</strong>
\r
892 <li><code>Object</code><div class="sub-desc">box An object in the format {x, y, width, height}</div></li>
\r
898 <td class="msource"><a ext:cls="Ext.BoxComponent" ext:member="#getBox" href="output/Ext.BoxComponent.html#getBox">BoxComponent</a></td>
\r
900 <tr class="method-row inherited alt expandable">
\r
901 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
903 <a id="Ext.ProgressBar-getEl"></a>
\r
904 <b>getEl</b>() : Ext.Element <div class="mdesc">
\r
905 <div class="short">Returns the underlying <a ext:cls="Ext.Element" href="output/Ext.Element.html">Ext.Element</a>.</div>
\r
907 Returns the underlying <a ext:cls="Ext.Element" href="output/Ext.Element.html">Ext.Element</a>. <div class="mdetail-params">
\r
908 <strong>Parameters:</strong>
\r
909 <ul><li>None.</li> </ul>
\r
910 <strong>Returns:</strong>
\r
912 <li><code>Ext.Element</code><div class="sub-desc">The element</div></li>
\r
918 <td class="msource"><a ext:cls="Ext.Component" ext:member="#getEl" href="output/Ext.Component.html#getEl">Component</a></td>
\r
920 <tr class="method-row inherited expandable">
\r
921 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
923 <a id="Ext.ProgressBar-getId"></a>
\r
924 <b>getId</b>() : String <div class="mdesc">
\r
925 <div class="short">Returns the id of this component.</div>
\r
927 Returns the id of this component. <div class="mdetail-params">
\r
928 <strong>Parameters:</strong>
\r
929 <ul><li>None.</li> </ul>
\r
930 <strong>Returns:</strong>
\r
932 <li><code>String</code></li>
\r
938 <td class="msource"><a ext:cls="Ext.Component" ext:member="#getId" href="output/Ext.Component.html#getId">Component</a></td>
\r
940 <tr class="method-row inherited alt expandable">
\r
941 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
943 <a id="Ext.ProgressBar-getItemId"></a>
\r
944 <b>getItemId</b>() : String <div class="mdesc">
\r
945 <div class="short">Returns the item id of this component.</div>
\r
947 Returns the item id of this component. <div class="mdetail-params">
\r
948 <strong>Parameters:</strong>
\r
949 <ul><li>None.</li> </ul>
\r
950 <strong>Returns:</strong>
\r
952 <li><code>String</code></li>
\r
958 <td class="msource"><a ext:cls="Ext.Component" ext:member="#getItemId" href="output/Ext.Component.html#getItemId">Component</a></td>
\r
960 <tr class="method-row inherited expandable">
\r
961 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
963 <a id="Ext.ProgressBar-getPosition"></a>
\r
964 <b>getPosition</b>( <span class="optional" title="Optional">[<code>Boolean local</code>]</span> ) : Array <div class="mdesc">
\r
965 <div class="short">Gets the current XY position of the component's underlying element.</div>
\r
967 Gets the current XY position of the component's underlying element. <div class="mdetail-params">
\r
968 <strong>Parameters:</strong>
\r
969 <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>
\r
970 <strong>Returns:</strong>
\r
972 <li><code>Array</code><div class="sub-desc">The XY position of the element (e.g., [100, 200])</div></li>
\r
978 <td class="msource"><a ext:cls="Ext.BoxComponent" ext:member="#getPosition" href="output/Ext.BoxComponent.html#getPosition">BoxComponent</a></td>
\r
980 <tr class="method-row inherited alt expandable">
\r
981 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
983 <a id="Ext.ProgressBar-getSize"></a>
\r
984 <b>getSize</b>() : Object <div class="mdesc">
\r
985 <div class="short">Gets the current size of the component's underlying element.</div>
\r
987 Gets the current size of the component's underlying element. <div class="mdetail-params">
\r
988 <strong>Parameters:</strong>
\r
989 <ul><li>None.</li> </ul>
\r
990 <strong>Returns:</strong>
\r
992 <li><code>Object</code><div class="sub-desc">An object containing the element's size {width: (element width), height: (element height)}</div></li>
\r
998 <td class="msource"><a ext:cls="Ext.BoxComponent" ext:member="#getSize" href="output/Ext.BoxComponent.html#getSize">BoxComponent</a></td>
\r
1000 <tr class="method-row inherited expandable">
\r
1001 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1003 <a id="Ext.ProgressBar-getXType"></a>
\r
1004 <b>getXType</b>() : String <div class="mdesc">
\r
1005 <div class="short">Gets the xtype for this component as registered with Ext.ComponentMgr. For a list of all
1006 available xtypes, see the Ex...</div>
\r
1007 <div class="long">
\r
1008 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
1009 available xtypes, see the <a ext:cls="Ext.Component" href="output/Ext.Component.html">Ext.Component</a> header. Example usage:
1010 <pre><code>var t = <b>new</b> Ext.form.TextField();
1011 alert(t.getXType()); // alerts <em>'textfield'</em></code></pre> <div class="mdetail-params">
\r
1012 <strong>Parameters:</strong>
\r
1013 <ul><li>None.</li> </ul>
\r
1014 <strong>Returns:</strong>
\r
1016 <li><code>String</code><div class="sub-desc">The xtype</div></li>
\r
1022 <td class="msource"><a ext:cls="Ext.Component" ext:member="#getXType" href="output/Ext.Component.html#getXType">Component</a></td>
\r
1024 <tr class="method-row inherited alt expandable">
\r
1025 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1027 <a id="Ext.ProgressBar-getXTypes"></a>
\r
1028 <b>getXTypes</b>() : String <div class="mdesc">
\r
1029 <div class="short">Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all
1030 available xtypes, see the Ext...</div>
\r
1031 <div class="long">
\r
1032 <p>Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all
1033 available xtypes, see the <a ext:cls="Ext.Component" href="output/Ext.Component.html">Ext.Component</a> header.</p>
1034 <p><b>If using your own subclasses, be aware that a Component must register its own xtype
1035 to participate in determination of inherited xtypes.</b></p>
1036 <p>Example usage:</p>
1038 var t = new Ext.form.TextField();
\r
1039 alert(t.getXTypes()); // alerts 'component/box/field/textfield'</pre></code> <div class="mdetail-params">
\r
1040 <strong>Parameters:</strong>
\r
1041 <ul><li>None.</li> </ul>
\r
1042 <strong>Returns:</strong>
\r
1044 <li><code>String</code><div class="sub-desc">The xtype hierarchy string</div></li>
\r
1050 <td class="msource"><a ext:cls="Ext.Component" ext:member="#getXTypes" href="output/Ext.Component.html#getXTypes">Component</a></td>
\r
1052 <tr class="method-row inherited expandable">
\r
1053 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1055 <a id="Ext.ProgressBar-hasListener"></a>
\r
1056 <b>hasListener</b>( <code>String eventName</code> ) : Boolean <div class="mdesc">
\r
1057 <div class="short">Checks to see if this object has any listeners for a specified event</div>
\r
1058 <div class="long">
\r
1059 Checks to see if this object has any listeners for a specified event <div class="mdetail-params">
\r
1060 <strong>Parameters:</strong>
\r
1061 <ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to check for</div></li> </ul>
\r
1062 <strong>Returns:</strong>
\r
1064 <li><code>Boolean</code><div class="sub-desc">True if the event is being listened for, else false</div></li>
\r
1070 <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#hasListener" href="output/Ext.util.Observable.html#hasListener">Observable</a></td>
\r
1072 <tr class="method-row inherited alt expandable">
\r
1073 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1075 <a id="Ext.ProgressBar-hide"></a>
\r
1076 <b>hide</b>() : Ext.Component <div class="mdesc">
\r
1077 <div class="short">Hide this component.</div>
\r
1078 <div class="long">
\r
1079 Hide this component. <div class="mdetail-params">
\r
1080 <strong>Parameters:</strong>
\r
1081 <ul><li>None.</li> </ul>
\r
1082 <strong>Returns:</strong>
\r
1084 <li><code>Ext.Component</code><div class="sub-desc">this</div></li>
\r
1090 <td class="msource"><a ext:cls="Ext.Component" ext:member="#hide" href="output/Ext.Component.html#hide">Component</a></td>
\r
1092 <tr class="method-row inherited expandable">
\r
1093 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1095 <a id="Ext.ProgressBar-isVisible"></a>
\r
1096 <b>isVisible</b>() : void <div class="mdesc">
\r
1097 <div class="short">Returns true if this component is visible.</div>
\r
1098 <div class="long">
\r
1099 Returns true if this component is visible. <div class="mdetail-params">
\r
1100 <strong>Parameters:</strong>
\r
1101 <ul><li>None.</li> </ul>
\r
1102 <strong>Returns:</strong>
\r
1104 <li><code>void</code></li>
\r
1110 <td class="msource"><a ext:cls="Ext.Component" ext:member="#isVisible" href="output/Ext.Component.html#isVisible">Component</a></td>
\r
1112 <tr class="method-row alt expandable">
\r
1113 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1115 <a id="Ext.ProgressBar-isWaiting"></a>
\r
1116 <b>isWaiting</b>() : Boolean <div class="mdesc">
\r
1117 <div class="short">Returns true if the progress bar is currently in a <a ext:cls="Ext.ProgressBar" ext:member="wait" href="output/Ext.ProgressBar.html#wait">wait</a> operation</div>
\r
1118 <div class="long">
\r
1119 Returns true if the progress bar is currently in a <a ext:cls="Ext.ProgressBar" ext:member="wait" href="output/Ext.ProgressBar.html#wait">wait</a> operation <div class="mdetail-params">
\r
1120 <strong>Parameters:</strong>
\r
1121 <ul><li>None.</li> </ul>
\r
1122 <strong>Returns:</strong>
\r
1124 <li><code>Boolean</code><div class="sub-desc">True if waiting, else false</div></li>
\r
1130 <td class="msource">ProgressBar</td>
\r
1132 <tr class="method-row inherited expandable">
\r
1133 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1135 <a id="Ext.ProgressBar-isXType"></a>
\r
1136 <b>isXType</b>( <code>String xtype</code>, <span class="optional" title="Optional">[<code>Boolean shallow</code>]</span> ) : void <div class="mdesc">
\r
1137 <div class="short">Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended
1139 <div class="long">
\r
1140 <p>Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended
1141 from the xtype (default) or whether it is directly of the xtype specified (shallow = true).</p>
1142 <p><b>If using your own subclasses, be aware that a Component must register its own xtype
1143 to participate in determination of inherited xtypes.</b></p>
1144 <p>For a list of all available xtypes, see the <a ext:cls="Ext.Component" href="output/Ext.Component.html">Ext.Component</a> header.</p>
1145 <p>Example usage:</p>
1146 <pre><code>var t = <b>new</b> Ext.form.TextField();
1147 <b>var</b> isText = t.isXType(<em>'textfield'</em>); <i>// true</i>
1148 <b>var</b> isBoxSubclass = t.isXType(<em>'box'</em>); <i>// true, descended from BoxComponent</i>
1149 <b>var</b> isBoxInstance = t.isXType(<em>'box'</em>, true); // false, not a direct BoxComponent instance</code></pre> <div class="mdetail-params">
\r
1150 <strong>Parameters:</strong>
\r
1151 <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
1152 the default), or true to check whether this Component is directly of the specified xtype.</div></li> </ul>
\r
1153 <strong>Returns:</strong>
\r
1155 <li><code>void</code></li>
\r
1161 <td class="msource"><a ext:cls="Ext.Component" ext:member="#isXType" href="output/Ext.Component.html#isXType">Component</a></td>
\r
1163 <tr class="method-row inherited alt expandable">
\r
1164 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1166 <a id="Ext.ProgressBar-on"></a>
\r
1167 <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">
\r
1168 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
\r
1169 <div class="long">
\r
1170 Appends an event handler to this element (shorthand for addListener) <div class="mdetail-params">
\r
1171 <strong>Parameters:</strong>
\r
1172 <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
1173 function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional)</div></li> </ul>
\r
1174 <strong>Returns:</strong>
\r
1176 <li><code>void</code></li>
\r
1182 <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#on" href="output/Ext.util.Observable.html#on">Observable</a></td>
\r
1184 <tr class="method-row inherited expandable">
\r
1185 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1187 <a id="Ext.ProgressBar-purgeListeners"></a>
\r
1188 <b>purgeListeners</b>() : void <div class="mdesc">
\r
1189 <div class="short">Removes all listeners for this object</div>
\r
1190 <div class="long">
\r
1191 Removes all listeners for this object <div class="mdetail-params">
\r
1192 <strong>Parameters:</strong>
\r
1193 <ul><li>None.</li> </ul>
\r
1194 <strong>Returns:</strong>
\r
1196 <li><code>void</code></li>
\r
1202 <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#purgeListeners" href="output/Ext.util.Observable.html#purgeListeners">Observable</a></td>
\r
1204 <tr class="method-row inherited alt expandable">
\r
1205 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1207 <a id="Ext.ProgressBar-relayEvents"></a>
\r
1208 <b>relayEvents</b>( <code>Object o</code>, <code>Array events</code> ) : void <div class="mdesc">
\r
1209 <div class="short">Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>.</div>
\r
1210 <div class="long">
\r
1211 Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>. <div class="mdetail-params">
\r
1212 <strong>Parameters:</strong>
\r
1213 <ul><li><code>o</code> : Object<div class="sub-desc">The Observable whose events this object is to relay.</div></li><li><code>events</code> : Array<div class="sub-desc">Array of event names to relay.</div></li> </ul>
\r
1214 <strong>Returns:</strong>
\r
1216 <li><code>void</code></li>
\r
1222 <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#relayEvents" href="output/Ext.util.Observable.html#relayEvents">Observable</a></td>
\r
1224 <tr class="method-row inherited expandable">
\r
1225 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1227 <a id="Ext.ProgressBar-removeClass"></a>
\r
1228 <b>removeClass</b>( <code>string cls</code> ) : void <div class="mdesc">
\r
1229 <div class="short">Removes a CSS class from the component's underlying element.</div>
\r
1230 <div class="long">
\r
1231 Removes a CSS class from the component's underlying element. <div class="mdetail-params">
\r
1232 <strong>Parameters:</strong>
\r
1233 <ul><li><code>cls</code> : string<div class="sub-desc">The CSS class name to remove</div></li> </ul>
\r
1234 <strong>Returns:</strong>
\r
1236 <li><code>void</code></li>
\r
1242 <td class="msource"><a ext:cls="Ext.Component" ext:member="#removeClass" href="output/Ext.Component.html#removeClass">Component</a></td>
\r
1244 <tr class="method-row inherited alt expandable">
\r
1245 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1247 <a id="Ext.ProgressBar-removeListener"></a>
\r
1248 <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">
\r
1249 <div class="short">Removes a listener</div>
\r
1250 <div class="long">
\r
1251 Removes a listener <div class="mdetail-params">
\r
1252 <strong>Parameters:</strong>
\r
1253 <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>
\r
1254 <strong>Returns:</strong>
\r
1256 <li><code>void</code></li>
\r
1262 <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#removeListener" href="output/Ext.util.Observable.html#removeListener">Observable</a></td>
\r
1264 <tr class="method-row inherited expandable">
\r
1265 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1267 <a id="Ext.ProgressBar-render"></a>
\r
1268 <b>render</b>( <span class="optional" title="Optional">[<code>Element/HTMLElement/String container</code>]</span>, <span class="optional" title="Optional">[<code>String/Number position</code>]</span> ) : void <div class="mdesc">
\r
1269 <div class="short">Render this Component into the passed HTML element.
1270 If you are using a Container object to house this Component, then...</div>
\r
1271 <div class="long">
\r
1272 <p>Render this Component into the passed HTML element.</p>
1273 <p><b>If you are using a <a ext:cls="Ext.Container" href="output/Ext.Container.html">Container</a> object to house this Component, then
1274 do not use the render method.</b></p>
1275 <p>A Container's child Components are rendered by that Container's
1276 <a ext:cls="Ext.Container" ext:member="layout" href="output/Ext.Container.html#layout">layout</a> manager when the Container is first rendered.</p>
1277 <p>Certain layout managers allow dynamic addition of child components. Those that do
1278 include <a ext:cls="Ext.layout.CardLayout" href="output/Ext.layout.CardLayout.html">Ext.layout.CardLayout</a>, <a ext:cls="Ext.layout.AnchorLayout" href="output/Ext.layout.AnchorLayout.html">Ext.layout.AnchorLayout</a>,
1279 <a ext:cls="Ext.layout.FormLayout" href="output/Ext.layout.FormLayout.html">Ext.layout.FormLayout</a>, <a ext:cls="Ext.layout.TableLayout" href="output/Ext.layout.TableLayout.html">Ext.layout.TableLayout</a>.</p>
1280 <p>If the Container is already rendered when a new child Component is added, you may need to call
1281 the Container's <a ext:cls="Ext.Container" ext:member="doLayout" href="output/Ext.Container.html#doLayout">doLayout</a> to refresh the view which causes any
1282 unrendered child Components to be rendered. This is required so that you can add multiple
1283 child components if needed while only refreshing the layout once.</p>
1284 <p>When creating complex UIs, it is important to remember that sizing and positioning
1285 of child items is the responsibility of the Container's <a ext:cls="Ext.Container" ext:member="layout" href="output/Ext.Container.html#layout">layout</a> manager.
1286 If you expect child items to be sized in response to user interactions, you must
1287 configure the Container with a layout manager which creates and manages the type of layout you
1289 <p><b>Omitting the Container's <a ext:cls="Ext.Container" ext:member="layout" href="output/Ext.Container.html#layout">layout</a> config means that a basic
1290 layout manager is used which does nothing but render child components sequentially into the
1291 Container. No sizing or positioning will be performed in this situation.</b></p> <div class="mdetail-params">
\r
1292 <strong>Parameters:</strong>
\r
1293 <ul><li><code>container</code> : Element/HTMLElement/String<div class="sub-desc">(optional) The element this Component should be
1294 rendered into. If it is being created from existing markup, this should be omitted.</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>
1295 which this component will be inserted (defaults to appending to the end of the container)</div></li> </ul>
\r
1296 <strong>Returns:</strong>
\r
1298 <li><code>void</code></li>
\r
1304 <td class="msource"><a ext:cls="Ext.Component" ext:member="#render" href="output/Ext.Component.html#render">Component</a></td>
\r
1306 <tr class="method-row alt expandable">
\r
1307 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1309 <a id="Ext.ProgressBar-reset"></a>
\r
1310 <b>reset</b>( <span class="optional" title="Optional">[<code>Boolean hide</code>]</span> ) : Ext.ProgressBar <div class="mdesc">
\r
1311 <div class="short">Resets the progress bar value to 0 and text to empty string. If hide = true, the progress
1312 bar will also be hidden (u...</div>
\r
1313 <div class="long">
\r
1314 Resets the progress bar value to 0 and text to empty string. If hide = true, the progress
1315 bar will also be hidden (using the <a ext:cls="Ext.ProgressBar" ext:member="hideMode" href="output/Ext.ProgressBar.html#hideMode">hideMode</a> property internally). <div class="mdetail-params">
\r
1316 <strong>Parameters:</strong>
\r
1317 <ul><li><code>hide</code> : Boolean<div class="sub-desc">(optional) True to hide the progress bar (defaults to false)</div></li> </ul>
\r
1318 <strong>Returns:</strong>
\r
1320 <li><code>Ext.ProgressBar</code><div class="sub-desc">this</div></li>
\r
1326 <td class="msource">ProgressBar</td>
\r
1328 <tr class="method-row inherited expandable">
\r
1329 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1331 <a id="Ext.ProgressBar-resumeEvents"></a>
\r
1332 <b>resumeEvents</b>() : void <div class="mdesc">
\r
1333 <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>
\r
1334 <div class="long">
\r
1335 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">
\r
1336 <strong>Parameters:</strong>
\r
1337 <ul><li>None.</li> </ul>
\r
1338 <strong>Returns:</strong>
\r
1340 <li><code>void</code></li>
\r
1346 <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">Observable</a></td>
\r
1348 <tr class="method-row inherited alt expandable">
\r
1349 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1351 <a id="Ext.ProgressBar-setDisabled"></a>
\r
1352 <b>setDisabled</b>( <code>Boolean disabled</code> ) : void <div class="mdesc">
\r
1353 <div class="short">Convenience function for setting disabled/enabled by boolean.</div>
\r
1354 <div class="long">
\r
1355 Convenience function for setting disabled/enabled by boolean. <div class="mdetail-params">
\r
1356 <strong>Parameters:</strong>
\r
1357 <ul><li><code>disabled</code> : Boolean<div class="sub-desc"></div></li> </ul>
\r
1358 <strong>Returns:</strong>
\r
1360 <li><code>void</code></li>
\r
1366 <td class="msource"><a ext:cls="Ext.Component" ext:member="#setDisabled" href="output/Ext.Component.html#setDisabled">Component</a></td>
\r
1368 <tr class="method-row inherited expandable">
\r
1369 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1371 <a id="Ext.ProgressBar-setHeight"></a>
\r
1372 <b>setHeight</b>( <code>Number height</code> ) : Ext.BoxComponent <div class="mdesc">
\r
1373 <div class="short">Sets the height of the component. This method fires the <a ext:cls="Ext.BoxComponent" ext:member="resize" href="output/Ext.BoxComponent.html#resize">resize</a> event.</div>
\r
1374 <div class="long">
\r
1375 Sets the height of the component. This method fires the <a ext:cls="Ext.BoxComponent" ext:member="resize" href="output/Ext.BoxComponent.html#resize">resize</a> event. <div class="mdetail-params">
\r
1376 <strong>Parameters:</strong>
\r
1377 <ul><li><code>height</code> : Number<div class="sub-desc">The new height to set</div></li> </ul>
\r
1378 <strong>Returns:</strong>
\r
1380 <li><code>Ext.BoxComponent</code><div class="sub-desc">this</div></li>
\r
1386 <td class="msource"><a ext:cls="Ext.BoxComponent" ext:member="#setHeight" href="output/Ext.BoxComponent.html#setHeight">BoxComponent</a></td>
\r
1388 <tr class="method-row inherited alt expandable">
\r
1389 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1391 <a id="Ext.ProgressBar-setPagePosition"></a>
\r
1392 <b>setPagePosition</b>( <code>Number x</code>, <code>Number y</code> ) : Ext.BoxComponent <div class="mdesc">
\r
1393 <div class="short">Sets the page XY position of the component. To set the left and top instead, use setPosition.
1394 This method fires the ...</div>
\r
1395 <div class="long">
\r
1396 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>.
1397 This method fires the <a ext:cls="Ext.BoxComponent" ext:member="move" href="output/Ext.BoxComponent.html#move">move</a> event. <div class="mdetail-params">
\r
1398 <strong>Parameters:</strong>
\r
1399 <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>
\r
1400 <strong>Returns:</strong>
\r
1402 <li><code>Ext.BoxComponent</code><div class="sub-desc">this</div></li>
\r
1408 <td class="msource"><a ext:cls="Ext.BoxComponent" ext:member="#setPagePosition" href="output/Ext.BoxComponent.html#setPagePosition">BoxComponent</a></td>
\r
1410 <tr class="method-row inherited expandable">
\r
1411 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1413 <a id="Ext.ProgressBar-setPosition"></a>
\r
1414 <b>setPosition</b>( <code>Number left</code>, <code>Number top</code> ) : Ext.BoxComponent <div class="mdesc">
\r
1415 <div class="short">Sets the left and top of the component. To set the page XY position instead, use setPagePosition.
1416 This method fires ...</div>
\r
1417 <div class="long">
\r
1418 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>.
1419 This method fires the <a ext:cls="Ext.BoxComponent" ext:member="move" href="output/Ext.BoxComponent.html#move">move</a> event. <div class="mdetail-params">
\r
1420 <strong>Parameters:</strong>
\r
1421 <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>
\r
1422 <strong>Returns:</strong>
\r
1424 <li><code>Ext.BoxComponent</code><div class="sub-desc">this</div></li>
\r
1430 <td class="msource"><a ext:cls="Ext.BoxComponent" ext:member="#setPosition" href="output/Ext.BoxComponent.html#setPosition">BoxComponent</a></td>
\r
1432 <tr class="method-row alt expandable">
\r
1433 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1435 <a id="Ext.ProgressBar-setSize"></a>
\r
1436 <b>setSize</b>( <code>Number width</code>, <code>Number height</code> ) : Ext.ProgressBar <div class="mdesc">
\r
1437 <div class="short">Sets the size of the progress bar.</div>
\r
1438 <div class="long">
\r
1439 Sets the size of the progress bar. <div class="mdetail-params">
\r
1440 <strong>Parameters:</strong>
\r
1441 <ul><li><code>width</code> : Number<div class="sub-desc">The new width in pixels</div></li><li><code>height</code> : Number<div class="sub-desc">The new height in pixels</div></li> </ul>
\r
1442 <strong>Returns:</strong>
\r
1444 <li><code>Ext.ProgressBar</code><div class="sub-desc">this</div></li>
\r
1450 <td class="msource">ProgressBar</td>
\r
1452 <tr class="method-row inherited expandable">
\r
1453 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1455 <a id="Ext.ProgressBar-setVisible"></a>
\r
1456 <b>setVisible</b>( <code>Boolean visible</code> ) : Ext.Component <div class="mdesc">
\r
1457 <div class="short">Convenience function to hide or show this component by boolean.</div>
\r
1458 <div class="long">
\r
1459 Convenience function to hide or show this component by boolean. <div class="mdetail-params">
\r
1460 <strong>Parameters:</strong>
\r
1461 <ul><li><code>visible</code> : Boolean<div class="sub-desc">True to show, false to hide</div></li> </ul>
\r
1462 <strong>Returns:</strong>
\r
1464 <li><code>Ext.Component</code><div class="sub-desc">this</div></li>
\r
1470 <td class="msource"><a ext:cls="Ext.Component" ext:member="#setVisible" href="output/Ext.Component.html#setVisible">Component</a></td>
\r
1472 <tr class="method-row inherited alt expandable">
\r
1473 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1475 <a id="Ext.ProgressBar-setWidth"></a>
\r
1476 <b>setWidth</b>( <code>Number width</code> ) : Ext.BoxComponent <div class="mdesc">
\r
1477 <div class="short">Sets the width of the component. This method fires the <a ext:cls="Ext.BoxComponent" ext:member="resize" href="output/Ext.BoxComponent.html#resize">resize</a> event.</div>
\r
1478 <div class="long">
\r
1479 Sets the width of the component. This method fires the <a ext:cls="Ext.BoxComponent" ext:member="resize" href="output/Ext.BoxComponent.html#resize">resize</a> event. <div class="mdetail-params">
\r
1480 <strong>Parameters:</strong>
\r
1481 <ul><li><code>width</code> : Number<div class="sub-desc">The new width to set</div></li> </ul>
\r
1482 <strong>Returns:</strong>
\r
1484 <li><code>Ext.BoxComponent</code><div class="sub-desc">this</div></li>
\r
1490 <td class="msource"><a ext:cls="Ext.BoxComponent" ext:member="#setWidth" href="output/Ext.BoxComponent.html#setWidth">BoxComponent</a></td>
\r
1492 <tr class="method-row inherited expandable">
\r
1493 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1495 <a id="Ext.ProgressBar-show"></a>
\r
1496 <b>show</b>() : Ext.Component <div class="mdesc">
\r
1497 <div class="short">Show this component.</div>
\r
1498 <div class="long">
\r
1499 Show this component. <div class="mdetail-params">
\r
1500 <strong>Parameters:</strong>
\r
1501 <ul><li>None.</li> </ul>
\r
1502 <strong>Returns:</strong>
\r
1504 <li><code>Ext.Component</code><div class="sub-desc">this</div></li>
\r
1510 <td class="msource"><a ext:cls="Ext.Component" ext:member="#show" href="output/Ext.Component.html#show">Component</a></td>
\r
1512 <tr class="method-row inherited alt expandable">
\r
1513 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1515 <a id="Ext.ProgressBar-suspendEvents"></a>
\r
1516 <b>suspendEvents</b>() : void <div class="mdesc">
\r
1517 <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>
\r
1518 <div class="long">
\r
1519 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">
\r
1520 <strong>Parameters:</strong>
\r
1521 <ul><li>None.</li> </ul>
\r
1522 <strong>Returns:</strong>
\r
1524 <li><code>void</code></li>
\r
1530 <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">Observable</a></td>
\r
1532 <tr class="method-row expandable">
\r
1533 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1535 <a id="Ext.ProgressBar-syncProgressBar"></a>
\r
1536 <b>syncProgressBar</b>() : void <div class="mdesc">
\r
1537 <div class="short">Synchronizes the inner bar width to the proper proportion of the total componet width based
1538 on the current progress v...</div>
\r
1539 <div class="long">
\r
1540 Synchronizes the inner bar width to the proper proportion of the total componet width based
1541 on the current progress <a ext:cls="Ext.ProgressBar" ext:member="value" href="output/Ext.ProgressBar.html#value">value</a>. This will be called automatically when the ProgressBar
1542 is resized by a layout, but if it is rendered auto width, this method can be called from
1543 another resize handler to sync the ProgressBar if necessary. <div class="mdetail-params">
\r
1544 <strong>Parameters:</strong>
\r
1545 <ul><li>None.</li> </ul>
\r
1546 <strong>Returns:</strong>
\r
1548 <li><code>void</code></li>
\r
1554 <td class="msource">ProgressBar</td>
\r
1556 <tr class="method-row inherited alt expandable">
\r
1557 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1559 <a id="Ext.ProgressBar-syncSize"></a>
\r
1560 <b>syncSize</b>() : Ext.BoxComponent <div class="mdesc">
\r
1561 <div class="short">Force the component's size to recalculate based on the underlying element's current height and width.</div>
\r
1562 <div class="long">
\r
1563 Force the component's size to recalculate based on the underlying element's current height and width. <div class="mdetail-params">
\r
1564 <strong>Parameters:</strong>
\r
1565 <ul><li>None.</li> </ul>
\r
1566 <strong>Returns:</strong>
\r
1568 <li><code>Ext.BoxComponent</code><div class="sub-desc">this</div></li>
\r
1574 <td class="msource"><a ext:cls="Ext.BoxComponent" ext:member="#syncSize" href="output/Ext.BoxComponent.html#syncSize">BoxComponent</a></td>
\r
1576 <tr class="method-row inherited expandable">
\r
1577 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1579 <a id="Ext.ProgressBar-un"></a>
\r
1580 <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">
\r
1581 <div class="short">Removes a listener (shorthand for removeListener)</div>
\r
1582 <div class="long">
\r
1583 Removes a listener (shorthand for removeListener) <div class="mdetail-params">
\r
1584 <strong>Parameters:</strong>
\r
1585 <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>
\r
1586 <strong>Returns:</strong>
\r
1588 <li><code>void</code></li>
\r
1594 <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#un" href="output/Ext.util.Observable.html#un">Observable</a></td>
\r
1596 <tr class="method-row inherited alt expandable">
\r
1597 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1599 <a id="Ext.ProgressBar-updateBox"></a>
\r
1600 <b>updateBox</b>( <code>Object box</code> ) : Ext.BoxComponent <div class="mdesc">
\r
1601 <div class="short">Sets the current box measurements of the component's underlying element.</div>
\r
1602 <div class="long">
\r
1603 Sets the current box measurements of the component's underlying element. <div class="mdetail-params">
\r
1604 <strong>Parameters:</strong>
\r
1605 <ul><li><code>box</code> : Object<div class="sub-desc">An object in the format {x, y, width, height}</div></li> </ul>
\r
1606 <strong>Returns:</strong>
\r
1608 <li><code>Ext.BoxComponent</code><div class="sub-desc">this</div></li>
\r
1614 <td class="msource"><a ext:cls="Ext.BoxComponent" ext:member="#updateBox" href="output/Ext.BoxComponent.html#updateBox">BoxComponent</a></td>
\r
1616 <tr class="method-row expandable">
\r
1617 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1619 <a id="Ext.ProgressBar-updateProgress"></a>
\r
1620 <b>updateProgress</b>( <span class="optional" title="Optional">[<code>Float value</code>]</span>, <span class="optional" title="Optional">[<code>String text</code>]</span>, <span class="optional" title="Optional">[<code>Boolean animate</code>]</span> ) : Ext.ProgressBar <div class="mdesc">
\r
1621 <div class="short">Updates the progress bar value, and optionally its text. If the text argument is not specified,
1622 any existing text va...</div>
\r
1623 <div class="long">
\r
1624 Updates the progress bar value, and optionally its text. If the text argument is not specified,
1625 any existing text value will be unchanged. To blank out existing text, pass ''. Note that even
1626 if the progress bar value exceeds 1, it will never automatically reset -- you are responsible for
1627 determining when the progress is complete and calling <a ext:cls="Ext.ProgressBar" ext:member="reset" href="output/Ext.ProgressBar.html#reset">reset</a> to clear and/or hide the control. <div class="mdetail-params">
\r
1628 <strong>Parameters:</strong>
\r
1629 <ul><li><code>value</code> : Float<div class="sub-desc">(optional) A floating point value between 0 and 1 (e.g., .5, defaults to 0)</div></li><li><code>text</code> : String<div class="sub-desc">(optional) The string to display in the progress text element (defaults to '')</div></li><li><code>animate</code> : Boolean<div class="sub-desc">(optional) Whether to animate the transition of the progress bar. If this value is
1630 not specified, the default for the class is used (default to false)</div></li> </ul>
\r
1631 <strong>Returns:</strong>
\r
1633 <li><code>Ext.ProgressBar</code><div class="sub-desc">this</div></li>
\r
1639 <td class="msource">ProgressBar</td>
\r
1641 <tr class="method-row alt expandable">
\r
1642 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1644 <a id="Ext.ProgressBar-updateText"></a>
\r
1645 <b>updateText</b>( <span class="optional" title="Optional">[<code>String text</code>]</span> ) : Ext.ProgressBar <div class="mdesc">
\r
1646 <div class="short">Updates the progress bar text. If specified, textEl will be updated, otherwise the progress
1647 bar itself will display ...</div>
\r
1648 <div class="long">
\r
1649 Updates the progress bar text. If specified, textEl will be updated, otherwise the progress
1650 bar itself will display the updated text. <div class="mdetail-params">
\r
1651 <strong>Parameters:</strong>
\r
1652 <ul><li><code>text</code> : String<div class="sub-desc">(optional) The string to display in the progress text element (defaults to '')</div></li> </ul>
\r
1653 <strong>Returns:</strong>
\r
1655 <li><code>Ext.ProgressBar</code><div class="sub-desc">this</div></li>
\r
1661 <td class="msource">ProgressBar</td>
\r
1663 <tr class="method-row expandable">
\r
1664 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1666 <a id="Ext.ProgressBar-wait"></a>
\r
1667 <b>wait</b>( <span class="optional" title="Optional">[<code>Object config</code>]</span> ) : Ext.ProgressBar <div class="mdesc">
\r
1668 <div class="short">Initiates an auto-updating progress bar. A duration can be specified, in which case the progress
1669 bar will automatica...</div>
\r
1670 <div class="long">
\r
1671 Initiates an auto-updating progress bar. A duration can be specified, in which case the progress
1672 bar will automatically reset after a fixed amount of time and optionally call a callback function
1673 if specified. If no duration is passed in, then the progress bar will run indefinitely and must
1674 be manually cleared by calling <a ext:cls="Ext.ProgressBar" ext:member="reset" href="output/Ext.ProgressBar.html#reset">reset</a>. The wait method accepts a config object with
1675 the following properties:
1676 <pre>Property Type Description
\r
1677 ---------- ------------ ----------------------------------------------------------------------
\r
1678 duration Number The length of time in milliseconds that the progress bar should
\r
1679 run before resetting itself (defaults to undefined, in which case it
\r
1680 will run indefinitely until reset is called)
\r
1681 interval Number The length of time in milliseconds between each progress update
\r
1682 (defaults to 1000 ms)
\r
1683 animate Boolean Whether to animate the transition of the progress bar. If this value is
\r
1684 not specified, the default for the class is used.
\r
1685 increment Number The number of progress update segments to display within the progress
\r
1686 bar (defaults to 10). If the bar reaches the end and is still
\r
1687 updating, it will automatically wrap back to the beginning.
\r
1688 text String Optional text to display in the progress bar element (defaults to '').
\r
1689 fn Function A callback function to execute after the progress bar finishes auto-
\r
1690 updating. The function will be called with no arguments. This function
\r
1691 will be ignored if duration is not specified since in that case the
\r
1692 progress bar can only be stopped programmatically, so any required function
\r
1693 should be called by the same code after it resets the progress bar.
\r
1694 scope Object The scope that is passed to the callback function (only applies when
\r
1695 duration and fn are both passed).</pre>
1697 <pre><code>var p = <b>new</b> Ext.ProgressBar({
1698 renderTo: <em>'my-el'</em>
1701 <i>//Wait <b>for</b> 5 seconds, then update the status el (progress bar will auto-reset)</i>
1703 interval: 100, <i>//bar will move fast!</i>
1706 text: <em>'Updating...'</em>,
1708 fn: <b>function</b>(){
1709 Ext.fly(<em>'status'</em>).update(<em>'Done!'</em>);
1713 <i>//Or update indefinitely until some async action completes, then reset manually</i>
1715 myAction.on(<em>'complete'</em>, <b>function</b>(){
1717 Ext.fly(<em>'status'</em>).update(<em>'Done!'</em>);
1718 });</code></pre> <div class="mdetail-params">
\r
1719 <strong>Parameters:</strong>
\r
1720 <ul><li><code>config</code> : Object<div class="sub-desc">(optional) Configuration options</div></li> </ul>
\r
1721 <strong>Returns:</strong>
\r
1723 <li><code>Ext.ProgressBar</code><div class="sub-desc">this</div></li>
\r
1729 <td class="msource">ProgressBar</td>
\r
1732 <a id="Ext.ProgressBar-events"></a>
1733 <h2>Public Events</h2>
1734 <table cellspacing="0" class="member-table">
1736 <th class="sig-header" colspan="2">Event</th>
1737 <th class="msource-header">Defined By</th>
1739 <tr class="event-row inherited expandable">
\r
1740 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1742 <a id="Ext.ProgressBar-beforedestroy"></a>
\r
1743 <b>beforedestroy</b> : ( <code>Ext.Component this</code> ) <div class="mdesc">
\r
1744 <div class="short">Fires before the component is destroyed. Return false to stop the destroy.</div>
\r
1745 <div class="long">
\r
1746 Fires before the component is destroyed. Return false to stop the destroy. <div class="mdetail-params">
\r
1747 <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
\r
1748 <ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li> </ul>
\r
1753 <td class="msource"><a ext:cls="Ext.Component" ext:member="#event-beforedestroy" href="output/Ext.Component.html#event-beforedestroy">Component</a></td>
\r
1755 <tr class="event-row inherited alt expandable">
\r
1756 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1758 <a id="Ext.ProgressBar-beforehide"></a>
\r
1759 <b>beforehide</b> : ( <code>Ext.Component this</code> ) <div class="mdesc">
\r
1760 <div class="short">Fires before the component is hidden. Return false to stop the hide.</div>
\r
1761 <div class="long">
\r
1762 Fires before the component is hidden. Return false to stop the hide. <div class="mdetail-params">
\r
1763 <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
\r
1764 <ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li> </ul>
\r
1769 <td class="msource"><a ext:cls="Ext.Component" ext:member="#event-beforehide" href="output/Ext.Component.html#event-beforehide">Component</a></td>
\r
1771 <tr class="event-row inherited expandable">
\r
1772 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1774 <a id="Ext.ProgressBar-beforerender"></a>
\r
1775 <b>beforerender</b> : ( <code>Ext.Component this</code> ) <div class="mdesc">
\r
1776 <div class="short">Fires before the component is rendered. Return false to stop the render.</div>
\r
1777 <div class="long">
\r
1778 Fires before the component is rendered. Return false to stop the render. <div class="mdetail-params">
\r
1779 <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
\r
1780 <ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li> </ul>
\r
1785 <td class="msource"><a ext:cls="Ext.Component" ext:member="#event-beforerender" href="output/Ext.Component.html#event-beforerender">Component</a></td>
\r
1787 <tr class="event-row inherited alt expandable">
\r
1788 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1790 <a id="Ext.ProgressBar-beforeshow"></a>
\r
1791 <b>beforeshow</b> : ( <code>Ext.Component this</code> ) <div class="mdesc">
\r
1792 <div class="short">Fires before the component is shown. Return false to stop the show.</div>
\r
1793 <div class="long">
\r
1794 Fires before the component is shown. Return false to stop the show. <div class="mdetail-params">
\r
1795 <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
\r
1796 <ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li> </ul>
\r
1801 <td class="msource"><a ext:cls="Ext.Component" ext:member="#event-beforeshow" href="output/Ext.Component.html#event-beforeshow">Component</a></td>
\r
1803 <tr class="event-row inherited expandable">
\r
1804 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1806 <a id="Ext.ProgressBar-beforestaterestore"></a>
\r
1807 <b>beforestaterestore</b> : ( <code>Ext.Component this</code>, <code>Object state</code> ) <div class="mdesc">
\r
1808 <div class="short">Fires before the state of the component is restored. Return false to stop the restore.</div>
\r
1809 <div class="long">
\r
1810 Fires before the state of the component is restored. Return false to stop the restore. <div class="mdetail-params">
\r
1811 <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
\r
1812 <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>
\r
1817 <td class="msource"><a ext:cls="Ext.Component" ext:member="#event-beforestaterestore" href="output/Ext.Component.html#event-beforestaterestore">Component</a></td>
\r
1819 <tr class="event-row inherited alt expandable">
\r
1820 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1822 <a id="Ext.ProgressBar-beforestatesave"></a>
\r
1823 <b>beforestatesave</b> : ( <code>Ext.Component this</code>, <code>Object state</code> ) <div class="mdesc">
\r
1824 <div class="short">Fires before the state of the component is saved to the configured state provider. Return false to stop the save.</div>
\r
1825 <div class="long">
\r
1826 Fires before the state of the component is saved to the configured state provider. Return false to stop the save. <div class="mdetail-params">
\r
1827 <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
\r
1828 <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>
\r
1833 <td class="msource"><a ext:cls="Ext.Component" ext:member="#event-beforestatesave" href="output/Ext.Component.html#event-beforestatesave">Component</a></td>
\r
1835 <tr class="event-row inherited expandable">
\r
1836 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1838 <a id="Ext.ProgressBar-destroy"></a>
\r
1839 <b>destroy</b> : ( <code>Ext.Component this</code> ) <div class="mdesc">
\r
1840 <div class="short">Fires after the component is destroyed.</div>
\r
1841 <div class="long">
\r
1842 Fires after the component is destroyed. <div class="mdetail-params">
\r
1843 <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
\r
1844 <ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li> </ul>
\r
1849 <td class="msource"><a ext:cls="Ext.Component" ext:member="#event-destroy" href="output/Ext.Component.html#event-destroy">Component</a></td>
\r
1851 <tr class="event-row inherited alt expandable">
\r
1852 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1854 <a id="Ext.ProgressBar-disable"></a>
\r
1855 <b>disable</b> : ( <code>Ext.Component this</code> ) <div class="mdesc">
\r
1856 <div class="short">Fires after the component is disabled.</div>
\r
1857 <div class="long">
\r
1858 Fires after the component is disabled. <div class="mdetail-params">
\r
1859 <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
\r
1860 <ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li> </ul>
\r
1865 <td class="msource"><a ext:cls="Ext.Component" ext:member="#event-disable" href="output/Ext.Component.html#event-disable">Component</a></td>
\r
1867 <tr class="event-row inherited expandable">
\r
1868 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1870 <a id="Ext.ProgressBar-enable"></a>
\r
1871 <b>enable</b> : ( <code>Ext.Component this</code> ) <div class="mdesc">
\r
1872 <div class="short">Fires after the component is enabled.</div>
\r
1873 <div class="long">
\r
1874 Fires after the component is enabled. <div class="mdetail-params">
\r
1875 <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
\r
1876 <ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li> </ul>
\r
1881 <td class="msource"><a ext:cls="Ext.Component" ext:member="#event-enable" href="output/Ext.Component.html#event-enable">Component</a></td>
\r
1883 <tr class="event-row inherited alt expandable">
\r
1884 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1886 <a id="Ext.ProgressBar-hide"></a>
\r
1887 <b>hide</b> : ( <code>Ext.Component this</code> ) <div class="mdesc">
\r
1888 <div class="short">Fires after the component is hidden.</div>
\r
1889 <div class="long">
\r
1890 Fires after the component is hidden. <div class="mdetail-params">
\r
1891 <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
\r
1892 <ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li> </ul>
\r
1897 <td class="msource"><a ext:cls="Ext.Component" ext:member="#event-hide" href="output/Ext.Component.html#event-hide">Component</a></td>
\r
1899 <tr class="event-row inherited expandable">
\r
1900 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1902 <a id="Ext.ProgressBar-move"></a>
\r
1903 <b>move</b> : ( <code>Ext.Component this</code>, <code>Number x</code>, <code>Number y</code> ) <div class="mdesc">
\r
1904 <div class="short">Fires after the component is moved.</div>
\r
1905 <div class="long">
\r
1906 Fires after the component is moved. <div class="mdetail-params">
\r
1907 <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
\r
1908 <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>
\r
1913 <td class="msource"><a ext:cls="Ext.BoxComponent" ext:member="#event-move" href="output/Ext.BoxComponent.html#event-move">BoxComponent</a></td>
\r
1915 <tr class="event-row inherited alt expandable">
\r
1916 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1918 <a id="Ext.ProgressBar-render"></a>
\r
1919 <b>render</b> : ( <code>Ext.Component this</code> ) <div class="mdesc">
\r
1920 <div class="short">Fires after the component is rendered.</div>
\r
1921 <div class="long">
\r
1922 Fires after the component is rendered. <div class="mdetail-params">
\r
1923 <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
\r
1924 <ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li> </ul>
\r
1929 <td class="msource"><a ext:cls="Ext.Component" ext:member="#event-render" href="output/Ext.Component.html#event-render">Component</a></td>
\r
1931 <tr class="event-row inherited expandable">
\r
1932 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1934 <a id="Ext.ProgressBar-resize"></a>
\r
1935 <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">
\r
1936 <div class="short">Fires after the component is resized.</div>
\r
1937 <div class="long">
\r
1938 Fires after the component is resized. <div class="mdetail-params">
\r
1939 <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
\r
1940 <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>
\r
1945 <td class="msource"><a ext:cls="Ext.BoxComponent" ext:member="#event-resize" href="output/Ext.BoxComponent.html#event-resize">BoxComponent</a></td>
\r
1947 <tr class="event-row inherited alt expandable">
\r
1948 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1950 <a id="Ext.ProgressBar-show"></a>
\r
1951 <b>show</b> : ( <code>Ext.Component this</code> ) <div class="mdesc">
\r
1952 <div class="short">Fires after the component is shown.</div>
\r
1953 <div class="long">
\r
1954 Fires after the component is shown. <div class="mdetail-params">
\r
1955 <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
\r
1956 <ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li> </ul>
\r
1961 <td class="msource"><a ext:cls="Ext.Component" ext:member="#event-show" href="output/Ext.Component.html#event-show">Component</a></td>
\r
1963 <tr class="event-row inherited expandable">
\r
1964 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1966 <a id="Ext.ProgressBar-staterestore"></a>
\r
1967 <b>staterestore</b> : ( <code>Ext.Component this</code>, <code>Object state</code> ) <div class="mdesc">
\r
1968 <div class="short">Fires after the state of the component is restored.</div>
\r
1969 <div class="long">
\r
1970 Fires after the state of the component is restored. <div class="mdetail-params">
\r
1971 <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
\r
1972 <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>
\r
1977 <td class="msource"><a ext:cls="Ext.Component" ext:member="#event-staterestore" href="output/Ext.Component.html#event-staterestore">Component</a></td>
\r
1979 <tr class="event-row inherited alt expandable">
\r
1980 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1982 <a id="Ext.ProgressBar-statesave"></a>
\r
1983 <b>statesave</b> : ( <code>Ext.Component this</code>, <code>Object state</code> ) <div class="mdesc">
\r
1984 <div class="short">Fires after the state of the component is saved to the configured state provider.</div>
\r
1985 <div class="long">
\r
1986 Fires after the state of the component is saved to the configured state provider. <div class="mdetail-params">
\r
1987 <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
\r
1988 <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>
\r
1993 <td class="msource"><a ext:cls="Ext.Component" ext:member="#event-statesave" href="output/Ext.Component.html#event-statesave">Component</a></td>
\r
1995 <tr class="event-row expandable">
\r
1996 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1998 <a id="Ext.ProgressBar-update"></a>
\r
1999 <b>update</b> : ( <code>Ext.ProgressBar this</code>, <code>Number The</code>, <code>String The</code> ) <div class="mdesc">
\r
2000 <div class="short">Fires after each update interval</div>
\r
2001 <div class="long">
\r
2002 Fires after each update interval <div class="mdetail-params">
\r
2003 <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
\r
2004 <ul><li><code>this</code> : Ext.ProgressBar<div class="sub-desc"></div></li><li><code>The</code> : Number<div class="sub-desc">current progress value</div></li><li><code>The</code> : String<div class="sub-desc">current progress text</div></li> </ul>
\r
2009 <td class="msource">ProgressBar</td>
\r