oracle.adfdt.view.dvt.binding.pattern.graph

Class O1TickLabel

java.lang.Object

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

oracle.adfdt.view.dvt.binding.pattern.graph.O1TickLabel

All Implemented Interfaces:

ExtendedProperties

public class O1TickLabel
extends ComplexExtendedProperties

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

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

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAutomaticRotation() Description: Specifies the the angle of automatic rotation for the text within the rectangle for each of the ordinal axis tick labels.
GraphFont	getGraphFont() Description: Formats fonts in graph components that display text.
java.lang.String	getId() Description: Specifies the identifier for the component
java.lang.String	getTagName()
java.lang.String	getTextRotation() Description: Specifies the orientation of the rotated text.
int	getTickLabelSkipCount() Description: Specifies the number of tick labels that the graph hides between each displayed tick label.
java.lang.String	getTickLabelSkipCountAsString() Description: Specifies the number of tick labels that the graph hides between each displayed tick label.
int	getTickLabelSkipFirst() Description: Specifies the index of the first tick label that is to be skipped.
java.lang.String	getTickLabelSkipFirstAsString() Description: Specifies the index of the first tick label that is to be skipped.
java.lang.String	getTickLabelSkipMode() Description: Specifies the type of skipping that is used for the tick labels on this axis.
boolean	isRendered() Description: Indicates whether the O1TickLabels are to be visible.
java.lang.String	isRenderedAsString() Description: Indicates whether the O1TickLabels are to be visible.
void	setAutomaticRotation(java.lang.String automaticRotation) Description: Specifies the the angle of automatic rotation for the text within the rectangle for each of the ordinal axis tick labels.
void	setGraphFont(GraphFont graphFont) Description: Formats fonts in graph components that display text.
void	setId(java.lang.String id) Description: Specifies the identifier for the component
void	setRendered(boolean rendered) Description: Indicates whether the O1TickLabels are to be visible.
void	setRenderedAsString(java.lang.String rendered) Description: Indicates whether the O1TickLabels are to be visible.
void	setTextRotation(java.lang.String textRotation) Description: Specifies the orientation of the rotated text.
void	setTickLabelSkipCount(int tickLabelSkipCount) Description: Specifies the number of tick labels that the graph hides between each displayed tick label.
void	setTickLabelSkipCountAsString(java.lang.String tickLabelSkipCount) Description: Specifies the number of tick labels that the graph hides between each displayed tick label.
void	setTickLabelSkipFirst(int tickLabelSkipFirst) Description: Specifies the index of the first tick label that is to be skipped.
void	setTickLabelSkipFirstAsString(java.lang.String tickLabelSkipFirst) Description: Specifies the index of the first tick label that is to be skipped.
void	setTickLabelSkipMode(java.lang.String tickLabelSkipMode) Description: Specifies the type of skipping that is used for the tick labels on this axis.

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

O1TickLabel

public O1TickLabel()

Method Detail

getTagName

public java.lang.String getTagName()

Specified by:

getTagName in class ComplexExtendedProperties

getAutomaticRotation

public java.lang.String getAutomaticRotation()

Description: Specifies the the angle of automatic rotation for the text within the rectangle for each of the ordinal axis tick labels. Valid values are: AR_NO_ROTATE - (Default) No text rotation. AR_HORIZ_ROTATE_90 - Text rotation angle of 90 degrees. AR_HORIZ_ROTATE_270 - Text rotation angle of 270 degrees.

Returns:

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

setAutomaticRotation

public void setAutomaticRotation(java.lang.String automaticRotation)

Description: Specifies the the angle of automatic rotation for the text within the rectangle for each of the ordinal axis tick labels. Valid values are: AR_NO_ROTATE - (Default) No text rotation. AR_HORIZ_ROTATE_90 - Text rotation angle of 90 degrees. AR_HORIZ_ROTATE_270 - Text rotation angle of 270 degrees.

Parameters:

automaticRotation - the value of the automaticRotation 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.

isRendered

public boolean isRendered()

Description: Indicates whether the O1TickLabels are to be visible. Valid values are: true - (Default) If the graph plot area is rendered. false - If the graph plot area is not rendered.

Returns:

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

setRendered

public void setRendered(boolean rendered)

Description: Indicates whether the O1TickLabels are to be visible. Valid values are: true - (Default) If the graph plot area is rendered. false - If the graph plot area is not rendered.

Parameters:

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

isRenderedAsString

public java.lang.String isRenderedAsString()

Description: Indicates whether the O1TickLabels are to be visible. Valid values are: true - (Default) If the graph plot area is rendered. false - If the graph plot area is not rendered. This method is provided as a convenience to be able to retrieve an EL that was set on the rendered attribute.

Returns:

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

setRenderedAsString

public void setRenderedAsString(java.lang.String rendered)

Description: Indicates whether the O1TickLabels are to be visible. Valid values are: true - (Default) If the graph plot area is rendered. false - If the graph plot area is not rendered. This method is provided as a convenience to be able to set an EL on the rendered attribute.

Parameters:

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

getTextRotation

public java.lang.String getTextRotation()

