com.sapportals.htmlb

Class ProgressIndicator

java.lang.Object
  com.sapportals.htmlb.Component
      com.sapportals.htmlb.ProgressIndicator

public class ProgressIndicator

extends Component

Field Summary

static String

UI_ID

Constructor Summary

ProgressIndicator()
creates a ProgressIndicator

ProgressIndicator(int percentValue)
creates a ProgressIndicator using the percentage value of the indicator to be displayed

Method Summary

ProgressIndicatorBarColor	getBarColor() returns the barColor of the ProgressIndicator
String	getDisplayValue() get the value to be displayed in the progressIndicator.
int	getPercentValue() get the value of the progressIndicator in percent
String	getTooltip() returns the tooltip of the progressIndicator
String	getUI() get a identification String for the renderer that is unique across all supported components.
String	getWidth() get the width of this progressIndicator
void	setBarColor(ProgressIndicatorBarColor barColor) sets the barColor of the ProgressIndicator
void	setDisplayValue(String displayValue) sets the value to be displayed in the progressIndicator.
void	setPercentValue(int percentValue) sets the value of the progressIndicator in percent
void	setShowValue(boolean showValue) sets if the value or (if specified) the displayValue of the ProgressIndicator is displayed inside the progressIndicator.
void	setTooltip(String tooltip) sets the tooltip of the progressIndicator
void	setWidth(String width) set the width of this progressIndicator.
boolean	showValue() determines if the value or (if specified) the displayValue of the ProgressIndicator is displayed inside the progressIndicator.

Methods inherited from class com.sapportals.htmlb.Component

getEncodedIdForForm, getId, getParent, initFromPageContext, initFromShortId, initializeFromId, isJsObjectNeeded, preRender, render, renderAsString, requiresForm, setId, setJsObjectNeeded, setParent

Methods inherited from class java.lang.Object

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

Field Detail

UI_ID

public static final String UI_ID

See Also:

Constant Field Values

Constructor Detail

ProgressIndicator

public ProgressIndicator()

creates a ProgressIndicator

ProgressIndicator

public ProgressIndicator(int percentValue)

creates a ProgressIndicator using the percentage value of the indicator to be displayed

Method Detail

getUI

public String getUI()

get a identification String for the renderer that is unique across all supported components. E.g. you could simply return the class name of the component class. The reason for using a separate method and not some internal reflection method is that you can more easily extend the functionality or your Component class without having to rewrite the view class.

Specified by:

getUI in class Component

Returns:

a unique identification string for this Component

getWidth

public String getWidth()

get the width of this progressIndicator

Returns:

the width

setWidth

public void setWidth(String width)

set the width of this progressIndicator. This is an HTML width, i.e. you can use percentages or fixed values. E.g. '100%', '95px', '95'

getPercentValue

public int getPercentValue()

get the value of the progressIndicator in percent

Returns:

the value in percent

setPercentValue

public void setPercentValue(int percentValue)

sets the value of the progressIndicator in percent

Parameters:

percentValue - the value in percent

getDisplayValue

public String getDisplayValue()

get the value to be displayed in the progressIndicator. If no value is specified and showValue is true (default), the progressIndicator shows the percent value

Returns:

the display value

setDisplayValue

public void setDisplayValue(String displayValue)

sets the value to be displayed in the progressIndicator. If no value is specified and showValue is true (default), the progressIndicator shows the percent value

Parameters:

displayValue - the display value

getBarColor

public ProgressIndicatorBarColor getBarColor()

returns the barColor of the ProgressIndicator

Returns:

the ProgressIndicatorBarColor

setBarColor

public void setBarColor(ProgressIndicatorBarColor barColor)

sets the barColor of the ProgressIndicator

Parameters:

barColor - the ProgressIndicatorBarColor

showValue

public boolean showValue()

determines if the value or (if specified) the displayValue of the ProgressIndicator is displayed inside the progressIndicator.

Returns:

true, if the value is displayed

setShowValue

public void setShowValue(boolean showValue)

sets if the value or (if specified) the displayValue of the ProgressIndicator is displayed inside the progressIndicator.

Returns:

true, if the value is displayed

getTooltip

public String getTooltip()

returns the tooltip of the progressIndicator

Returns:

the tooltip

setTooltip

public void setTooltip(String tooltip)

sets the tooltip of the progressIndicator

Parameters:

tooltip - the tooltip