com.sap.tc.webdynpro.clientserver.uielib.standard.api
Interface IWDProgressIndicator

All Superinterfaces:

IWDTableCellEditor, IWDUIElement, IWDViewElement

public interface IWDProgressIndicator

extends IWDUIElement, IWDTableCellEditor

Web Dynpro ProgressIndicator API. The ProgressIndicator UI element shows the progress of an activity in the form of a horizontal bar, along with the value of the percentValue property. You can also display a text in the progress bar using the displayValue property. This makes it possible to associate descriptions with specific percentage values. You can hide the display value using the showValue property. You can display the ProgessIndicator in different colors using the barColor property.

This type can be called by applications using Web Dynpro, but DO NOT EXTEND OR IMPLEMENT IT!

Field Summary

static WDProgressIndicatorBarColor	DEFAULT_BAR_COLOR Default value of property barColor.
static java.lang.String	DEFAULT_DISPLAY_VALUE Default value of property displayValue.
static int	DEFAULT_PERCENT_VALUE Default value of property percentValue.
static boolean	DEFAULT_SHOW_VALUE Default value of property showValue.
static java.lang.String	DEFAULT_WIDTH Default value of property width.

Fields inherited from interface com.sap.tc.webdynpro.progmodel.api.IWDUIElement

DEFAULT_ENABLED, DEFAULT_TOOLTIP, DEFAULT_VISIBLE

Method Summary

void	bindBarColor(IWDAttributeInfo attributeInfo) Binds property barColor to the context attribute specified by the given attribute info.
void	bindBarColor(java.lang.String path) Binds property barColor to the context attribute specified by path.
void	bindDisplayValue(IWDAttributeInfo attributeInfo) Binds property displayValue to the context attribute specified by the given attribute info.
void	bindDisplayValue(java.lang.String path) Binds property displayValue to the context attribute specified by path.
java.lang.String	bindingOfBarColor() Binding path of property barColor.
java.lang.String	bindingOfDisplayValue() Binding path of property displayValue.
java.lang.String	bindingOfPercentValue() Binding path of property percentValue.
java.lang.String	bindingOfShowValue() Binding path of property showValue.
java.lang.String	bindingOfWidth() Binding path of property width.
void	bindPercentValue(IWDAttributeInfo attributeInfo) Binds property percentValue to the context attribute specified by the given attribute info.
void	bindPercentValue(java.lang.String path) Binds property percentValue to the context attribute specified by path.
void	bindShowValue(IWDAttributeInfo attributeInfo) Binds property showValue to the context attribute specified by the given attribute info.
void	bindShowValue(java.lang.String path) Binds property showValue to the context attribute specified by path.
void	bindWidth(IWDAttributeInfo attributeInfo) Binds property width to the context attribute specified by the given attribute info.
void	bindWidth(java.lang.String path) Binds property width to the context attribute specified by path.
WDProgressIndicatorBarColor	getBarColor() Returns the value of the barColor property.
java.lang.String	getDisplayValue() Returns the value of the displayValue property.
int	getPercentValue() Returns the value of the percentValue property.
boolean	getShowValue() Returns the value of the showValue property.
java.lang.String	getWidth() Returns the value of the width property.
void	setBarColor(WDProgressIndicatorBarColor value) Sets property barColor to the new value.
void	setDisplayValue(java.lang.String value) Sets property displayValue to the new value.
void	setPercentValue(int value) Sets property percentValue to the new value.
void	setShowValue(boolean value) Sets property showValue to the new value.
void	setWidth(java.lang.String value) Sets property width to the new value.

Methods inherited from interface com.sap.tc.webdynpro.progmodel.api.IWDUIElement

bindEnabled, bindEnabled, bindingOfEnabled, bindingOfTooltip, bindingOfVisible, bindTooltip, bindTooltip, bindVisible, bindVisible, createLayoutData, getContainer, getEnabled, getLayoutData, getTooltip, getVisible, setEnabled, setTooltip, setVisible

Methods inherited from interface com.sap.tc.webdynpro.progmodel.api.IWDViewElement

getId, getView, requestFocus

Field Detail

DEFAULT_BAR_COLOR

public static final WDProgressIndicatorBarColor DEFAULT_BAR_COLOR

Default value of property barColor.

DEFAULT_DISPLAY_VALUE

public static final java.lang.String DEFAULT_DISPLAY_VALUE

Default value of property displayValue.

DEFAULT_PERCENT_VALUE

public static final int DEFAULT_PERCENT_VALUE

Default value of property percentValue.

DEFAULT_SHOW_VALUE

public static final boolean DEFAULT_SHOW_VALUE

Default value of property showValue.

DEFAULT_WIDTH

public static final java.lang.String DEFAULT_WIDTH

Default value of property width.

Method Detail

bindBarColor

public void bindBarColor(java.lang.String path)

Binds property barColor to the context attribute specified by path.

