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

Interface IWDValueComparison

All Superinterfaces:

IWDTableCellEditor, IWDUIElement, IWDViewElement

public interface IWDValueComparison

extends IWDUIElement, IWDTableCellEditor

Web Dynpro ValueComparison API. Graphical comparison of values

Compares upto 3 values graphically, represented by the properties barValue, boxValue and markerValue.
The maximum width, in pixels, of the GraphicalValueComparator is required and must be specified as width.
The color of the bar can be changed based on some rule, and the threshold values for changing the bar color can be specified by lowerThresholdValue and upperThresholdValue.

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 double	DEFAULT_BAR_VALUE Default value of the barValue property is -1.
static double	DEFAULT_BOX_VALUE Default value of the boxValue property is -1.
static WDBarColor	DEFAULT_COLOR_ABOVE_THRESHOLD Default value of the colorAboveThreshold property is WDBarColor.NEGATIVE.
static WDBarColor	DEFAULT_COLOR_BELOW_THRESHOLD Default value of the colorBelowThreshold property is WDBarColor.NEUTRAL1.
static WDBarColor	DEFAULT_COLOR_BETWEEN_THRESHOLDS Default value of the colorBetweenThresholds property is WDBarColor.CRITICAL.
static double	DEFAULT_LOWER_THRESHOLD_VALUE Default value of the lowerThresholdValue property is -1.
static WDMarkerType	DEFAULT_MARKER_TYPE Default value of the markerType property is WDMarkerType.NEUTRAL.
static double	DEFAULT_MARKER_VALUE Default value of the markerValue property is -1.
static double	DEFAULT_MAX_VALUE Default value of the maxValue property is -1.
static String	DEFAULT_TEXT Default value of the text property is "".
static double	DEFAULT_UPPER_THRESHOLD_VALUE Default value of the upperThresholdValue property is -1.
static int	DEFAULT_WIDTH Default value of the width property is 0.

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

DEFAULT_ENABLED, DEFAULT_TOOLTIP, DEFAULT_VISIBLE

Method Summary

