com.sencha.gxt.widget.core.client

Class AutoProgressBar

java.lang.Object

Widget

com.sencha.gxt.widget.core.client.Component

com.sencha.gxt.widget.core.client.cell.CellComponent<Double>

com.sencha.gxt.widget.core.client.ProgressBar

com.sencha.gxt.widget.core.client.AutoProgressBar

All Implemented Interfaces:

BeforeHideEvent.HasBeforeHideHandlers, BeforeShowContextMenuEvent.HasBeforeShowContextMenuHandler, BeforeShowEvent.HasBeforeShowHandlers, BlurEvent.HasBlurHandlers, DisableEvent.HasDisableHandlers, EnableEvent.HasEnableHandlers, FocusEvent.HasFocusHandlers, HideEvent.HasHideHandlers, MoveEvent.HasMoveHandlers, ShowContextMenuEvent.HasShowContextMenuHandler, ShowEvent.HasShowHandlers, HasFocusSupport, HasItemId

public class AutoProgressBar
extends ProgressBar

An auto mode progress bar widget.

You simply call auto() 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.

Field Summary

Fields inherited from class com.sencha.gxt.widget.core.client.cell.CellComponent

valueUpdater

Fields inherited from class com.sencha.gxt.widget.core.client.Component

adjustSize, allowTextSelection, cacheSizes, disableContextMenu, disabled, disabledStyle, ensureVisibilityOnSizing, height, hidden, lastSize, layer, left, mask, maskMessage, monitorWindowResize, pageX, pageY, resizeHandler, shim, tabIndex, toolTip, toolTipConfig, top, width, windowResizeDelay, windowResizeTask

Constructor Summary

Constructors

Constructor and Description
AutoProgressBar() Creates a new progress bar with the default automatic progress bar cell.
AutoProgressBar(AutoProgressBarCell cell) Creates a new progress bar with the specified automatic progress bar cell.

Method Summary

Modifier and Type	Method and Description
void	auto() Initiates an auto-updating progress bar using the current duration, increment, and interval.
AutoProgressBarCell	getCell() Get the Cell wrapped by this widget.
int	getDuration() Returns the duration.
int	getInterval() Returns the bar's interval value.
boolean	isRunning() Returns true if the progress bar is currently in a auto() operation.
protected void	onDetach()
void	setDuration(int duration) The length of time in milliseconds that the progress bar should run before resetting itself (defaults to DEFAULT, in which case it will run indefinitely until reset is called).
void	setInterval(int interval) Sets the length of time in milliseconds between each progress update (defaults to 300 ms).

Methods inherited from class com.sencha.gxt.widget.core.client.ProgressBar

getIncrement, reset, setIncrement, updateProgress, updateText

Methods inherited from class com.sencha.gxt.widget.core.client.cell.CellComponent

addValueChangeHandler, createContext, getElement, getFocusEl, getKey, getKeyProvider, getValue, onAfterFirstAttach, onBrowserEvent, onDisable, onEnable, onRedraw, onResize, redraw, redraw, setKeyProvider, setValue, setValue, setValue

Methods inherited from class com.sencha.gxt.widget.core.client.Component

addBeforeHideHandler, addBeforeShowContextMenuHandler, addBeforeShowHandler, addBlurHandler, addDisableHandler, addEnableHandler, addFocusHandler, addHideHandler, addMoveHandler, addResizeHandler, addShowContextMenuHandler, addShowHandler, addStyleDependentName, addStyleOnOver, adjustPosition, adjustSize, applyState, assertAfterRender, assertPreRender, blur, clearSizeCache, disable, disableContextMenu, disableEvents, enable, enableEvents, fireCancellableEvent, fireEvent, focus, getData, getFocusSupport, getHideMode, getId, getItemId, getOffsetHeight, getOffsetWidth, getPositionEl, getShadow, getShadowPosition, getStateId, getTabIndex, getToolTip, hide, hideShadow, hideToolTip, isAllowTextSelection, isAutoHeight, isAutoWidth, isDeferHeight, isEnabled, isMonitorWindowResize, isRendered, isStateful, isVisible, isVisible, mask, mask, notifyHide, notifyShow, onAttach, onBlur, onFocus, onHide, onHideContextMenu, onLoad, onPosition, onRightClick, onShow, onShowContextMenu, onUnload, onWindowResize, removeStyleDependentName, removeStyleOnOver, removeToolTip, setAllowTextSelection, setBorders, setBounds, setBounds, setContextMenu, setData, setDeferHeight, setEnabled, setHeight, setHeight, setHideMode, setId, setItemId, setMonitorWindowResize, setPagePosition, setPixelSize, setPosition, setShadow, setShadowPosition, setSize, setStateful, setStateId, setStyleDependentName, setTabIndex, setToolTip, setToolTipConfig, setVisible, setWidth, setWidth, show, sync, syncSize, unmask

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AutoProgressBar

public AutoProgressBar()

Creates a new progress bar with the default automatic progress bar cell.

AutoProgressBar

public AutoProgressBar(AutoProgressBarCell cell)

Creates a new progress bar with the specified automatic progress bar cell.

Parameters:

cell - the automatic progress bar cell

Method Detail

auto

public void auto()

Initiates an auto-updating progress bar using the current duration, increment, and interval.

getCell

public AutoProgressBarCell getCell()

Description copied from class: CellComponent

Get the Cell wrapped by this widget.

Overrides:

getCell in class ProgressBar

Returns:

the Cell being wrapped

getDuration

public int getDuration()

Returns the duration.

Returns:

the duration

getInterval

public int getInterval()

Returns the bar's interval value.

Returns:

the interval in milliseconds

isRunning

public boolean isRunning()

Returns true if the progress bar is currently in a auto() operation.

Returns:

true if waiting, else false

setDuration

public void setDuration(int duration)

The length of time in milliseconds that the progress bar should run before resetting itself (defaults to DEFAULT, in which case it will run indefinitely until reset is called).

Parameters:

duration - the duration in milliseconds

setInterval

public void setInterval(int interval)

Sets the length of time in milliseconds between each progress update (defaults to 300 ms).

Parameters:

interval - the interval to set

onDetach

protected void onDetach()

Overrides:

onDetach in class Component