echopoint.tucana
Class ProgressBar

java.lang.Object
  nextapp.echo.app.Component
      echopoint.internal.AbstractContainer
          echopoint.ProgressBar
              echopoint.tucana.ProgressBar

All Implemented Interfaces:

Serializable, RenderIdSupport

public class ProgressBar
extends ProgressBar

A custom progress bar component with default styles to use with the file upload component.

Note: Similar to the ProgressBar super-class, this component requires fixed size width and height. Percentage based values will lead to display issues with the progress bar.

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

Version:

$Id: ProgressBar.java 103 2009-01-29 12:10:22Z sptrakesh $

Author:

Rakesh 2008-11-6

See Also:

Serialized Form

Field Summary

static String

PROPERTY_PATTERN The pattern to use to display the text message in the bar.

Fields inherited from class echopoint.ProgressBar

PROPERTY_BAR_BACKGROUND, PROPERTY_PERCENTAGE, PROPERTY_TEXT

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()
Create a default styled progress bar.

Method Summary

String	getPattern() Return the value of the PROPERTY_PATTERN property.
void	setPattern(String pattern) Set the value of the PROPERTY_PATTERN property.

Methods inherited from class echopoint.ProgressBar

getBarBackground, getPercentage, getText, setBarBackground, setPercentage, setText

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_PATTERN

public static final String PROPERTY_PATTERN

The pattern to use to display the text message in the bar. The following encoded fields may be embedded within the specified text to be replaced by the corresponding values:

• #bytes# - This encoded value will be replaced by the actual kilo bytes that have been transferred so far.
• #length# - This encoded value will be replaced by actual size of the file being uploaded.
• #percent# - This encoded value will be replaced by the upload completion ratio.
• #rate# - This encoded value will be replaced by the rate at which kilo bytes are being uploaded per second.
• #time# - This encoded value will be replaced by the estimated time (in seconds) for completion of the upload.

The following is a sample pattern expressed using the encoded fields: Uploaded #bytes# of #length#Kb at #rate#... This property may be styled.

See Also:

Constant Field Values

Constructor Detail

ProgressBar

public ProgressBar()

Create a default styled progress bar.

Method Detail

getPattern

public String getPattern()

Return the value of the PROPERTY_PATTERN property.

Returns:

The pattern used to display the text.

setPattern

public void setPattern(String pattern)

Set the value of the PROPERTY_PATTERN property. See the property notes for list of encoded values that may be specified in the pattern.

Parameters:

pattern - The pattern to use to display the text.