Parameters:

path - the path of the context attribute to which the barColor property is bound

bindBarColor

public void bindBarColor(IWDAttributeInfo attributeInfo)

Binds property barColor to the context attribute specified by the given attribute info.

Parameters:

attributeInfo - the info of the context attribute to which the barColor property is bound

bindingOfBarColor

public java.lang.String bindingOfBarColor()

Binding path of property barColor.

Returns:

the path of the context attribute to which the barColor is currently bound

getBarColor

public WDProgressIndicatorBarColor getBarColor()

Returns the value of the barColor property. The initial value is WDProgressIndicatorBarColor.NEUTRAL. The logical color of the progress indicator.

Returns:

the current value of the barColor property

See Also:

setBarColor(WDProgressIndicatorBarColor)

setBarColor

public void setBarColor(WDProgressIndicatorBarColor value)

Sets property barColor to the new value.

Parameters:

value - the new value of the barColor property

See Also:

getBarColor()

bindDisplayValue

public void bindDisplayValue(java.lang.String path)

Binds property displayValue to the context attribute specified by path.

Parameters:

path - the path of the context attribute to which the displayValue property is bound

bindDisplayValue

public void bindDisplayValue(IWDAttributeInfo attributeInfo)

Binds property displayValue to the context attribute specified by the given attribute info.

Parameters:

attributeInfo - the info of the context attribute to which the displayValue property is bound

bindingOfDisplayValue

public java.lang.String bindingOfDisplayValue()

Binding path of property displayValue.

Returns:

the path of the context attribute to which the displayValue is currently bound

getDisplayValue

public java.lang.String getDisplayValue()

Returns the value of the displayValue property. The initial value is "". Used to display a textual value on the left side of the progress bar. An application may set this value to display texts like "done" or "critical" for corresponding percentage values. If this value is not explicitely specified, a text like "42%" is shown.

Returns:

the current value of the displayValue property

See Also:

setDisplayValue(String)

setDisplayValue

public void setDisplayValue(java.lang.String value)

Sets property displayValue to the new value.

Parameters:

value - the new value of the displayValue property

See Also:

getDisplayValue()

bindPercentValue

public void bindPercentValue(java.lang.String path)

Binds property percentValue to the context attribute specified by path.

Parameters:

path - the path of the context attribute to which the percentValue property is bound

bindPercentValue

public void bindPercentValue(IWDAttributeInfo attributeInfo)

Binds property percentValue to the context attribute specified by the given attribute info.

Parameters:

attributeInfo - the info of the context attribute to which the percentValue property is bound

bindingOfPercentValue

public java.lang.String bindingOfPercentValue()

Binding path of property percentValue.

Returns:

the path of the context attribute to which the percentValue is currently bound

getPercentValue

public int getPercentValue()

Returns the value of the percentValue property. The initial value is 0. The percentual value of the progress.

Returns:

the current value of the percentValue property

See Also:

setPercentValue(int)

setPercentValue

public void setPercentValue(int value)

Sets property percentValue to the new value.

Parameters:

value - the new value of the percentValue property

See Also:

getPercentValue()

bindShowValue

public void bindShowValue(java.lang.String path)

Binds property showValue to the context attribute specified by path.

Parameters:

path - the path of the context attribute to which the showValue property is bound

bindShowValue

public void bindShowValue(IWDAttributeInfo attributeInfo)

Binds property showValue to the context attribute specified by the given attribute info.

Parameters:

attributeInfo - the info of the context attribute to which the showValue property is bound

bindingOfShowValue

public java.lang.String bindingOfShowValue()

Binding path of property showValue.

Returns:

the path of the context attribute to which the showValue is currently bound

getShowValue

public boolean getShowValue()

Returns the value of the showValue property. The initial value is true. Controls whether the display value is shown.

Returns:

the current value of the showValue property

See Also:

setShowValue(boolean)

setShowValue

public void setShowValue(boolean value)

Sets property showValue to the new value.

Parameters:

value - the new value of the showValue property

See Also:

getShowValue()

bindWidth

public void bindWidth(java.lang.String path)

Binds property width to the context attribute specified by path.

Parameters:

path - the path of the context attribute to which the width property is bound

bindWidth

public void bindWidth(IWDAttributeInfo attributeInfo)

Binds property width to the context attribute specified by the given attribute info.

Parameters:

attributeInfo - the info of the context attribute to which the width property is bound

bindingOfWidth

public java.lang.String bindingOfWidth()

Binding path of property width.

Returns:

the path of the context attribute to which the width is currently bound

getWidth

public java.lang.String getWidth()

Returns the value of the width property. The initial value is "". A CSS size value specifying the width of the progress indicator.

Returns:

the current value of the width property

See Also:

setWidth(String)

setWidth

public void setWidth(java.lang.String value)

Sets property width to the new value.

Parameters:

value - the new value of the width property

See Also:

getWidth()