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

Class TickLabel

java.lang.Object

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

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

All Implemented Interfaces:

ExtendedProperties

public class TickLabel
extends ComplexExtendedProperties

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

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

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAutoPrecision() Description: Specifies the auto precision function of this label Valid values are: on - The engine decides the number of digits on the numbers.
java.lang.String	getContent() Description: Specifies where tick labels occur within a gauge set.
GaugeFont	getGaugeFont() Description: Use the gaugeFont tag to format fonts in gauge components that display text.
java.lang.String	getId() Description: Specifies the identifier for the component
NumberFormat	getNumberFormat() Description: Specifies formatting for numeric values.
java.lang.String	getNumberType() Description: Format for numbers that are displayed in the tick labels.
java.lang.String	getPosition() Description: Specifies the position of the tick labels.
java.lang.String	getScaling() Description: Specifies the scale factor of this label Valid values are: auto - Automatically scales the number.
java.lang.String	getTagName()
void	setAutoPrecision(java.lang.String autoPrecision) Description: Specifies the auto precision function of this label Valid values are: on - The engine decides the number of digits on the numbers.
void	setContent(java.lang.String content) Description: Specifies where tick labels occur within a gauge set.
void	setGaugeFont(GaugeFont gaugeFont) Description: Use the gaugeFont tag to format fonts in gauge components that display text.
void	setId(java.lang.String id) Description: Specifies the identifier for the component
void	setNumberFormat(NumberFormat numberFormat) Description: Specifies formatting for numeric values.
void	setNumberType(java.lang.String numberType) Description: Format for numbers that are displayed in the tick labels.
void	setPosition(java.lang.String position) Description: Specifies the position of the tick labels.
void	setScaling(java.lang.String scaling) Description: Specifies the scale factor of this label Valid values are: auto - Automatically scales the number.

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

TickLabel

public TickLabel()

Method Detail

getTagName

public java.lang.String getTagName()

Specified by:

getTagName in class ComplexExtendedProperties

getAutoPrecision

public java.lang.String getAutoPrecision()

Description: Specifies the auto precision function of this label Valid values are: on - The engine decides the number of digits on the numbers. off - User specifies the number of digits on the numbers.

Returns:

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

setAutoPrecision

public void setAutoPrecision(java.lang.String autoPrecision)

Description: Specifies the auto precision function of this label Valid values are: on - The engine decides the number of digits on the numbers. off - User specifies the number of digits on the numbers.

Parameters:

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

getContent

public java.lang.String getContent()

Description: Specifies where tick labels occur within a gauge set. Valid values include any combination of the following separated by spaces or commas: TC_INCREMENTS - Displays tick labels by increments. TC_MAJOR_TICK - (Default) Displays tick labels for minimum, maximum, and increments. TC_MIN_MAX - Displays tick labels for minimum and maximum values. TC_METRIC - Displays tick labels for actual metric values. TC_NONE - Displays no tick labels. TC_THRESHOLD - Displays tick labels 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 labels occur within a gauge set. Valid values include any combination of the following separated by spaces or commas: TC_INCREMENTS - Displays tick labels by increments. TC_MAJOR_TICK - (Default) Displays tick labels for minimum, maximum, and increments. TC_MIN_MAX - Displays tick labels for minimum and maximum values. TC_METRIC - Displays tick labels for actual metric values. TC_NONE - Displays no tick labels. TC_THRESHOLD - Displays tick labels 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.

getNumberType

public java.lang.String getNumberType()

Description: Format for numbers that are displayed in the tick labels. Valid values are: NT_NUMBER - (Default) Specifies that the actual value is displayed. NT_PERCENT - Specifies that percentages are displayed and the axis is scaled from 0 to 100%.

Returns:

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

setNumberType

public void setNumberType(java.lang.String numberType)

Description: Format for numbers that are displayed in the tick labels. Valid values are: NT_NUMBER - (Default) Specifies that the actual value is displayed. NT_PERCENT - Specifies that percentages are displayed and the axis is scaled from 0 to 100%.

Parameters:

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

getPosition

public java.lang.String getPosition()

Description: Specifies the position of the tick labels. Valid values are: TLP_EXTERIOR - Specifies that the tick labels are displayed outside the plotArea. TLP_INTERIOR - (Default) Specifies that the tick labels are displayed inside the plotArea.

Returns:

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

setPosition

public void setPosition(java.lang.String position)

Description: Specifies the position of the tick labels. Valid values are: TLP_EXTERIOR - Specifies that the tick labels are displayed outside the plotArea. TLP_INTERIOR - (Default) Specifies that the tick labels are displayed inside the plotArea.

Parameters:

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

getScaling

public java.lang.String getScaling()

Description: Specifies the scale factor of this label Valid values are: auto - Automatically scales the number. none - Scales the number to units thousand - Scales the number to thousands. million - Scales the number to millions. billion - Scale the number to billions. trillion - Scale the number to trillions. quadrillion - Scale the number to quadrillions.

Returns:

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

setScaling

public void setScaling(java.lang.String scaling)

Description: Specifies the scale factor of this label Valid values are: auto - Automatically scales the number. none - Scales the number to units thousand - Scales the number to thousands. million - Scales the number to millions. billion - Scale the number to billions. trillion - Scale the number to trillions. quadrillion - Scale the number to quadrillions.

Parameters:

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

getGaugeFont

public GaugeFont getGaugeFont()

Description: Use the gaugeFont tag to format fonts in gauge components that display text.

Returns:

the GaugeFont of the Tag this class represents.

setGaugeFont

public void setGaugeFont(GaugeFont gaugeFont)

Description: Use the gaugeFont tag to format fonts in gauge components that display text.

Parameters:

gaugeFont - the GaugeFont of the Tag this class represents.

getNumberFormat

public NumberFormat getNumberFormat()

Description: Specifies formatting for numeric values.

Returns:

the NumberFormat of the Tag this class represents.

setNumberFormat

public void setNumberFormat(NumberFormat numberFormat)

Description: Specifies formatting for numeric values.

Parameters:

numberFormat - the NumberFormat of the Tag this class represents.