X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/2e847cf21b8ab9d15fa167b315ca5b2fa92638fc..e9397f91ede62d446aed37d23256e8938fc4c335:/docs/output/Ext.ProgressBar.html?ds=inline diff --git a/docs/output/Ext.ProgressBar.html b/docs/output/Ext.ProgressBar.html index e0203f5a..dda2e421 100644 --- a/docs/output/Ext.ProgressBar.html +++ b/docs/output/Ext.ProgressBar.html @@ -1,10 +1,13 @@ -
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 asynchronous operations in +
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 asynchronous 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 | |
anchor : String Note: this config is only used when this Component is rendered
by a Container which has been configured to use an Anc... Note: this config is only used when this Component is rendered by a Container which has been configured to use an AnchorLayout (or subclass thereof). @@ -129,7 +132,10 @@ Warning: This will override any size manag... The maxi Warning: This will override any size mana... The minimum value in pixels which this BoxComponent will set its height to. Warning: This will override any size management applied by layout managers. | BoxComponent | |
boxMinWidth : Number The minimum value in pixels which this BoxComponent will set its width to.
Warning: This will override any size manag... The minimum value in pixels which this BoxComponent will set its width to. -Warning: This will override any size management applied by layout managers. | BoxComponent | |
clearCls : String The CSS class used to to apply to the special clearing div rendered
+ Warning: This will override any size management applied by layout managers. | BoxComponent | |
bubbleEvents : Array An array of events that, when fired, should be bubbled to any parent container.
+See Ext.util.Observable.enableBubble.... An array of events that, when fired, should be bubbled to any parent container. +See Ext.util.Observable.enableBubble. +Defaults to []. | Component | |
clearCls : String The CSS class used to to apply to the special clearing div rendered
directly after each form field wrapper to provide... The CSS class used to to apply to the special clearing div rendered directly after each form field wrapper to provide field clearing (defaults to 'x-form-clear-left'). @@ -525,7 +531,7 @@ Ext.Element.ap...A custom style specification to be appl
A string to be used as innerHTML... Note: this config is only used when this BoxComponent is a child item of a TabPanel. A string to be used as innerHTML (html tags are accepted) to show in a tooltip when mousing over the associated tab selector element. Ext.QuickTips.init() -must be called in order for the tips to render. | BoxComponent | |
text : String The progress bar text (defaults to '') | ProgressBar | |
textEl : Mixed The element to render the progress text to (defaults to the progress
+must be called in order for the tips to render. | BoxComponent | |
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 | |
tpl : Mixed An Ext.Template, Ext.XTemplate
or an array of strings to form an Ext.XTemplate.
Used in conjunction with the data and... Returns:
| Observable | |
applyToMarkup( String/HTMLElement el )
:
- voidApply 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 )
+ voidApply 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 | |
bubble( Function fn , [Object scope ], [Array args ] )
+ :
+ Ext.ComponentBubbles up the component/container heirarchy, calling the specified function with each component. The scope (this) of... Bubbles up the component/container heirarchy, calling the specified function with each component. The scope (this) of
+function call will be the scope provided or the current component. The arguments to the function
+will be the args provided or the current component. If the function returns false at any point,
+the bubble is stopped. Parameters:
| Component | |
cloneConfig( Object overrides )
:
Ext.ComponentClone 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()
@@ -644,45 +655,47 @@ should usually not need to be called directly. Enable this component and fire the 'enable' event. Enable this component and fire the 'enable' event. Parameters:
| Component | |
enableBubble( String/Array events )
:
- voidEnables events fired by this Observable to bubble up an owner hierarchy by calling
-this.getBubbleTarget() if present... Enables events fired by this Observable to bubble up an owner hierarchy by calling
- This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default -implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to -access the required target more quickly. -Example:
| Observable | |
findParentBy( Function fn )
:
Ext.ContainerFind 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. Parameters:
| Component | |
findParentByType( String/Class xtype )
+true, the container will be returned.Parameters:
| Component | |
findParentByType( String/Ext.Component/Class xtype , [Boolean shallow ] )
:
- Ext.ContainerFind 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 )
+ Ext.ContainerFind 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 )
:
BooleanFires the specified event with the passed parameters (minus the event name).
An event may be set to bubble up an Obse... Fires the specified event with the passed parameters (minus the event name). @@ -768,7 +781,7 @@ the component is configured to be
| Component | |
isWaiting()
:
- Boolean Returns true if the progress bar is currently in a wait operation Returns true if the progress bar is currently in a wait operation Parameters:
| ProgressBar | |
isXType( String xtype , [Boolean shallow ] )
+ BooleanReturns true if the progress bar is currently in a wait operation Returns true if the progress bar is currently in a wait operation Parameters:
| ProgressBar | |
isXType( String/Ext.Component/Class xtype , [Boolean shallow ] )
:
BooleanTests 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 @@ -780,7 +793,11 @@ to participate in determination of inherited xtypes.
Parameters:
| Component | |
mon( Observable|Element item , Object|String ename , Function fn , Object scope , Object opt )
:
voidAdds listeners to any Observable object (or Elements) which are automatically removed when this Component
@@ -841,8 +858,8 @@ Container. No sizing or positioning will be performed in this situation.
rendered into. If it is being created from existing markup, this should be omitted. position : String/Number(optional) The element ID or DOM node index within the container before
which this component will be inserted (defaults to appending to the end of the container)
| Component | |
reset( [Boolean hide ] )
:
- Ext.ProgressBarResets the progress bar value to 0 and text to empty string. If hide = true, the progress
-bar will also be hidden (... Resets the progress bar value to 0 and text to empty string. If hide = true, the progress
+ 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)
@@ -853,10 +870,10 @@ events fired during event suspension will be sent to any listeners now. Sets the overflow on the content element of the component. Sets the overflow on the content element of the component. Parameters:
| BoxComponent | |
setDisabled( Boolean disabled )
:
- Ext.ComponentConvenience function for setting disabled/enabled by boolean. Convenience function for setting disabled/enabled by boolean. Parameters:
| Component | |
setHeight( Number height )
+ Ext.ComponentConvenience function for setting disabled/enabled by boolean. Convenience function for setting disabled/enabled by boolean. Parameters:
| Component | |
setHeight( Mixed height )
:
- Ext.BoxComponentSets the height of the component. This method fires the resize event. Sets the height of the component. This method fires the resize event. Parameters:
| BoxComponent | |
setPagePosition( Number x , Number y )
@@ -871,10 +888,10 @@ This method fires the Sets the size of the progress bar. Sets the size of the progress bar. Parameters:
| ProgressBar | |
setVisible( Boolean visible )
:
- Ext.ComponentConvenience 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.ComponentConvenience function to hide or show this component by boolean. Convenience function to hide or show this component by boolean. Parameters:
| Component | |
setWidth( Mixed width )
:
- Ext.BoxComponentSets the width of the component. This method fires the resize event. Sets the width of the component. This method fires the resize event. Parameters:
| BoxComponent | |
show()
:
@@ -886,10 +903,10 @@ event after showing the component. Parameters
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 ... 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
+ 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 ] )
@@ -903,67 +920,67 @@ content area will be updated via Ext.Element updateloadScri
:
Ext.BoxComponent | BoxComponent | |
updateProgress( [Float value ], [String text ], [Boolean animate ] )
:
- Ext.ProgressBarUpdates the progress bar value, and optionally its text. If the text argument is not specified,
-any existing text v... 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.ProgressBarUpdates 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
+ 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.ProgressBarInitiates an auto-updating progress bar. A duration can be specified, in which case the progress
-bar will automatic... 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) -animate Boolean Whether to animate the transition of the progress bar. If this value is - not specified, the default for the class is used. -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: -
| ProgressBar |
Event | Defined By | |
---|---|---|
added :
( Ext.Component this , Ext.Container ownerCt , number index )
Fires when a component is added to an Ext.Container Fires when a component is added to an Ext.Container Listeners will be called with the following arguments:
| Component | |
afterrender : |