void	bindBarValue(IWDAttributeInfo attributeInfo) Binds the barValue property to the context attribute specified by the given attribute info.
void	bindBarValue(String path) Binds the barValue property to the context attribute specified by the given path.
void	bindBoxValue(IWDAttributeInfo attributeInfo) Binds the boxValue property to the context attribute specified by the given attribute info.
void	bindBoxValue(String path) Binds the boxValue property to the context attribute specified by the given path.
void	bindColorAboveThreshold(IWDAttributeInfo attributeInfo) Binds the colorAboveThreshold property to the context attribute specified by the given attribute info.
void	bindColorAboveThreshold(String path) Binds the colorAboveThreshold property to the context attribute specified by the given path.
void	bindColorBelowThreshold(IWDAttributeInfo attributeInfo) Binds the colorBelowThreshold property to the context attribute specified by the given attribute info.
void	bindColorBelowThreshold(String path) Binds the colorBelowThreshold property to the context attribute specified by the given path.
void	bindColorBetweenThresholds(IWDAttributeInfo attributeInfo) Binds the colorBetweenThresholds property to the context attribute specified by the given attribute info.
void	bindColorBetweenThresholds(String path) Binds the colorBetweenThresholds property to the context attribute specified by the given path.
String	bindingOfBarValue() Returns the binding path of the barValue property.
String	bindingOfBoxValue() Returns the binding path of the boxValue property.
String	bindingOfColorAboveThreshold() Returns the binding path of the colorAboveThreshold property.
String	bindingOfColorBelowThreshold() Returns the binding path of the colorBelowThreshold property.
String	bindingOfColorBetweenThresholds() Returns the binding path of the colorBetweenThresholds property.
String	bindingOfLowerThresholdValue() Returns the binding path of the lowerThresholdValue property.
String	bindingOfMarkerType() Returns the binding path of the markerType property.
String	bindingOfMarkerValue() Returns the binding path of the markerValue property.
String	bindingOfMaxValue() Returns the binding path of the maxValue property.
String	bindingOfText() Returns the binding path of the text property.
String	bindingOfUpperThresholdValue() Returns the binding path of the upperThresholdValue property.
String	bindingOfWidth() Returns the binding path of the width property.
void	bindLowerThresholdValue(IWDAttributeInfo attributeInfo) Binds the lowerThresholdValue property to the context attribute specified by the given attribute info.
void	bindLowerThresholdValue(String path) Binds the lowerThresholdValue property to the context attribute specified by the given path.
void	bindMarkerType(IWDAttributeInfo attributeInfo) Binds the markerType property to the context attribute specified by the given attribute info.
void	bindMarkerType(String path) Binds the markerType property to the context attribute specified by the given path.
void	bindMarkerValue(IWDAttributeInfo attributeInfo) Binds the markerValue property to the context attribute specified by the given attribute info.
void	bindMarkerValue(String path) Binds the markerValue property to the context attribute specified by the given path.
void	bindMaxValue(IWDAttributeInfo attributeInfo) Binds the maxValue property to the context attribute specified by the given attribute info.
void	bindMaxValue(String path) Binds the maxValue property to the context attribute specified by the given path.
void	bindText(IWDAttributeInfo attributeInfo) Binds the text property to the context attribute specified by the given attribute info.
void	bindText(String path) Binds the text property to the context attribute specified by the given path.
void	bindUpperThresholdValue(IWDAttributeInfo attributeInfo) Binds the upperThresholdValue property to the context attribute specified by the given attribute info.
void	bindUpperThresholdValue(String path) Binds the upperThresholdValue 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.
double	getBarValue() Returns the value of the barValue property.
double	getBoxValue() Returns the value of the boxValue property.
WDBarColor	getColorAboveThreshold() Returns the value of the colorAboveThreshold property.
WDBarColor	getColorBelowThreshold() Returns the value of the colorBelowThreshold property.
WDBarColor	getColorBetweenThresholds() Returns the value of the colorBetweenThresholds property.
double	getLowerThresholdValue() Returns the value of the lowerThresholdValue property.
WDMarkerType	getMarkerType() Returns the value of the markerType property.
double	getMarkerValue() Returns the value of the markerValue property.
double	getMaxValue() Returns the value of the maxValue property.
String	getText() Returns the value of the text property.
double	getUpperThresholdValue() Returns the value of the upperThresholdValue property.
int	getWidth() Returns the value of the width property.
void	setBarValue(double value) Sets the barValue property to the given value.
void	setBoxValue(double value) Sets the boxValue property to the given value.
void	setColorAboveThreshold(WDBarColor value) Sets the colorAboveThreshold property to the given value.
void	setColorBelowThreshold(WDBarColor value) Sets the colorBelowThreshold property to the given value.
void	setColorBetweenThresholds(WDBarColor value) Sets the colorBetweenThresholds property to the given value.
void	setLowerThresholdValue(double value) Sets the lowerThresholdValue property to the given value.
void	setMarkerType(WDMarkerType value) Sets the markerType property to the given value.
void	setMarkerValue(double value) Sets the markerValue property to the given value.
void	setMaxValue(double value) Sets the maxValue property to the given value.
void	setText(String value) Sets the text property to the given value.
void	setUpperThresholdValue(double value) Sets the upperThresholdValue property to the given value.
void	setWidth(int 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_VALUE

public static final double DEFAULT_BAR_VALUE

Default value of the barValue property is -1.

See Also:

Constant Field Values

DEFAULT_BOX_VALUE

public static final double DEFAULT_BOX_VALUE

Default value of the boxValue property is -1.

See Also:

Constant Field Values

DEFAULT_COLOR_ABOVE_THRESHOLD

public static final WDBarColor DEFAULT_COLOR_ABOVE_THRESHOLD

Default value of the colorAboveThreshold property is WDBarColor.NEGATIVE.

DEFAULT_COLOR_BELOW_THRESHOLD

public static final WDBarColor DEFAULT_COLOR_BELOW_THRESHOLD

Default value of the colorBelowThreshold property is WDBarColor.NEUTRAL1.

DEFAULT_COLOR_BETWEEN_THRESHOLDS

public static final WDBarColor DEFAULT_COLOR_BETWEEN_THRESHOLDS

Default value of the colorBetweenThresholds property is WDBarColor.CRITICAL.

DEFAULT_LOWER_THRESHOLD_VALUE

public static final double DEFAULT_LOWER_THRESHOLD_VALUE

Default value of the lowerThresholdValue property is -1.

See Also:

Constant Field Values

DEFAULT_MARKER_TYPE

public static final WDMarkerType DEFAULT_MARKER_TYPE

Default value of the markerType property is WDMarkerType.NEUTRAL.

DEFAULT_MARKER_VALUE

public static final double DEFAULT_MARKER_VALUE

Default value of the markerValue property is -1.

See Also:

Constant Field Values

DEFAULT_MAX_VALUE

public static final double DEFAULT_MAX_VALUE

Default value of the maxValue property is -1.

See Also:

Constant Field Values

DEFAULT_TEXT

public static final String DEFAULT_TEXT

Default value of the text property is "".

See Also:

Constant Field Values

DEFAULT_UPPER_THRESHOLD_VALUE

public static final double DEFAULT_UPPER_THRESHOLD_VALUE

Default value of the upperThresholdValue property is -1.

See Also:

Constant Field Values

DEFAULT_WIDTH

public static final int DEFAULT_WIDTH

Default value of the width property is 0.

See Also:

Constant Field Values

Method Detail

bindBarValue

public void bindBarValue(String path)

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

Parameters:

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

bindBarValue

public void bindBarValue(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfBarValue

public String bindingOfBarValue()

Returns the binding path of the barValue property.

Returns:

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

getBarValue

public double getBarValue()

Returns the value of the barValue property.

The initial value is -1.

Determines the value to be represented by the bar

Returns:

the current value of the barValue property

See Also:

setBarValue(double)

setBarValue

public void setBarValue(double value)

Sets the barValue property to the given value.

Parameters:

value - the new value of the barValue property

See Also:

getBarValue()

bindBoxValue

public void bindBoxValue(String path)

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

Parameters:

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

bindBoxValue

public void bindBoxValue(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfBoxValue

public String bindingOfBoxValue()

Returns the binding path of the boxValue property.

Returns:

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

getBoxValue

public double getBoxValue()

Returns the value of the boxValue property.

The initial value is -1.

Determines the value to be represented by the box

Returns:

the current value of the boxValue property

See Also:

setBoxValue(double)

setBoxValue

public void setBoxValue(double value)

Sets the boxValue property to the given value.

Parameters:

value - the new value of the boxValue property

See Also:

getBoxValue()

bindColorAboveThreshold

public void bindColorAboveThreshold(String path)

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

Parameters:

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

bindColorAboveThreshold

public void bindColorAboveThreshold(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfColorAboveThreshold

public String bindingOfColorAboveThreshold()

Returns the binding path of the colorAboveThreshold property.

Returns:

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

getColorAboveThreshold

public WDBarColor getColorAboveThreshold()

Returns the value of the colorAboveThreshold property.

The initial value is WDBarColor.NEGATIVE.

Determines the color of the bar above the upperThresholdValue

Returns:

the current value of the colorAboveThreshold property

See Also:

setColorAboveThreshold(WDBarColor)

setColorAboveThreshold

public void setColorAboveThreshold(WDBarColor value)

Sets the colorAboveThreshold property to the given value.

Parameters:

value - the new value of the colorAboveThreshold property

See Also:

getColorAboveThreshold()

bindColorBelowThreshold

public void bindColorBelowThreshold(String path)

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

Parameters:

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

bindColorBelowThreshold

public void bindColorBelowThreshold(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfColorBelowThreshold

public String bindingOfColorBelowThreshold()

Returns the binding path of the colorBelowThreshold property.

Returns:

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

getColorBelowThreshold

public WDBarColor getColorBelowThreshold()

Returns the value of the colorBelowThreshold property.

The initial value is WDBarColor.NEUTRAL1.

Determines the color of the bar below the lowerThresholdValue.

Returns:

the current value of the colorBelowThreshold property

See Also:

setColorBelowThreshold(WDBarColor)

setColorBelowThreshold

public void setColorBelowThreshold(WDBarColor value)

Sets the colorBelowThreshold property to the given value.

Parameters:

value - the new value of the colorBelowThreshold property

See Also:

getColorBelowThreshold()

bindColorBetweenThresholds

public void bindColorBetweenThresholds(String path)

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

Parameters:

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

bindColorBetweenThresholds

public void bindColorBetweenThresholds(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfColorBetweenThresholds

public String bindingOfColorBetweenThresholds()

Returns the binding path of the colorBetweenThresholds property.

Returns:

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

getColorBetweenThresholds

public WDBarColor getColorBetweenThresholds()

Returns the value of the colorBetweenThresholds property.

The initial value is WDBarColor.CRITICAL.

Determines the color of the bar between the threshold values

Returns:

the current value of the colorBetweenThresholds property

See Also:

setColorBetweenThresholds(WDBarColor)

setColorBetweenThresholds

public void setColorBetweenThresholds(WDBarColor value)

Sets the colorBetweenThresholds property to the given value.

Parameters:

value - the new value of the colorBetweenThresholds property

See Also:

getColorBetweenThresholds()

bindLowerThresholdValue

public void bindLowerThresholdValue(String path)

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

Parameters:

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

bindLowerThresholdValue

public void bindLowerThresholdValue(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfLowerThresholdValue

public String bindingOfLowerThresholdValue()

Returns the binding path of the lowerThresholdValue property.

Returns:

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

getLowerThresholdValue

public double getLowerThresholdValue()

Returns the value of the lowerThresholdValue property.

The initial value is -1.

Determines the lower threshold value for changing the bar's color

Returns:

the current value of the lowerThresholdValue property

See Also:

setLowerThresholdValue(double)

setLowerThresholdValue

public void setLowerThresholdValue(double value)

Sets the lowerThresholdValue property to the given value.

Parameters:

value - the new value of the lowerThresholdValue property

See Also:

getLowerThresholdValue()

bindMarkerType

public void bindMarkerType(String path)

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

Parameters:

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

bindMarkerType

public void bindMarkerType(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfMarkerType

public String bindingOfMarkerType()

Returns the binding path of the markerType property.

Returns:

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

getMarkerType

public WDMarkerType getMarkerType()

Returns the value of the markerType property.

The initial value is WDMarkerType.NEUTRAL.

Determines the type of the marker that is displayed

Returns:

the current value of the markerType property

See Also:

setMarkerType(WDMarkerType)

setMarkerType

public void setMarkerType(WDMarkerType value)

Sets the markerType property to the given value.

Parameters:

value - the new value of the markerType property

See Also:

getMarkerType()

bindMarkerValue

public void bindMarkerValue(String path)

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

Parameters:

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

bindMarkerValue

public void bindMarkerValue(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfMarkerValue

public String bindingOfMarkerValue()

Returns the binding path of the markerValue property.

Returns:

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

getMarkerValue

public double getMarkerValue()

Returns the value of the markerValue property.

The initial value is -1.

Determines the value to be represented by the marker

Returns:

the current value of the markerValue property

See Also:

setMarkerValue(double)

setMarkerValue

public void setMarkerValue(double value)

Sets the markerValue property to the given value.

Parameters:

value - the new value of the markerValue property

See Also:

getMarkerValue()

bindMaxValue

public void bindMaxValue(String path)

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

Parameters:

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

bindMaxValue

public void bindMaxValue(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfMaxValue

public String bindingOfMaxValue()

Returns the binding path of the maxValue property.

Returns:

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

getMaxValue

public double getMaxValue()

Returns the value of the maxValue property.

The initial value is -1.

Determines the maximum value in the range of values to be compared.
Must be specified if, when used in a table, the values across the table rows are to be compared graphically.

Returns:

the current value of the maxValue property

See Also:

setMaxValue(double)

setMaxValue

public void setMaxValue(double value)

Sets the maxValue property to the given value.

Parameters:

value - the new value of the maxValue property

See Also:

getMaxValue()

bindText

public void bindText(String path)

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

Parameters:

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

bindText

public void bindText(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfText

public String bindingOfText()

Returns the binding path of the text property.

Returns:

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

getText

public String getText()

Returns the value of the text property.

The initial value is "".

Display text

Returns:

the current value of the text property

See Also:

setText(String)

setText

public void setText(String value)

Sets the text property to the given value.

Parameters:

value - the new value of the text property

See Also:

getText()

bindUpperThresholdValue

public void bindUpperThresholdValue(String path)

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

Parameters:

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

bindUpperThresholdValue

public void bindUpperThresholdValue(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfUpperThresholdValue

public String bindingOfUpperThresholdValue()

Returns the binding path of the upperThresholdValue property.

Returns:

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

getUpperThresholdValue

public double getUpperThresholdValue()

Returns the value of the upperThresholdValue property.

The initial value is -1.

Determines the upper threshold value for changing the bar's color

Returns:

the current value of the upperThresholdValue property

See Also:

setUpperThresholdValue(double)

setUpperThresholdValue

public void setUpperThresholdValue(double value)

Sets the upperThresholdValue property to the given value.

Parameters:

value - the new value of the upperThresholdValue property

See Also:

getUpperThresholdValue()

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 int getWidth()

Returns the value of the width property.

The initial value is 0.

Determines the width, in pixels, of the GraphicalValueComparator diagram

Returns:

the current value of the width property

See Also:

setWidth(int)

setWidth

public void setWidth(int value)

Sets the width property to the given value.

Parameters:

value - the new value of the width property

See Also:

getWidth()