com.sencha.gxt.cell.core.client

Class AutoProgressBarCell

java.lang.Object

com.google.gwt.cell.client.AbstractCell<C>

com.sencha.gxt.cell.core.client.AbstractEventCell<C>

com.sencha.gxt.cell.core.client.ResizeCell<Double>

com.sencha.gxt.cell.core.client.ProgressBarCell

com.sencha.gxt.cell.core.client.AutoProgressBarCell

All Implemented Interfaces:

Cell<Double>, ResizableCell

public class AutoProgressBarCell
extends ProgressBarCell

Nested Class Summary

Nested classes/interfaces inherited from class com.sencha.gxt.cell.core.client.ProgressBarCell

ProgressBarCell.ProgressBarAppearance, ProgressBarCell.ProgressBarAppearanceOptions

Nested classes/interfaces inherited from interface com.google.gwt.cell.client.Cell

Cell.Context

Constructor Summary

Constructors

Constructor and Description
AutoProgressBarCell()
AutoProgressBarCell(ProgressBarCell.ProgressBarAppearance appearance)

Method Summary

Methods

Modifier and Type	Method and Description
void	auto(Cell.Context context, XElement parent) 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(com.google.gwt.cell.client.Cell.Context, com.sencha.gxt.core.client.dom.XElement) operation.
void	reset(Cell.Context context, XElement parent) 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	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.cell.core.client.ProgressBarCell

getAppearance, getIncrement, getProgressText, render, setIncrement, setProgressText, updateProgress

Methods inherited from class com.sencha.gxt.cell.core.client.ResizeCell

getHeight, getWidth, redrawOnResize, setHeight, setSize, setSize, setWidth

Methods inherited from class com.sencha.gxt.cell.core.client.AbstractEventCell

addHandler, fireEvent, isDisableEvents, setDisableEvents

Methods inherited from class com.google.gwt.cell.client.AbstractCell

dependsOnSelection, getConsumedEvents, handlesSelection, isEditing, onBrowserEvent, resetFocus, setValue

Methods inherited from class java.lang.Object

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

Constructor Detail

AutoProgressBarCell

public AutoProgressBarCell()

AutoProgressBarCell

public AutoProgressBarCell(ProgressBarCell.ProgressBarAppearance appearance)

Method Detail

auto

public void auto(Cell.Context context,
        XElement parent)

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(com.google.gwt.cell.client.Cell.Context, com.sencha.gxt.core.client.dom.XElement) operation.

Returns:

true if waiting, else false

reset

public void reset(Cell.Context context,
         XElement parent)

Description copied from class: ProgressBarCell

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

Overrides:

reset in class ProgressBarCell

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