com.sencha.gxt.cell.core.client

Class ProgressBarCell

java.lang.Object

<any>

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

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

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

All Implemented Interfaces:

ResizableCell

Direct Known Subclasses:

AutoProgressBarCell

public class ProgressBarCell
extends ResizeCell<Double>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ProgressBarCell.ProgressBarAppearance
static class	ProgressBarCell.ProgressBarAppearanceOptions

Field Summary

Fields

Modifier and Type	Field and Description
protected ProgressBarCell.ProgressBarAppearance	appearance
protected int	increment
protected String	progressText

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

height, width

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

cellGestureAdapters, disableEvents, handlerManager

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ProgressBarCell.ProgressBarAppearance	getAppearance() Returns the progress bar appearance.
int	getIncrement() Returns the bar's increment value.
String	getProgressText() Returns the progress text.
void	render(Context context, Double value, SafeHtmlBuilder sb)
void	reset(Context context, XElement parent) Resets the progress bar value to 0 and text to empty string.
void	setIncrement(int increment) The number of progress update segments to display within the progress bar (defaults to 10).
void	setProgressText(String text) Sets the progress text to be displayed in the progress bar.
void	updateProgress(Context context, XElement parent, double value, String text) Updates the progress bar value, and optionally its text.

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

addCellGestureAdapter, addHandler, createHandlerManager, fireCancellableEvent, fireCancellableEvent, fireEvent, fireEvent, getCellGestureAdapter, getCellGestureAdapterCount, isDisableEvents, onBrowserEvent, onTouch, removeCellGestureAdapter, setConsumedEventsInternal, setDisableEvents

Methods inherited from class java.lang.Object

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

Field Detail

appearance

protected final ProgressBarCell.ProgressBarAppearance appearance

increment

protected int increment

progressText

protected String progressText

Constructor Detail

ProgressBarCell

public ProgressBarCell()

ProgressBarCell

public ProgressBarCell(ProgressBarCell.ProgressBarAppearance appearance)

Method Detail

getAppearance

public ProgressBarCell.ProgressBarAppearance getAppearance()

Returns the progress bar appearance.

Returns:

the appearance

getIncrement

public int getIncrement()

Returns the bar's increment value.

Returns:

the increment the increment

getProgressText

public String getProgressText()

Returns the progress text.

Returns:

the progress text

render

public void render(Context context,
                   Double value,
                   SafeHtmlBuilder sb)

reset

public void reset(Context context,
                  XElement parent)

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

Parameters:

context - the cell context

parent - the parent element

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.

Parameters:

increment - the new increment

setProgressText

public void setProgressText(String text)

Sets the progress text to be displayed in the progress bar. If the text contains '{0}' it will be replaced with the current progress bar value (0 - 100).

Parameters:

text - the progress text

updateProgress

public void updateProgress(Context context,
                           XElement parent,
                           double value,
                           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(Context, com.sencha.gxt.core.client.dom.XElement) to clear and/or hide the control.

Parameters:

context - the cell context

parent - the parent element

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