Description: Specifies the orientation of the rotated text. Valid values are: 0 - Use horizontal orientation. 90 - Use 90 degree orientation for rotated text. 270 - (Default) Use 270 degree orientation for rotated text. Any integer between 0 and 360 Note: Due to rendering issues, rotation angles that are not multiples of 90 degrees should not be used with the Flash rendering format.

Returns:

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

setTextRotation

public void setTextRotation(java.lang.String textRotation)

Description: Specifies the orientation of the rotated text. Valid values are: 0 - Use horizontal orientation. 90 - Use 90 degree orientation for rotated text. 270 - (Default) Use 270 degree orientation for rotated text. Any integer between 0 and 360 Note: Due to rendering issues, rotation angles that are not multiples of 90 degrees should not be used with the Flash rendering format.

Parameters:

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

getTickLabelSkipCount

public int getTickLabelSkipCount()
                          throws java.lang.NumberFormatException

Description: Specifies the number of tick labels that the graph hides between each displayed tick label. This property applies only when the tickLabelSkipMode attribute is set to TLS_MANUAL. The count of "0" causes all tick labels to be displayed on the axis.

Returns:

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

Throws:

java.lang.NumberFormatException

setTickLabelSkipCount

public void setTickLabelSkipCount(int tickLabelSkipCount)

Description: Specifies the number of tick labels that the graph hides between each displayed tick label. This property applies only when the tickLabelSkipMode attribute is set to TLS_MANUAL. The count of "0" causes all tick labels to be displayed on the axis.

Parameters:

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

getTickLabelSkipCountAsString

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

Description: Specifies the number of tick labels that the graph hides between each displayed tick label. This property applies only when the tickLabelSkipMode attribute is set to TLS_MANUAL. The count of "0" causes all tick labels to be displayed on the axis. This method is provided as a convenience to be able to retrieve an EL that was set on the tickLabelSkipCount attribute.

Returns:

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

Throws:

java.lang.NumberFormatException

setTickLabelSkipCountAsString

public void setTickLabelSkipCountAsString(java.lang.String tickLabelSkipCount)

Description: Specifies the number of tick labels that the graph hides between each displayed tick label. This property applies only when the tickLabelSkipMode attribute is set to TLS_MANUAL. The count of "0" causes all tick labels to be displayed on the axis. This method is provided as a convenience to be able to set an EL on the tickLabelSkipCount attribute.

Parameters:

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

getTickLabelSkipFirst

public int getTickLabelSkipFirst()
                          throws java.lang.NumberFormatException

Description: Specifies the index of the first tick label that is to be skipped. Valid values range from 0 to the number of tick labels on the axis. This attribute applies only when the tickLabelSkipMode attribute is set to TLS_MANUAL.

Returns:

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

Throws:

java.lang.NumberFormatException

setTickLabelSkipFirst

public void setTickLabelSkipFirst(int tickLabelSkipFirst)

Description: Specifies the index of the first tick label that is to be skipped. Valid values range from 0 to the number of tick labels on the axis. This attribute applies only when the tickLabelSkipMode attribute is set to TLS_MANUAL.

Parameters:

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

getTickLabelSkipFirstAsString

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

Description: Specifies the index of the first tick label that is to be skipped. Valid values range from 0 to the number of tick labels on the axis. This attribute applies only when the tickLabelSkipMode attribute is set to TLS_MANUAL. This method is provided as a convenience to be able to retrieve an EL that was set on the tickLabelSkipFirst attribute.

Returns:

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

Throws:

java.lang.NumberFormatException

setTickLabelSkipFirstAsString

public void setTickLabelSkipFirstAsString(java.lang.String tickLabelSkipFirst)

Description: Specifies the index of the first tick label that is to be skipped. Valid values range from 0 to the number of tick labels on the axis. This attribute applies only when the tickLabelSkipMode attribute is set to TLS_MANUAL. This method is provided as a convenience to be able to set an EL on the tickLabelSkipFirst attribute.

Parameters:

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

getTickLabelSkipMode

public java.lang.String getTickLabelSkipMode()

Description: Specifies the type of skipping that is used for the tick labels on this axis. Valid values are: TLS_AUTOMATIC - The graph determines whether tick labels will be skipped. TLS_MANUAL - The setting of the tickLabelSkipCount attribute determines what labels will be skipped. TLS_NOSKIP - No labels are skipped.

Returns:

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

setTickLabelSkipMode

public void setTickLabelSkipMode(java.lang.String tickLabelSkipMode)

Description: Specifies the type of skipping that is used for the tick labels on this axis. Valid values are: TLS_AUTOMATIC - The graph determines whether tick labels will be skipped. TLS_MANUAL - The setting of the tickLabelSkipCount attribute determines what labels will be skipped. TLS_NOSKIP - No labels are skipped.

Parameters:

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

getGraphFont

public GraphFont getGraphFont()

Description: Formats fonts in graph components that display text.

Returns:

the GraphFont of the Tag this class represents.

setGraphFont

public void setGraphFont(GraphFont graphFont)

Description: Formats fonts in graph components that display text.

Parameters:

graphFont - the GraphFont of the Tag this class represents.