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!

Type Classification:

This interface is part of the Web Dynpro API, so applications may reference it or call any method of it, but they must not implement or extend it.

For a detailed explanation of API classification see the Web Dynpro Compatibility Guide

Field Summary

static WDProgressIndicatorBarColor	DEFAULT_BAR_COLOR Default value of the barColor property is WDProgressIndicatorBarColor.NEUTRAL.
static String	DEFAULT_DISPLAY_VALUE Default value of the displayValue property is "".
static int	DEFAULT_PERCENT_VALUE Default value of the percentValue property is 0.
static boolean	DEFAULT_SHOW_VALUE Default value of the showValue property is true.
static String	DEFAULT_WIDTH Default value of the width property is "".

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

DEFAULT_ENABLED, DEFAULT_TOOLTIP, DEFAULT_VISIBLE

Method Summary

void	bindBarColor(IWDAttributeInfo attributeInfo) Binds the barColor property to the context attribute specified by the given attribute info.
void	bindBarColor(String path) Binds the barColor property to the context attribute specified by the given path.
void	bindDisplayValue(IWDAttributeInfo attributeInfo) Binds the displayValue property to the context attribute specified by the given attribute info.
void	bindDisplayValue(String path) Binds the displayValue property to the context attribute specified by the given path.
String	bindingOfBarColor() Returns the binding path of the barColor property.
String	bindingOfDisplayValue() Returns the binding path of the displayValue property.
String	bindingOfPercentValue() Returns the binding path of the percentValue property.
String	bindingOfShowValue() Returns the binding path of the showValue property.
String	bindingOfWidth() Returns the binding path of the width property.
void	bindPercentValue(IWDAttributeInfo attributeInfo) Binds the percentValue property to the context attribute specified by the given attribute info.
void	bindPercentValue(String path) Binds the percentValue property to the context attribute specified by the given path.
void	bindShowValue(IWDAttributeInfo attributeInfo) Binds the showValue property to the context attribute specified by the given attribute info.
void	bindShowValue(String path) Binds the showValue property to the context attribute specified by the given path.
void	bindWidth(IWDAttributeInfo attributeInfo) Binds the width property to the context attribute specified by the given attribute info.
void	bindWidth(String path) Binds the width property to the context attribute specified by the given path.
void	destroyMenu() Destroys the aggregated Menu element.
WDProgressIndicatorBarColor	getBarColor() Returns the value of the barColor property.
String	getDisplayValue() Returns the value of the displayValue property.
IWDMenu	getMenu() Returns the aggregated Menu element.
int	getPercentValue() Returns the value of the percentValue property.
boolean	getShowValue() Returns the value of the showValue property.
String	getWidth() Returns the value of the width property.
void	setBarColor(WDProgressIndicatorBarColor value) Sets the barColor property to the given value.
void	setDisplayValue(String value) Sets the displayValue property to the given value.
void	setMenu(IWDMenu menu) Sets the aggregated Menu element.
void	setPercentValue(int value) Sets the percentValue property to the given value.
void	setShowValue(boolean value) Sets the showValue property to the given value.
void	setWidth(String value) Sets the width property to the given 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

destroy, getId, getView, requestFocus

Field Detail

DEFAULT_BAR_COLOR

public static final WDProgressIndicatorBarColor DEFAULT_BAR_COLOR

Default value of the barColor property is WDProgressIndicatorBarColor.NEUTRAL.

DEFAULT_DISPLAY_VALUE

public static final String DEFAULT_DISPLAY_VALUE

Default value of the displayValue property is "".

See Also:

Constant Field Values

DEFAULT_PERCENT_VALUE

public static final int DEFAULT_PERCENT_VALUE

Default value of the percentValue property is 0.

See Also:

Constant Field Values

DEFAULT_SHOW_VALUE

public static final boolean DEFAULT_SHOW_VALUE

Default value of the showValue property is true.

See Also:

Constant Field Values

DEFAULT_WIDTH

public static final String DEFAULT_WIDTH

Default value of the width property is "".

See Also:

Constant Field Values

Method Detail

bindBarColor

public void bindBarColor(String path)

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

Parameters:

path - the context path of the attribute to which the barColor property will be bound

bindBarColor

public void bindBarColor(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfBarColor

public String bindingOfBarColor()

Returns the binding path of the barColor property.

Returns:

the path of the context attribute to which the barColor property 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 the barColor property to the given value.

Parameters:

value - the new value of the barColor property

See Also:

getBarColor()

bindDisplayValue

public void bindDisplayValue(String path)

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

Parameters:

path - the context path of the attribute to which the displayValue property will be bound

bindDisplayValue

public void bindDisplayValue(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfDisplayValue

public String bindingOfDisplayValue()

Returns the binding path of the displayValue property.

Returns:

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

getDisplayValue

public 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(String value)

Sets the displayValue property to the given value.

Parameters:

value - the new value of the displayValue property

See Also:

getDisplayValue()

bindPercentValue

public void bindPercentValue(String path)

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

Parameters:

path - the context path of the attribute to which the percentValue property will be bound

bindPercentValue

public void bindPercentValue(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfPercentValue

public String bindingOfPercentValue()

Returns the binding path of the percentValue property.

Returns:

the path of the context attribute to which the percentValue property 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 the percentValue property to the given value.

Parameters:

value - the new value of the percentValue property

See Also:

getPercentValue()

bindShowValue

public void bindShowValue(String path)

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

Parameters:

path - the context path of the attribute to which the showValue property will be bound

bindShowValue

public void bindShowValue(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfShowValue

public String bindingOfShowValue()

Returns the binding path of the showValue property.

Returns:

the path of the context attribute to which the showValue property 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 the showValue property to the given value.

Parameters:

value - the new value of the showValue property

See Also:

getShowValue()

bindWidth

public void bindWidth(String path)

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

Parameters:

path - the context path of the attribute to which the width property will be bound

bindWidth

public void bindWidth(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfWidth

public String bindingOfWidth()

Returns the binding path of the width property.

Returns:

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

getWidth

public 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(String value)

Sets the width property to the given value.

Parameters:

value - the new value of the width property

See Also:

getWidth()

getMenu

public IWDMenu getMenu()

Returns the aggregated Menu element. The attached menu.

Returns:

the aggregated Menu element

See Also:

setMenu(IWDMenu)

setMenu

public void setMenu(IWDMenu menu)

Sets the aggregated Menu element.

Parameters:

menu - the new menu

See Also:

getMenu()

destroyMenu

public void destroyMenu()

Destroys the aggregated Menu element. Destroyed view elements do not exist any longer in their view, i.e. a new element may be created with the same ID.