EchoPoint API - 3.0.0b5
App Webcontainer

echopoint
Class ProgressBar

java.lang.Object
  extended by nextapp.echo.app.Component
      extended by echopoint.internal.AbstractContainer
          extended by echopoint.ProgressBar
All Implemented Interfaces:
Serializable, RenderIdSupport
Direct Known Subclasses:
ProgressBar

public class ProgressBar
extends AbstractContainer

A simple colour based progress bar component. Unlike the original EPNG progress bar component, this is very light-weight and does not require compositing images on the server.

Note: Development of this component was sponsored by TCN Broadcasting. We are grateful for their support and sponsorship.

Version:
$Id: ProgressBar.java 80 2008-11-07 03:35:20Z sptrakesh $
Author:
Rakesh Vidyadharan 2008-11-6
See Also:
Serialized Form

Field Summary
static String PROPERTY_BAR_BACKGROUND
          The property used to set the background colour of the variable width progress bar element.
static String PROPERTY_PERCENTAGE
          The property used to indicate the progress percentage value.
static String PROPERTY_TEXT
          The property used to display an optional text value in the bar.
 
Fields inherited from class echopoint.internal.AbstractContainer
ACTION_COMMAND_PROPERTY, ACTION_LISTENERS_CHANGED_PROPERTY, INPUT_ACTION, PROPERTY_ALIGNMENT, PROPERTY_BACKGROUND_IMAGE, PROPERTY_BORDER, PROPERTY_HEIGHT, PROPERTY_INSETS, PROPERTY_WIDTH
 
Fields inherited from class nextapp.echo.app.Component
CHILD_VISIBLE_CHANGED_PROPERTY, CHILDREN_CHANGED_PROPERTY, ENABLED_CHANGED_PROPERTY, FOCUS_NEXT_ID_CHANGED_PROPERTY, FOCUS_PREVIOUS_ID_CHANGED_PROPERTY, LAYOUT_DIRECTION_CHANGED_PROPERTY, LOCALE_CHANGED_PROPERTY, PROPERTY_BACKGROUND, PROPERTY_FONT, PROPERTY_FOREGROUND, PROPERTY_LAYOUT_DATA, STYLE_CHANGED_PROPERTY, STYLE_NAME_CHANGED_PROPERTY, VISIBLE_CHANGED_PROPERTY
 
Constructor Summary
ProgressBar()
           
 
Method Summary
 Color getBarBackground()
          Return the value of PROPERTY_BAR_BACKGROUND property.
 int getPercentage()
          Return the value of PROPERTY_PERCENTAGE property.
 String getText()
          Return the value of PROPERTY_TEXT property.
 void setBarBackground(Color background)
          Set the value of the PROPERTY_BAR_BACKGROUND property.
 void setPercentage(int percentage)
          Set the value of the PROPERTY_PERCENTAGE property.
 void setText(String text)
          Set the value of the PROPERTY_TEXT property.
 
Methods inherited from class echopoint.internal.AbstractContainer
addActionListener, fireActionPerformed, getAlignment, getBackgroundImage, getBorder, getHeight, getInsets, getWidth, hasActionListeners, removeActionListener, setAlignment, setBackgroundImage, setBorder, setHeight, setInsets, setWidth
 
Methods inherited from class nextapp.echo.app.Component
add, add, addPropertyChangeListener, addPropertyChangeListener, dispose, firePropertyChange, get, getApplicationInstance, getBackground, getComponent, getComponent, getComponentCount, getComponents, getEventListenerList, getFocusNextId, getFocusPreviousId, getFont, getForeground, getId, getIndex, getLayoutData, getLayoutDirection, getLocale, getLocalStyle, getParent, getRenderId, getRenderIndexedProperty, getRenderIndexedProperty, getRenderLocale, getRenderProperty, getRenderProperty, getStyle, getStyleName, getVisibleComponent, getVisibleComponentCount, getVisibleComponents, hasEventListenerList, indexOf, init, isAncestorOf, isEnabled, isFocusTraversalParticipant, isRegistered, isRenderEnabled, isRenderVisible, isValidChild, isValidParent, isVisible, processInput, remove, remove, removeAll, removePropertyChangeListener, removePropertyChangeListener, set, setBackground, setComponents, setEnabled, setFocusNextId, setFocusPreviousId, setFocusTraversalParticipant, setFont, setForeground, setId, setIndex, setLayoutData, setLayoutDirection, setLocale, setRenderId, setStyle, setStyleName, setVisible, validate, verifyInput, visibleIndexOf
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PROPERTY_BAR_BACKGROUND

public static final String PROPERTY_BAR_BACKGROUND
The property used to set the background colour of the variable width progress bar element.

See Also:
Constant Field Values

PROPERTY_PERCENTAGE

public static final String PROPERTY_PERCENTAGE
The property used to indicate the progress percentage value.

See Also:
Constant Field Values

PROPERTY_TEXT

public static final String PROPERTY_TEXT
The property used to display an optional text value in the bar.

See Also:
Constant Field Values
Constructor Detail

ProgressBar

public ProgressBar()
Method Detail

getBarBackground

public Color getBarBackground()
Return the value of PROPERTY_BAR_BACKGROUND property.

Returns:
The background colour for the variable width bar.

setBarBackground

public void setBarBackground(Color background)
Set the value of the PROPERTY_BAR_BACKGROUND property.

Parameters:
background - The background colour for the variable width bar.

getPercentage

public int getPercentage()
Return the value of PROPERTY_PERCENTAGE property.

Returns:
The percentage complete to be represented.

setPercentage

public void setPercentage(int percentage)
Set the value of the PROPERTY_PERCENTAGE property.

Parameters:
percentage - The percentage complete that is to be depicted.

getText

public String getText()
Return the value of PROPERTY_TEXT property.

Returns:
The optional text to be displayed in the progress bar.

setText

public void setText(String text)
Set the value of the PROPERTY_TEXT property.

Parameters:
text - The optional text to be displayed in the progress bar.

EchoPoint API - 3.0.0b5
App Webcontainer