Observable Component BoxComponent ProgressBar
Package: | Ext |
Defined In: | ProgressBar.js |
Class: | ProgressBar |
Extends: | BoxComponent |
An updateable progress bar component. The progress bar supports two different modes: manual and automatic.
In manual mode, you are responsible for showing, updating (via updateProgress) and clearing the progress bar as needed from your own code. This method is most appropriate when you want to show progress throughout an operation that has predictable points of interest at which you can update the control.
In automatic mode, you simply call wait and let the progress bar run indefinitely, only clearing it once the operation is complete. You can optionally have the progress bar wait for a specific amount of time and then clear itself. Automatic mode is most appropriate for timed operations or asymchronous operations in which you have no need for indicating intermediate progress.
Config Options | Defined By | |
---|---|---|
allowDomMove : Boolean
Whether the component can move the Dom node when rendering (defaults to true).
|
Component | |
applyTo : Mixed The id of the node, a DOM node or an existing Element corresponding to a DIV that is already present in the document ...
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 renderTo will be ignored and the target element's parent node will automatically be used as the component's container.
|
Component | |
autoEl : String/Object A tag name or DomHelper spec to create an element with. This is intended to create shorthand utility components inlin...
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:
|
Component | |
autoHeight : Boolean True to use height:'auto', false to use fixed height. Note: although many components inherit this config option, not ...
True to use height:'auto', false to use fixed height. Note: although many components inherit this config option, not all will function as expected with a height of 'auto'. (defaults to false).
|
BoxComponent | |
autoShow : Boolean True if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove them on render...
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).
|
Component | |
autoWidth : Boolean True to use width:'auto', false to use fixed width. Note: although many components inherit this config option, not al...
True to use width:'auto', false to use fixed width. Note: although many components inherit this config option, not all will function as expected with a width of 'auto'. (defaults to false).
|
BoxComponent | |
baseCls : String
The base CSS class to apply to the progress bar's wrapper element (defaults to 'x-progress')
|
ProgressBar | |
cls : String An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be useful for a...
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.
|
Component | |
ctCls : String An optional extra CSS class that will be added to this component's container (defaults to ''). This can be useful for...
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.
|
Component | |
disabled : Boolean
Render this component disabled (default is false).
|
Component | |
disabledClass : String
CSS class added to the component when it is disabled (defaults to "x-item-disabled").
|
Component | |
height : Number
The height of this component in pixels (defaults to auto).
|
BoxComponent | |
Render this component hidden (default is false).
|
hidden : Boolean Component | |
hideMode : String How this component should hidden. Supported values are "visibility" (css visibility), "offsets" (negative offset posi...
How this component should hidden. Supported values are "visibility" (css visibility), "offsets" (negative offset position) and "display" (css display) - defaults to "display".
|
Component | |
hideParent : Boolean True to hide and show the component's container when hide/show is called on the component, false to hide and show the...
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.
|
Component | |
id : String
The progress bar element's id (defaults to an auto-generated id)
|
ProgressBar | |
listeners : Object A config object containing one or more event handlers to be added to this object during initialization. This should b...
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 addListener example for attaching multiple handlers at once.
|
Observable | |
overCls : String An optional extra CSS class that will be added to this component's Element when the mouse moves over the Element, and...
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.
|
Component | |
pageX : Number
The page level x coordinate for this component if contained within a positioning container.
|
BoxComponent | |
pageY : Number
The page level y coordinate for this component if contained within a positioning container.
|
BoxComponent | |
plugins : Object/Array An object or array of objects that will provide custom functionality for this component. The only requirement for a v...
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.
|
Component | |
renderTo : Mixed The id of the node, a DOM node or an existing Element that will be the container to render this component into. Using...
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.
|
Component | |
stateEvents : Array An array of events that, when fired, should trigger this component to save its state (defaults to none). These can be...
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']).
See stateful for an explanation of saving and restoring Component state. |
Component | |
stateId : String The unique id for this component to use for state management purposes (defaults to the component id). See stateful fo...
The unique id for this component to use for state management purposes (defaults to the component id).
See stateful for an explanation of saving and restoring Component state. |
Component | |
stateful : Boolean A flag which causes the Component to attempt to restore the state of internal properties from a saved state on startu...
A flag which causes the Component to attempt to restore the state of internal properties from a saved state on startup.
For state saving to work, the state manager's provider must have been set to an implementation of Ext.state.Provider which overrides the set and get methods to save and recall name/value pairs. A built-in implementation, Ext.state.CookieProvider is available. To set the state provider for the current page: Components attempt to save state when one of the events listed in the stateEvents configuration fires. You can perform extra processing on state save and restore by attaching handlers to the beforestaterestore, staterestore, beforestatesave and statesave events |
Component | |
style : String A custom style specification to be applied to this component's Element. Should be a valid argument to Ext.Element.app...
A custom style specification to be applied to this component's Element. Should be a valid argument to Ext.Element.applyStyles.
|
Component | |
text : String
The progress bar text (defaults to '')
|
ProgressBar | |
textEl : Mixed
The element to render the progress text to (defaults to the progress bar's internal text element)
|
ProgressBar | |
value : Float
A floating point value between 0 and 1 (e.g., .5, defaults to 0)
|
ProgressBar | |
width : Number
The width of this component in pixels (defaults to auto).
|
BoxComponent | |
x : Number
The local x (left) coordinate for this component if contained within a positioning container.
|
BoxComponent | |
xtype : String The registered xtype to create. This config option is not used when passing a config object into a constructor. This ...
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 Component config object. The xtype will be looked up at render time up to determine what type of child Component to create.
The predefined xtypes are listed here. If you subclass Components to create your own Components, you may register them using Ext.ComponentMgr.registerType in order to be able to take advantage of lazy instantiation and rendering. |
Component | |
y : Number
The local y (top) coordinate for this component if contained within a positioning container.
|
BoxComponent |
Property | Defined By | |
---|---|---|
disabled : Boolean
True if this component is disabled. Read-only.
|
Component | |
True if this component is hidden. Read-only.
|
hidden : Boolean Component | |
initialConfig : Object
This Component's initial configuration specification. Read-only.
|
Component | |
ownerCt : Ext.Container The component's owner Ext.Container (defaults to undefined, and is set automatically when
the component is added to a...
The component's owner Ext.Container (defaults to undefined, and is set automatically when
the component is added to a container). Read-only.
|
Component | |
rendered : Boolean
True if this component has been rendered. Read-only.
|
Component |
Method | Defined By | |
---|---|---|
addClass( string cls ) : void Adds a CSS class to the component's underlying element.
Adds a CSS class to the component's underlying element.
Parameters:
|
Component | |
addEvents( Object object ) : void Used to define events on this Observable
Used to define events on this Observable
Parameters:
|
Observable | |
addListener( String eventName , Function handler , [Object scope ], [Object options ] ) : void Appends an event handler to this component
Appends an event handler to this component
Parameters:
|
Observable | |
applyToMarkup( String/HTMLElement el ) : void Apply this component to existing markup that is valid. With this function, no call to render() is required.
Apply this component to existing markup that is valid. With this function, no call to render() is required.
Parameters:
|
Component | |
cloneConfig( Object overrides ) : Ext.Component Clone the current component using the original config values passed into this instance by default.
Clone the current component using the original config values passed into this instance by default.
Parameters:
|
Component | |
destroy() : void Destroys this component by purging any event listeners, removing the component's element from the DOM,
removing the c...
Destroys this component by purging any event listeners, removing the component's element from the DOM,
removing the component from its Ext.Container (if applicable) and unregistering it from
Ext.ComponentMgr. Destruction is generally handled automatically by the framework and this method
should usually not need to be called directly.
Parameters:
|
Component | |
disable() : Ext.Component Disable this component.
Disable this component.
Parameters:
|
Component | |
enable() : Ext.Component Enable this component.
Enable this component.
Parameters:
|
Component | |
findParentBy( Function fcn , [Object scope ] ) : Array Find a container above this component at any level by a custom function. If the passed function returns
true, the con...
Find a container above this component at any level by a custom function. If the passed function returns
true, the container will be returned. The passed function is called with the arguments (container, this component).
Parameters:
|
Component | |
findParentByType( String/Class xtype ) : Container Find a container above this component at any level by xtype or class
Find a container above this component at any level by xtype or class
Parameters:
|
Component | |
fireEvent( String eventName , Object... args ) : Boolean Fires the specified event with the passed parameters (minus the event name).
Fires the specified event with the passed parameters (minus the event name).
Parameters:
|
Observable | |
focus( [Boolean selectText ], [Boolean/Number delay ] ) : Ext.Component Try to focus this component.
Try to focus this component.
Parameters:
|
Component | |
getBox( [Boolean local ] ) : Object Gets the current box measurements of the component's underlying element.
Gets the current box measurements of the component's underlying element.
Parameters:
|
BoxComponent | |
getEl() : Ext.Element Returns the underlying Ext.Element.
Returns the underlying Ext.Element.
Parameters:
|
Component | |
getId() : String Returns the id of this component.
Returns the id of this component.
Parameters:
|
Component | |
getItemId() : String Returns the item id of this component.
Returns the item id of this component.
Parameters:
|
Component | |
getPosition( [Boolean local ] ) : Array Gets the current XY position of the component's underlying element.
Gets the current XY position of the component's underlying element.
Parameters:
|
BoxComponent | |
getSize() : Object Gets the current size of the component's underlying element.
Gets the current size of the component's underlying element.
Parameters:
|
BoxComponent | |
getXType() : String Gets the xtype for this component as registered with Ext.ComponentMgr. For a list of all
available xtypes, see the Ex...
Gets the xtype for this component as registered with Ext.ComponentMgr. For a list of all
available xtypes, see the Ext.Component header. Example usage:
Parameters:
|
Component | |
getXTypes() : String Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all
available xtypes, see the Ext...
Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all available xtypes, see the Ext.Component header. If using your own subclasses, be aware that a Component must register its own xtype to participate in determination of inherited xtypes. Example usage:
Parameters:
|
Component | |
hasListener( String eventName ) : Boolean Checks to see if this object has any listeners for a specified event
Checks to see if this object has any listeners for a specified event
Parameters:
|
Observable | |
hide() : Ext.Component Hide this component.
Hide this component.
Parameters:
|
Component | |
isVisible() : void Returns true if this component is visible.
Returns true if this component is visible.
Parameters:
|
Component | |
isWaiting() : Boolean | ProgressBar | |
isXType( String xtype , [Boolean shallow ] ) : void Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended
from th...
Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended from the xtype (default) or whether it is directly of the xtype specified (shallow = true). If using your own subclasses, be aware that a Component must register its own xtype to participate in determination of inherited xtypes. For a list of all available xtypes, see the Ext.Component header. Example usage:
Parameters:
|
Component | |
on( String eventName , Function handler , [Object scope ], [Object options ] ) : void Appends an event handler to this element (shorthand for addListener)
Appends an event handler to this element (shorthand for addListener)
Parameters:
|
Observable | |
purgeListeners() : void Removes all listeners for this object
Removes all listeners for this object
Parameters:
|
Observable | |
relayEvents( Object o , Array events ) : void Relays selected events from the specified Observable as if the events were fired by this.
Relays selected events from the specified Observable as if the events were fired by this.
Parameters:
|
Observable | |
removeClass( string cls ) : void Removes a CSS class from the component's underlying element.
Removes a CSS class from the component's underlying element.
Parameters:
|
Component | |
removeListener( String eventName , Function handler , [Object scope ] ) : void Removes a listener
Removes a listener
Parameters:
|
Observable | |
render( [Element/HTMLElement/String container ], [String/Number position ] ) : void Render this Components into the passed HTML element.
If you are using a Container object to house this Component, the...
Render this Components into the passed HTML element. If you are using a Container object to house this Component, then do not use the render method. A Container's child Components are rendered by that Container's layout manager when the Container is first rendered. Certain layout managers allow dynamic addition of child components. Those that do include Ext.layout.CardLayout, Ext.layout.AnchorLayout, Ext.layout.FormLayout, Ext.layout.TableLayout. If the Container is already rendered when a new child Component is added, you may need to call the Container's doLayout to refresh the view which causes any unrendered child Components to be rendered. This is required so that you can add multiple child components if needed while only refreshing the layout once. When creating complex UIs, it is important to remember that sizing and positioning of child items is the responsibility of the Container's layout manager. If you expect child items to be sized in response to user interactions, you must configure the Container with a layout manager which creates and manages the type of layout you have in mind. Omitting the Container's layout config means that a basic layout manager is used which does nothnig but render child components sequentially into the Container. No sizing or positioning will be performed in this situation.
Parameters:
|
Component | |
reset( [Boolean hide ] ) : Ext.ProgressBar Resets the progress bar value to 0 and text to empty string. If hide = true, the progress
bar will also be hidden (u...
Resets the progress bar value to 0 and text to empty string. If hide = true, the progress
bar will also be hidden (using the hideMode property internally).
Parameters:
|
ProgressBar | |
resumeEvents() : void Resume firing events. (see suspendEvents)
Resume firing events. (see suspendEvents)
Parameters:
|
Observable | |
setDisabled( Boolean disabled ) : void Convenience function for setting disabled/enabled by boolean.
Convenience function for setting disabled/enabled by boolean.
Parameters:
|
Component | |
setHeight( Number height ) : Ext.BoxComponent
|
BoxComponent | |
setPagePosition( Number x , Number y ) : Ext.BoxComponent Sets the page XY position of the component. To set the left and top instead, use setPosition.
This method fires the ...
Sets the page XY position of the component. To set the left and top instead, use setPosition.
This method fires the move event.
Parameters:
|
BoxComponent | |
setPosition( Number left , Number top ) : Ext.BoxComponent Sets the left and top of the component. To set the page XY position instead, use setPagePosition.
This method fires ...
Sets the left and top of the component. To set the page XY position instead, use setPagePosition.
This method fires the move event.
Parameters:
|
BoxComponent | |
setSize( Number width , Number height ) : Ext.ProgressBar Sets the size of the progress bar.
Sets the size of the progress bar.
Parameters:
|
ProgressBar | |
setVisible( Boolean visible ) : Ext.Component Convenience function to hide or show this component by boolean.
Convenience function to hide or show this component by boolean.
Parameters:
|
Component | |
setWidth( Number width ) : Ext.BoxComponent
|
BoxComponent | |
show() : Ext.Component Show this component.
Show this component.
Parameters:
|
Component | |
suspendEvents() : void Suspend the firing of all events. (see resumeEvents)
Suspend the firing of all events. (see resumeEvents)
Parameters:
|
Observable | |
syncProgressBar() : void Synchronizes the inner bar width to the proper proportion of the total componet width based
on the current progress v...
Synchronizes the inner bar width to the proper proportion of the total componet width based
on the current progress value. This will be called automatically when the ProgressBar
is resized by a layout, but if it is rendered auto width, this method can be called from
another resize handler to sync the ProgressBar if necessary.
Parameters:
|
ProgressBar | |
syncSize() : Ext.BoxComponent Force the component's size to recalculate based on the underlying element's current height and width.
Force the component's size to recalculate based on the underlying element's current height and width.
Parameters:
|
BoxComponent | |
un( String eventName , Function handler , [Object scope ] ) : void Removes a listener (shorthand for removeListener)
Removes a listener (shorthand for removeListener)
Parameters:
|
Observable | |
updateBox( Object box ) : Ext.BoxComponent Sets the current box measurements of the component's underlying element.
Sets the current box measurements of the component's underlying element.
Parameters:
|
BoxComponent | |
updateProgress( [Float value ], [String text ] ) : Ext.ProgressBar Updates the progress bar value, and optionally its text. If the text argument is not specified,
any existing text va...
Updates the progress bar value, and optionally its text. If the text argument is not specified,
any existing text value will be unchanged. To blank out existing text, pass ''. Note that even
if the progress bar value exceeds 1, it will never automatically reset -- you are responsible for
determining when the progress is complete and calling reset to clear and/or hide the control.
Parameters:
|
ProgressBar | |
updateText( [String text ] ) : Ext.ProgressBar Updates the progress bar text. If specified, textEl will be updated, otherwise the progress
bar itself will display ...
Updates the progress bar text. If specified, textEl will be updated, otherwise the progress
bar itself will display the updated text.
Parameters:
|
ProgressBar | |
wait( [Object config ] ) : Ext.ProgressBar Initiates an auto-updating progress bar. A duration can be specified, in which case the progress
bar will automatica...
Initiates an auto-updating progress bar. A duration can be specified, in which case the progress
bar will automatically reset after a fixed amount of time and optionally call a callback function
if specified. If no duration is passed in, then the progress bar will run indefinitely and must
be manually cleared by calling reset. The wait method accepts a config object with
the following properties:
Property Type Description ---------- ------------ ---------------------------------------------------------------------- duration Number The length of time in milliseconds that the progress bar should run before resetting itself (defaults to undefined, in which case it will run indefinitely until reset is called) interval Number The length of time in milliseconds between each progress update (defaults to 1000 ms) increment Number The number of progress update segments to display within the progress bar (defaults to 10). If the bar reaches the end and is still updating, it will automatically wrap back to the beginning. text String Optional text to display in the progress bar element (defaults to ''). fn Function A callback function to execute after the progress bar finishes auto- updating. The function will be called with no arguments. This function will be ignored if duration is not specified since in that case the progress bar can only be stopped programmatically, so any required function should be called by the same code after it resets the progress bar. scope Object The scope that is passed to the callback function (only applies when duration and fn are both passed).Example usage:
Parameters:
|
ProgressBar |
Event | Defined By | |
---|---|---|
beforedestroy : ( Ext.Component this ) Fires before the component is destroyed. Return false to stop the destroy.
Fires before the component is destroyed. Return false to stop the destroy.
Listeners will be called with the following arguments:
|
Component | |
beforehide : ( Ext.Component this ) Fires before the component is hidden. Return false to stop the hide.
Fires before the component is hidden. Return false to stop the hide.
Listeners will be called with the following arguments:
|
Component | |
beforerender : ( Ext.Component this ) Fires before the component is rendered. Return false to stop the render.
Fires before the component is rendered. Return false to stop the render.
Listeners will be called with the following arguments:
|
Component | |
beforeshow : ( Ext.Component this ) Fires before the component is shown. Return false to stop the show.
Fires before the component is shown. Return false to stop the show.
Listeners will be called with the following arguments:
|
Component | |
beforestaterestore : ( Ext.Component this , Object state ) Fires before the state of the component is restored. Return false to stop the restore.
Fires before the state of the component is restored. Return false to stop the restore.
Listeners will be called with the following arguments:
|
Component | |
beforestatesave : ( Ext.Component this , Object state ) Fires before the state of the component is saved to the configured state provider. Return false to stop the save.
Fires before the state of the component is saved to the configured state provider. Return false to stop the save.
Listeners will be called with the following arguments:
|
Component | |
destroy : ( Ext.Component this ) Fires after the component is destroyed.
Fires after the component is destroyed.
Listeners will be called with the following arguments:
|
Component | |
disable : ( Ext.Component this ) Fires after the component is disabled.
Fires after the component is disabled.
Listeners will be called with the following arguments:
|
Component | |
enable : ( Ext.Component this ) Fires after the component is enabled.
Fires after the component is enabled.
Listeners will be called with the following arguments:
|
Component | |
hide : ( Ext.Component this ) Fires after the component is hidden.
Fires after the component is hidden.
Listeners will be called with the following arguments:
|
Component | |
move : ( Ext.Component this , Number x , Number y ) Fires after the component is moved.
Fires after the component is moved.
Listeners will be called with the following arguments:
|
BoxComponent | |
render : ( Ext.Component this ) Fires after the component is rendered.
Fires after the component is rendered.
Listeners will be called with the following arguments:
|
Component | |
resize : ( Ext.Component this , Number adjWidth , Number adjHeight , Number rawWidth , Number rawHeight ) Fires after the component is resized.
Fires after the component is resized.
Listeners will be called with the following arguments:
|
BoxComponent | |
show : ( Ext.Component this ) Fires after the component is shown.
Fires after the component is shown.
Listeners will be called with the following arguments:
|
Component | |
staterestore : ( Ext.Component this , Object state ) Fires after the state of the component is restored.
Fires after the state of the component is restored.
Listeners will be called with the following arguments:
|
Component | |
statesave : ( Ext.Component this , Object state ) Fires after the state of the component is saved to the configured state provider.
Fires after the state of the component is saved to the configured state provider.
Listeners will be called with the following arguments:
|
Component | |
update : ( Ext.ProgressBar this , Number The , String The ) Fires after each update interval
Fires after each update interval
Listeners will be called with the following arguments:
|
ProgressBar |