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

Class TickMark

java.lang.Object

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

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

All Implemented Interfaces:

ExtendedProperties

public class TickMark
extends ComplexExtendedProperties

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

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
TickMark()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getContent() Description: Specifies where tick marks occur within a gauge set.
java.lang.String	getId() Description: Specifies the identifier for the component
double	getMajorIncrement() Description: The distance between two major tick marks.
java.lang.String	getMajorIncrementAsString() Description: The distance between two major tick marks.
java.lang.String	getMajorTickColor() Description: Specifies the color of tick marks on the gauge.
int	getMajorTickCount() Description: Deprecated.
java.lang.String	getMajorTickCountAsString() Description: Deprecated.
double	getMinorIncrement() Description: The distance between two minor tick marks.
java.lang.String	getMinorIncrementAsString() Description: The distance between two minor tick marks.
java.lang.String	getMinorTickColor() Description: Specifies the color of minor tick marks on the gauge.
java.lang.String	getTagName()
void	setContent(java.lang.String content) Description: Specifies where tick marks occur within a gauge set.
void	setId(java.lang.String id) Description: Specifies the identifier for the component
void	setMajorIncrement(double majorIncrement) Description: The distance between two major tick marks.
void	setMajorIncrementAsString(java.lang.String majorIncrement) Description: The distance between two major tick marks.
void	setMajorTickColor(java.lang.String majorTickColor) Description: Specifies the color of tick marks on the gauge.
void	setMajorTickCount(int majorTickCount) Description: Deprecated.
void	setMajorTickCountAsString(java.lang.String majorTickCount) Description: Deprecated.
void	setMinorIncrement(double minorIncrement) Description: The distance between two minor tick marks.
void	setMinorIncrementAsString(java.lang.String minorIncrement) Description: The distance between two minor tick marks.
void	setMinorTickColor(java.lang.String minorTickColor) Description: Specifies the color of minor tick marks on the gauge.

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

TickMark

public TickMark()

Method Detail

getTagName

public java.lang.String getTagName()

Specified by:

getTagName in class ComplexExtendedProperties

getContent

public java.lang.String getContent()

Description: Specifies where tick marks occur within a gauge set. Valid values include any combination of the following separated by spaces or commas: Default value is: TC_MIN_MAX | TC_INCREMENTS TC_INCREMENTS - Displays tick marks by increments. TC_MAJOR_TICK - Displays tick marks for minimum, maximum, and increments. TC_MIN_MAX - Displays tick marks for minimum and maximum values. TC_METRIC - Displays tick marks for actual metric values. TC_NONE - Displays no tick marks. TC_THRESHOLD - Displays tick marks for threshold values.

Returns:

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

setContent

public void setContent(java.lang.String content)

Description: Specifies where tick marks occur within a gauge set. Valid values include any combination of the following separated by spaces or commas: Default value is: TC_MIN_MAX | TC_INCREMENTS TC_INCREMENTS - Displays tick marks by increments. TC_MAJOR_TICK - Displays tick marks for minimum, maximum, and increments. TC_MIN_MAX - Displays tick marks for minimum and maximum values. TC_METRIC - Displays tick marks for actual metric values. TC_NONE - Displays no tick marks. TC_THRESHOLD - Displays tick marks for threshold values.

Parameters:

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

getId

public java.lang.String getId()

Description: Specifies the identifier for the component

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 component

Parameters:

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

getMajorIncrement

public double getMajorIncrement()
                         throws java.lang.NumberFormatException

Description: The distance between two major tick marks. If less than or equal to 0 major increments will not be shown. The major tick are the ones that will display a labeled value underneath the tick mark.

Returns:

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

Throws:

java.lang.NumberFormatException

setMajorIncrement

public void setMajorIncrement(double majorIncrement)

Description: The distance between two major tick marks. If less than or equal to 0 major increments will not be shown. The major tick are the ones that will display a labeled value underneath the tick mark.

