com.extjs.gxt.ui.client.widget
クラス ProgressBar

java.lang.Object
  com.google.gwt.user.client.ui.UIObject
      com.google.gwt.user.client.ui.Widget
          com.extjs.gxt.ui.client.widget.Component
              com.extjs.gxt.ui.client.widget.ProgressBar

すべての実装インターフェース:

Observable, com.google.gwt.user.client.EventListener

public class ProgressBar
extends Component

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(double, java.lang.String)) 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 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 asymchronous operations in which you have no need for indicating intermediate progress.

入れ子クラス 概要

クラス com.google.gwt.user.client.ui.UIObject から継承された 入れ子クラス/インターフェース

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Field 概要

クラス com.google.gwt.user.client.ui.UIObject から継承されたフィールド(Fields)

DEBUG_ID_PREFIX

コンストラクタ 概要

ProgressBar()
Creates a new progress bar.

メソッド 概要

ProgressBar	auto() Initiates an auto-updating progress bar using the current duration, increment, and interval.
int	getDuration() Returns the duration.
int	getIncrement() Returns the bar's increment value.
int	getInterval() Returns the bar's interval value.
double	getValue() Returns the current value.
boolean	isRunning() Returns true if the progress bar is currently in a auto() operation.
ProgressBar	reset() Resets the progress bar value to 0 and text to empty string.
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	setIncrement(int increment) The number of progress update segments to display within the progress bar (defaults to 10).
void	setInterval(int interval) Sets the length of time in milliseconds between each progress update (defaults to 300 ms).
ProgressBar	updateProgress(double value, java.lang.String text) Updates the progress bar value, and optionally its text.
void	updateText(java.lang.String text) Updates the progress bar text.

クラス com.extjs.gxt.ui.client.widget.Component から継承されたメソッド

addListener, addStyleName, addWidgetListener, disable, disableEvents, disableTextSelection, el, enable, enableEvents, fireEvent, fireEvent, fireEvent, fly, focus, getBaseStyle, getBorders, getData, getData, getElement, getId, getItemId, getModel, getState, getToolTip, hide, hideToolTip, isEnabled, isRendered, isVisible, onBrowserEvent, onComponentEvent, recalculate, removeAllListeners, removeFromParent, removeListener, removeStyleName, removeWidgetListener, render, render, saveState, setBorders, setData, setData, setElement, setEnabled, setEnableState, setHeight, setId, setIntStyleAttribute, setItemId, setPixelSize, setSize, setStyleAttribute, setStyleName, setTitle, setToolTip, setToolTip, setVisible, setWidth, show, toString

クラス com.google.gwt.user.client.ui.Widget から継承されたメソッド

getParent, isAttached

クラス com.google.gwt.user.client.ui.UIObject から継承されたメソッド

addStyleDependentName, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleName, getStylePrimaryName, getTitle, isVisible, removeStyleDependentName, setStylePrimaryName, setVisible, sinkEvents, unsinkEvents

クラス java.lang.Object から継承されたメソッド

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

コンストラクタ 詳細

ProgressBar

public ProgressBar()

Creates a new progress bar.

メソッド 詳細

auto

public ProgressBar auto()

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

戻り値:

this

getIncrement

public int getIncrement()

Returns the bar's increment value.

戻り値:

the increment the increment

getValue

public double getValue()

Returns the current value.

戻り値:

the value

isRunning

public boolean isRunning()

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

戻り値:

true if waiting, else false

reset

public ProgressBar reset()

Resets the progress bar value to 0 and text to empty string.

戻り値:

this

setIncrement

public void setIncrement(int increment)

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.

パラメータ:

increment - the new increment

updateProgress

public ProgressBar updateProgress(double value,
                                  java.lang.String text)

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.

パラメータ:

value - A value between 0 and 1 (e.g., .5, defaults to 0)

text - The string to display in the progress text element or null.

戻り値:

this

updateText

public void updateText(java.lang.String text)

Updates the progress bar text. If specified, textEl will be updated, otherwise the progress bar itself will display the updated text.

パラメータ:

text - The string to display in the progress text element

setInterval

public void setInterval(int interval)

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

パラメータ:

interval - the interval to set

getInterval

public int getInterval()

Returns the bar's interval value.

戻り値:

the interval in millseconds

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)

パラメータ:

duration - the duration in milliseconds

getDuration

public int getDuration()

Returns the duration.

戻り値:

the duration