org.wisepersist.gwt.uploader.client.progress

Class ProgressBar

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.Widget

org.wisepersist.gwt.uploader.client.progress.ProgressBar

All Implemented Interfaces:

com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.IsWidget, ResizableWidget

public class ProgressBar
extends com.google.gwt.user.client.ui.Widget
implements ResizableWidget

A widget that displays progress on an arbitrary scale.

CSS Style Rules

• .gwt-ProgressBar-shell { primary style }
• .gwt-ProgressBar-shell .gwt-ProgressBar-bar { the actual progress bar }
• .gwt-ProgressBar-shell .gwt-ProgressBar-text { text on the bar }
• .gwt-ProgressBar-shell .gwt-ProgressBar-text-firstHalf { applied to text when progress is less than 50 percent }
• .gwt-ProgressBar-shell .gwt-ProgressBar-text-secondHalf { applied to text when progress is greater than 50 percent }

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProgressBar.TextFormatter A formatter used to format the text displayed in the progress bar widget.

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

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

Field Summary

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
ProgressBar() Create a progress bar with default range of 0 to 100.
ProgressBar(double curProgress) Create a progress bar with an initial progress and a default range of 0 to 100.
ProgressBar(double minProgress, double maxProgress) Create a progress bar within the given range.
ProgressBar(double minProgress, double maxProgress, double curProgress) Create a progress bar within the given range starting at the specified progress amount.
ProgressBar(double minProgress, double maxProgress, double curProgress, ProgressBar.TextFormatter textFormatter) Create a progress bar within the given range starting at the specified progress amount.

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	generateText(double curProgress) Generate the text to display within the progress bar.
protected com.google.gwt.user.client.Element	getBarElement() Get the bar element.
double	getMaxProgress() Get the maximum progress.
double	getMinProgress() Get the minimum progress.
double	getPercent() Get the current percent complete, relative to the minimum and maximum values.
double	getProgress() Get the current progress.
protected com.google.gwt.user.client.Element	getTextElement() Get the text element.
ProgressBar.TextFormatter	getTextFormatter() Get the text formatter.
boolean	isTextVisible() Check whether the text is visible or not.
protected void	onLoad() This method is called immediately after a widget becomes attached to the browser's document.
void	onResize(int width, int height) This method is called when the dimensions of the parent element change.
protected void	onUnload()
void	redraw() Redraw the progress bar when something changes the layout.
protected void	resetProgress() Reset the progress text based on the current min and max progress range.
void	setBarStyleName(java.lang.String barClassName)
void	setMaxProgress(double maxProgress) Set the maximum progress.
void	setMinProgress(double minProgress) Set the minimum progress.
void	setProgress(double curProgress) Set the current progress.
void	setTextFirstHalfStyleName(java.lang.String textFirstHalfClassName)
void	setTextFormatter(ProgressBar.TextFormatter textFormatter) Set the text formatter.
void	setTextSecondHalfStyleName(java.lang.String textSecondHalfClassName)
void	setTextStyleName(java.lang.String textClassName)
void	setTextVisible(boolean textVisible) Sets whether the text is visible over the bar.

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.wisepersist.gwt.uploader.client.progress.ResizableWidget

getElement, isAttached

Constructor Detail

ProgressBar

public ProgressBar()

Create a progress bar with default range of 0 to 100.

ProgressBar

public ProgressBar(double curProgress)

Create a progress bar with an initial progress and a default range of 0 to 100.

Parameters:

curProgress - the current progress

ProgressBar

public ProgressBar(double minProgress,
                   double maxProgress)

Create a progress bar within the given range.

Parameters:

minProgress - the minimum progress

maxProgress - the maximum progress

ProgressBar

public ProgressBar(double minProgress,
                   double maxProgress,
                   double curProgress)

Create a progress bar within the given range starting at the specified progress amount.

Parameters:

minProgress - the minimum progress

maxProgress - the maximum progress

curProgress - the current progress

ProgressBar

public ProgressBar(double minProgress,
                   double maxProgress,
                   double curProgress,
                   ProgressBar.TextFormatter textFormatter)

Create a progress bar within the given range starting at the specified progress amount.

Parameters:

minProgress - the minimum progress

maxProgress - the maximum progress

curProgress - the current progress

textFormatter - the text formatter

Method Detail

getMaxProgress

public double getMaxProgress()

Get the maximum progress.

Returns:

the maximum progress

getMinProgress

public double getMinProgress()

Get the minimum progress.

Returns:

the minimum progress

getPercent

public double getPercent()

Get the current percent complete, relative to the minimum and maximum values. The percent will always be between 0.0 - 1.0.

Returns:

the current percent complete

getProgress

public double getProgress()

Get the current progress.

Returns:

the current progress

getTextFormatter

public ProgressBar.TextFormatter getTextFormatter()

Get the text formatter.

Returns:

the text formatter

isTextVisible

public boolean isTextVisible()

Check whether the text is visible or not.

Returns:

true if the text is visible

onResize

public void onResize(int width,
                     int height)

This method is called when the dimensions of the parent element change. Subclasses should override this method as needed. Move the text to the center of the progress bar.

Specified by:

onResize in interface ResizableWidget

Parameters:

width - the new client width of the element

height - the new client height of the element

redraw

public void redraw()

Redraw the progress bar when something changes the layout.

setBarStyleName

public void setBarStyleName(java.lang.String barClassName)

setMaxProgress

public void setMaxProgress(double maxProgress)

Set the maximum progress. If the minimum progress is more than the current progress, the current progress is adjusted to be within the new range.

Parameters:

maxProgress - the maximum progress

setMinProgress

public void setMinProgress(double minProgress)

Set the minimum progress. If the minimum progress is more than the current progress, the current progress is adjusted to be within the new range.

Parameters:

minProgress - the minimum progress

setProgress

public void setProgress(double curProgress)

Set the current progress.

Parameters:

curProgress - the current progress

setTextFirstHalfStyleName

public void setTextFirstHalfStyleName(java.lang.String textFirstHalfClassName)

setTextFormatter

public void setTextFormatter(ProgressBar.TextFormatter textFormatter)

Set the text formatter.

Parameters:

textFormatter - the text formatter

setTextSecondHalfStyleName

public void setTextSecondHalfStyleName(java.lang.String textSecondHalfClassName)

setTextStyleName

public void setTextStyleName(java.lang.String textClassName)

setTextVisible

public void setTextVisible(boolean textVisible)

Sets whether the text is visible over the bar.

Parameters:

textVisible - True to show text, false to hide it

generateText

protected java.lang.String generateText(double curProgress)

Generate the text to display within the progress bar. Override this function to change the default progress percent to a more informative message, such as the number of kilobytes downloaded.

Parameters:

curProgress - the current progress

Returns:

the text to display in the progress bar

getBarElement

protected com.google.gwt.user.client.Element getBarElement()

Get the bar element.

Returns:

the bar element

getTextElement

protected com.google.gwt.user.client.Element getTextElement()

Get the text element.

Returns:

the text element

onLoad

protected void onLoad()

This method is called immediately after a widget becomes attached to the browser's document.

Overrides:

onLoad in class com.google.gwt.user.client.ui.Widget

onUnload

protected void onUnload()

Overrides:

onUnload in class com.google.gwt.user.client.ui.Widget

resetProgress

protected void resetProgress()

Reset the progress text based on the current min and max progress range.