oracle.adfdt.view.dvt.binding.pattern.gauge

Class Threshold

java.lang.Object

oracle.adfdt.view.dvt.binding.pattern.options.ComplexExtendedProperties

oracle.adfdt.view.dvt.binding.pattern.gauge.Threshold

All Implemented Interfaces:

ExtendedProperties

public class Threshold
extends ComplexExtendedProperties

A set of accessor methods that allow the user to change the structure and functionality of an threshold.

Field Summary

Fields inherited from class oracle.adfdt.view.dvt.binding.pattern.options.ComplexExtendedProperties

AF_NS, DVT_NS, F_NS

Constructor Summary

Constructors

Constructor and Description
Threshold()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getBorderColor() Description: Specifies the border color for a threshold section of a gauge.
java.lang.String	getFillColor() Description: Specifies the fill color for a threshold section of a gauge.
java.lang.String	getId() Description: Specifies the identifier for the threshold component.
SpecialEffects	getSpecialEffects() Description: Use the specialEffects tag to set gradient properties of a subcomponent of a graph or gauge.
java.lang.String	getTagName()
java.lang.String	getText() Description: Specifies the string to be displayed in the legend for this threshold.
double	getThresholdMaxValue() Description: Specifies the upper bound of the threshold.
java.lang.String	getThresholdMaxValueAsString() Description: Specifies the upper bound of the threshold.
void	setBorderColor(java.lang.String borderColor) Description: Specifies the border color for a threshold section of a gauge.
void	setFillColor(java.lang.String fillColor) Description: Specifies the fill color for a threshold section of a gauge.
void	setId(java.lang.String id) Description: Specifies the identifier for the threshold component.
void	setSpecialEffects(SpecialEffects specialEffects) Description: Use the specialEffects tag to set gradient properties of a subcomponent of a graph or gauge.
void	setText(java.lang.String text) Description: Specifies the string to be displayed in the legend for this threshold.
void	setThresholdMaxValue(double thresholdMaxValue) Description: Specifies the upper bound of the threshold.
void	setThresholdMaxValueAsString(java.lang.String thresholdMaxValue) Description: Specifies the upper bound of the threshold.

Methods inherited from class oracle.adfdt.view.dvt.binding.pattern.options.ComplexExtendedProperties

_applyToRootElement, _applyToRootElement, applyChanges, applyChanges, applyChanges, applyChanges, applyChanges, cloneFrom, getAttribute, getComplexChild, getComplexChild, getComplexChildAsList, populateAttributesAndChildTags, removeComplexChildList, setAttribute, setComplexChild, setComplexChild, setComplexChildAsList

Methods inherited from class java.lang.Object

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

Constructor Detail

Threshold

public Threshold()

Method Detail

getTagName

public java.lang.String getTagName()

Specified by:

getTagName in class ComplexExtendedProperties

getBorderColor

public java.lang.String getBorderColor()

Description: Specifies the border color for a threshold section of a gauge. Enter values in RGB hexadecimal. This color property takes 6 or 8 digit hex as input. When 8 digit hex is used, the first 2 digits represent transparency, otherwise the color is opaque.

Returns:

the value of the borderColor attribute of the Tag this class represents.

setBorderColor

public void setBorderColor(java.lang.String borderColor)

Description: Specifies the border color for a threshold section of a gauge. Enter values in RGB hexadecimal. This color property takes 6 or 8 digit hex as input. When 8 digit hex is used, the first 2 digits represent transparency, otherwise the color is opaque.

Parameters:

borderColor - the value of the borderColor attribute of the Tag this class represents.

getFillColor

public java.lang.String getFillColor()

Description: Specifies the fill color for a threshold section of a gauge. Enter values in RGB hexadecimal. This color property takes 6 or 8 digit hex as input. When 8 digit hex is used, the first 2 digits represent transparency, otherwise the color is opaque.

Returns:

the value of the fillColor attribute of the Tag this class represents.

setFillColor

public void setFillColor(java.lang.String fillColor)

Description: Specifies the fill color for a threshold section of a gauge. Enter values in RGB hexadecimal. This color property takes 6 or 8 digit hex as input. When 8 digit hex is used, the first 2 digits represent transparency, otherwise the color is opaque.

Parameters:

fillColor - the value of the fillColor attribute of the Tag this class represents.

getId

public java.lang.String getId()

Description: Specifies the identifier for the threshold component. Note: This property does not specify the index for the threshold component. Indexes of thresholds are implicitly set, as the order of threshold tags in the jspx page is used as index.

Returns:

the value of the id attribute of the Tag this class represents.

setId

public void setId(java.lang.String id)

Description: Specifies the identifier for the threshold component. Note: This property does not specify the index for the threshold component. Indexes of thresholds are implicitly set, as the order of threshold tags in the jspx page is used as index.

Parameters:

id - the value of the id attribute of the Tag this class represents.

getText

public java.lang.String getText()

Description: Specifies the string to be displayed in the legend for this threshold.

Returns:

the value of the text attribute of the Tag this class represents.

setText

public void setText(java.lang.String text)

Description: Specifies the string to be displayed in the legend for this threshold.

Parameters:

text - the value of the text attribute of the Tag this class represents.

getThresholdMaxValue

public double getThresholdMaxValue()
                            throws java.lang.NumberFormatException

Description: Specifies the upper bound of the threshold. For the final threshold in a threshold set, this setting is ignored. The maximum value of the Gauge becomes the thresholdMaxValue for the last threshold.

Returns:

the value of the thresholdMaxValue attribute of the Tag this class represents.

Throws:

java.lang.NumberFormatException

setThresholdMaxValue

public void setThresholdMaxValue(double thresholdMaxValue)

Description: Specifies the upper bound of the threshold. For the final threshold in a threshold set, this setting is ignored. The maximum value of the Gauge becomes the thresholdMaxValue for the last threshold.

Parameters:

thresholdMaxValue - the value of the thresholdMaxValue attribute of the Tag this class represents.

getThresholdMaxValueAsString

public java.lang.String getThresholdMaxValueAsString()
                                              throws java.lang.NumberFormatException

Description: Specifies the upper bound of the threshold. For the final threshold in a threshold set, this setting is ignored. The maximum value of the Gauge becomes the thresholdMaxValue for the last threshold. This method is provided as a convenience to be able to retrieve an EL that was set on the thresholdMaxValue attribute.

Returns:

the value of the thresholdMaxValue attribute of the Tag this class represents.

Throws:

java.lang.NumberFormatException

setThresholdMaxValueAsString

public void setThresholdMaxValueAsString(java.lang.String thresholdMaxValue)

Description: Specifies the upper bound of the threshold. For the final threshold in a threshold set, this setting is ignored. The maximum value of the Gauge becomes the thresholdMaxValue for the last threshold. This method is provided as a convenience to be able to set an EL on the thresholdMaxValue attribute.

Parameters:

thresholdMaxValue - the value of the thresholdMaxValue attribute of the Tag this class represents.

getSpecialEffects

public SpecialEffects getSpecialEffects()

Description: Use the specialEffects tag to set gradient properties of a subcomponent of a graph or gauge. This tag wraps gradientStopStyle tags for a graph or for a gauge.

Returns:

the SpecialEffects of the Tag this class represents.

setSpecialEffects

public void setSpecialEffects(SpecialEffects specialEffects)

Description: Use the specialEffects tag to set gradient properties of a subcomponent of a graph or gauge. This tag wraps gradientStopStyle tags for a graph or for a gauge.

Parameters:

specialEffects - the SpecialEffects of the Tag this class represents.