Parameters:

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

getMajorIncrementAsString

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

Description: The distance between two major tick marks. If less than or equal to 0 major increments will not be shown. The major tick are the ones that will display a labeled value underneath the tick mark. This method is provided as a convenience to be able to retrieve an EL that was set on the majorIncrement attribute.

Returns:

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

Throws:

java.lang.NumberFormatException

setMajorIncrementAsString

public void setMajorIncrementAsString(java.lang.String majorIncrement)

Description: The distance between two major tick marks. If less than or equal to 0 major increments will not be shown. The major tick are the ones that will display a labeled value underneath the tick mark. This method is provided as a convenience to be able to set an EL on the majorIncrement attribute.

Parameters:

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

getMajorTickColor

public java.lang.String getMajorTickColor()

Description: Specifies the color of tick marks on the gauge. Enter values in RGB hexadecimal. The example color="#000000" specifies black.

Returns:

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

setMajorTickColor

public void setMajorTickColor(java.lang.String majorTickColor)

Description: Specifies the color of tick marks on the gauge. Enter values in RGB hexadecimal. The example color="#000000" specifies black.

Parameters:

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

getMajorTickCount

public int getMajorTickCount()
                      throws java.lang.NumberFormatException

Description: Deprecated. Use majorIncrement attribute. The total number of ticks to be displayed in each gauge of the gauge set.

Returns:

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

Throws:

java.lang.NumberFormatException

setMajorTickCount

public void setMajorTickCount(int majorTickCount)

Description: Deprecated. Use majorIncrement attribute. The total number of ticks to be displayed in each gauge of the gauge set.

Parameters:

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

getMajorTickCountAsString

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

Description: Deprecated. Use majorIncrement attribute. The total number of ticks to be displayed in each gauge of the gauge set. This method is provided as a convenience to be able to retrieve an EL that was set on the majorTickCount attribute.

Returns:

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

Throws:

java.lang.NumberFormatException

setMajorTickCountAsString

public void setMajorTickCountAsString(java.lang.String majorTickCount)

Description: Deprecated. Use majorIncrement attribute. The total number of ticks to be displayed in each gauge of the gauge set. This method is provided as a convenience to be able to set an EL on the majorTickCount attribute.

Parameters:

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

getMinorIncrement

public double getMinorIncrement()
                         throws java.lang.NumberFormatException

Description: The distance between two minor tick marks. If less than or equal to 0 minor increments will not be shown. The minor tick are the ones that will not show a label underneath the tick mark.

Returns:

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

Throws:

java.lang.NumberFormatException

setMinorIncrement

public void setMinorIncrement(double minorIncrement)

Description: The distance between two minor tick marks. If less than or equal to 0 minor increments will not be shown. The minor tick are the ones that will not show a label underneath the tick mark.

Parameters:

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

getMinorIncrementAsString

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

Description: The distance between two minor tick marks. If less than or equal to 0 minor increments will not be shown. The minor tick are the ones that will not show a label underneath the tick mark. This method is provided as a convenience to be able to retrieve an EL that was set on the minorIncrement attribute.

Returns:

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

Throws:

java.lang.NumberFormatException

setMinorIncrementAsString

public void setMinorIncrementAsString(java.lang.String minorIncrement)

Description: The distance between two minor tick marks. If less than or equal to 0 minor increments will not be shown. The minor tick are the ones that will not show a label underneath the tick mark. This method is provided as a convenience to be able to set an EL on the minorIncrement attribute.

Parameters:

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

getMinorTickColor

public java.lang.String getMinorTickColor()

Description: Specifies the color of minor tick marks on the gauge. Enter values in RGB hexadecimal. The example color="#000000" specifies black.

Returns:

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

setMinorTickColor

public void setMinorTickColor(java.lang.String minorTickColor)

Description: Specifies the color of minor tick marks on the gauge. Enter values in RGB hexadecimal. The example color="#000000" specifies black.

Parameters:

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