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

java.lang.Object
  extended by com.google.gwt.user.client.ui.UIObject
      extended by com.google.gwt.user.client.ui.Widget
          extended by com.sencha.gxt.widget.core.client.Component
              extended by com.sencha.gxt.widget.core.client.cell.CellComponent<Double>
                  extended by com.sencha.gxt.widget.core.client.ProgressBar
                      extended by com.sencha.gxt.widget.core.client.AutoProgressBar
All Implemented Interfaces:
Editor<Double>, LeafValueEditor<Double>, HasAttachHandlers, HasResizeHandlers, HasValueChangeHandlers<Double>, HasHandlers, EventListener, TakesValue<Double>, HasValue<Double>, HasVisibility, IsWidget, HasKeyProvider<Double>, 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.


Nested Class Summary
 
Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject
UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled
 
Nested classes/interfaces inherited from interface com.google.gwt.editor.client.Editor
Editor.Ignore, Editor.Path
 
Field Summary
 
Fields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX
 
Constructor Summary
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
 void auto()
          Initiates an auto-updating progress bar using the current duration, increment, and interval.
 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.
 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
getCell, getIncrement, reset, setIncrement, updateProgress, updateText
 
Methods inherited from class com.sencha.gxt.widget.core.client.cell.CellComponent
addValueChangeHandler, getElement, getKeyProvider, getValue, onBrowserEvent, redraw, 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, addStyleOnOver, clearSizeCache, disable, disableEvents, enable, enableEvents, fireEvent, focus, getData, getFocusSupport, getHideMode, getId, getItemId, getOffsetHeight, getOffsetWidth, getShadow, getStateId, getToolTip, hide, hideToolTip, isAllowTextSelection, isAutoHeight, isAutoWidth, isDeferHeight, isEnabled, isRendered, isStateful, isVisible, isVisible, mask, mask, removeToolTip, setAllowTextSelection, setBorders, setBounds, setBounds, setContextMenu, setData, setDeferHeight, setEnabled, setHeight, setHeight, setHideMode, setId, setItemId, setPagePosition, setPixelSize, setPosition, setShadow, setSize, setStateful, setStateId, setTabIndex, setToolTip, setToolTipConfig, setVisible, setWidth, setWidth, show, sync, syncSize, unmask
 
Methods inherited from class com.google.gwt.user.client.ui.Widget
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, getLayoutData, getParent, isAttached, removeFromParent, setLayoutData, sinkEvents
 
Methods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleName, getStylePrimaryName, getTitle, isVisible, removeStyleDependentName, removeStyleName, setStyleDependentName, setStyleName, setStyleName, setStylePrimaryName, setTitle, setVisible, sinkBitlessEvent, toString, unsinkEvents
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 

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.


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


Copyright © 2012. All Rights Reserved.