Spiffy UI Framework

org.spiffyui.client.widgets
Class ProgressBar

java.lang.Object
  extended by SimplePanel
      extended by org.spiffyui.client.widgets.ProgressBar

public class ProgressBar
extends SimplePanel

This widget wraps the JQuery UI progress bar


Constructor Summary
ProgressBar()
          Create a progress bar with the specified ID.
ProgressBar(java.lang.String id)
          Create a progress bar with the specified ID.
 
Method Summary
 java.lang.String getTitleString(int percentCompleted)
          Get the title (or tooltip) string for the progress bar.
 int getValue()
          Set the value for this progress bar
 void onAttach()
           
 void setValue(int value)
          Get the value of this progress bar
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ProgressBar

public ProgressBar()
Create a progress bar with the specified ID. The ID is required because the progress bar needs a specific ID to connect to.


ProgressBar

public ProgressBar(java.lang.String id)
Create a progress bar with the specified ID. The ID is required because the progress bar needs a specific ID to connect to.

Parameters:
id - the id for the progress bar
Method Detail

onAttach

public void onAttach()

getValue

public int getValue()
Set the value for this progress bar

Returns:
the value of the bar

getTitleString

public java.lang.String getTitleString(int percentCompleted)
Get the title (or tooltip) string for the progress bar. This method may be overridden to specify the value using alternative localization mechanisms.

Parameters:
percentCompleted - the percent completed
Returns:
the title string with the percent completed

setValue

public void setValue(int value)
Get the value of this progress bar

Parameters:
value - the bar value

Spiffy UI Framework