oracle.dss.graph
Class O1TickLabel

oracle.dss.graph.BaseGraphComponent
  |
  +--oracle.dss.graph.BaseText
        |
        +--oracle.dss.graph.BaseTickLabel
              |
              +--oracle.dss.graph.O1TickLabel

All Implemented Interfaces:

DataviewFontAttribute, FontAttribute, HorizontalAlignment, WordWrapEnabled

public class O1TickLabel

extends BaseTickLabel

implements WordWrapEnabled

Identifies a tick mark on the O1-axis of the graph. This usually contains the names of the dimension or measure that the O1-axis represents.

Fields inherited from class oracle.dss.graph.BaseGraphComponent

AL_BOTH, AL_LEFT, AL_RIGHT, AP_ALWAYS, AP_NEVER, AR_HORIZ_ROTATE_270, AR_HORIZ_ROTATE_90, AR_NO_ROTATE, DY2_AUTO_ASSIGN, DY2_FALSE, DY2_TRUE, FS_BOLD, FS_BOLD_ITALIC_UNDERLINE, FS_BOLD_UNDERLINE, FS_ITALIC, FS_ITALIC_BOLD, FS_ITALIC_UNDERLINE, FS_PLAIN, FS_UNDERLINE, FT_COLOR, FT_EXPONENTIAL, FT_GRADIENT, FT_LINEAR, FT_LOGARITHMIC, FT_NONE, FT_TEXTURE, GD_DIAGONAL_135, GD_DIAGONAL_45, GD_DOWN, GD_DOWN_LEFT, GD_DOWN_RIGHT, GD_LEFT, GD_RADIAL, GD_RADIAL_BOTTOM_LEFT, GD_RADIAL_BOTTOM_RIGHT, GD_RADIAL_TOP_LEFT, GD_RADIAL_TOP_RIGHT, GD_RIGHT, GD_UP, GD_UP_LEFT, GD_UP_RIGHT, GS_EXTENDED, GS_GRID, GS_IN, GS_OUT, GS_SPAN, LAP_BOTTOM, LAP_LEFT, LAP_RIGHT, LAP_TOP, LD_PERCENT, LD_TEXT, LD_TEXT_PERCENT, LD_VALUE, LEGENDMARKERSLIMIT, LO_AUTOMATIC, LO_HORIZONTAL, LO_VERTICAL, LP_INSIDE, LP_NO_LABELS, LP_OUTSIDE_WITH_FEELER, LP_OUTSIDE_WITHOUT_FEELER, LTP_ABOVE, LTP_BELOW, LTP_ON_LEFT, LTP_ON_MARKER, LTP_ON_RIGHT, MS_AUTOMATIC, MS_CIRCLE, MS_DIAMOND, MS_NONE, MS_PLUS, MS_SQUARE, MS_TRIANGLE_DOWN, MS_TRIANGLE_UP, MT_AREA, MT_BAR, MT_DEFAULT, MT_MARKER, MTP_CENTER, MTP_CUSTOM, MTP_INSIDE_MAX, MTP_INSIDE_MIN, MTP_ON_MAXEDGE, MTP_OUTSIDE_MAX, QUADRANTLINEVALUELIMIT, TDM_STRETCHED, TDM_TILED, TLS_AUTOMATIC, TLS_MANUAL, TLS_NOSKIP, TR_HORIZ, TR_HORIZ_ROTATE_270, TR_HORIZ_ROTATE_90, VF_STOCK_VOLUME, VF_X1, VF_Y1, VF_Y2, VF_Z

Method Summary

int	getAutomaticRotation() Retrieves the angle of automatic rotation for the text within the rectangle for each of the O1-axis tick labels.
int	getTickLabelSkipCount() Retrieves the number of O1-axis tick labels that the graph hides between each one that is displayed.
int	getTickLabelSkipFirst() Retrieves the index of the first O1-axis tick label that is skipped.
int	getTickLabelSkipMode() Retrieves the type of skipping that is used for the O1-axis tick labels.
boolean	isTextFittingAutomatic() Indicates whether all of the O1-axis tick labels are automatically moved and resized relative to the size of the graph.
boolean	isTickLabelStaggered() Indicates whether all of the O1-axis tick labels are staggered.
boolean	isTickLabelWrapped() Deprecated. As of 2.6.0.15, replaced by isWordWrapEnabled()
boolean	isWordWrapEnabled() Indicates whether word wrap is enabled for all of the O1-axis tick labels.
boolean	selectObject(int layer, int group) Selects this O1-axis tick label in the graph.
void	setAutomaticRotation(int orient) Specifies the angle of automatic rotation for the text within the rectangle for each of the O1-axis tick labels.
void	setTextFittingAutomatic(boolean yesNo) Specifies whether all of the O1-axis tick labels are automatically moved and resized relative to the size of the graph.
void	setTextRotation(int orient) Specifies the angle of rotation for the text within the rectangle for each of the O1-axis tick labels.
void	setTickLabelSkipCount(int count) Specifies the number of O1-axis tick labels that the graph hides between each one that is displayed.
void	setTickLabelSkipFirst(int first) Specifies the index of the first 01-axis tick label that is skipped.
void	setTickLabelSkipMode(int mode) Specifies the type of skipping that is used for the O1-axis tick labels.
void	setTickLabelStaggered(boolean yesNo) Specifies whether all of the O1-axis tick labels are staggered.
void	setTickLabelWrapped(boolean yesNo) Deprecated. As of 2.6.0.15, replaced by setWordWrapEnabled(boolean)
void	setWordWrapEnabled(boolean yesNo) Specifies whether word wrap is enabled for all of the O1-axis tick labels.

Methods inherited from class oracle.dss.graph.BaseTickLabel

getHorizontalAlignment, getTextRotation, setHorizontalAlignment

Methods inherited from class oracle.dss.graph.BaseText

getDataviewFont, getFont, getGraphFont, isFontSizeAbsolute, setFont, setFontSizeAbsolute

Method Detail

selectObject

public boolean selectObject(int layer,
                            int group)

Selects this O1-axis tick label in the graph. If the O1-axis is a time axis, then the layer identifies whether to select the outer layer (layer 0) or the inner layer (layer 1).

For example, if a time axis has month labels next to the axis and year labels below the month labels, then the year labels are layer 0, and the month labels are layer 1.

If the O1-axis is not a time axis, then the layer parameter is irrelevant.

Overrides:

selectObject in class BaseTickLabel

Parameters:

layer - If the axis is a time axis, then pass 0 for an outer label or 1 for an inner label. If the axis is not a time axis, then pass any integer.

group - The group that this tick label belongs to.

Returns:

true if successful, false if not.

isTextFittingAutomatic

public boolean isTextFittingAutomatic()

Indicates whether all of the O1-axis tick labels are automatically moved and resized relative to the size of the graph. Automatic graph layout ignores this property.

Overrides:

isTextFittingAutomatic in class BaseTickLabel

Returns:

true if they are moved and resized, false if they are independent from the size of the graph.

See Also:

Graph.setAutoLayout(int)

setTextFittingAutomatic

public void setTextFittingAutomatic(boolean yesNo)

Specifies whether all of the O1-axis tick labels are automatically moved and resized relative to the size of the graph.

Graph automatic layout ignores this property.

Overrides:

setTextFittingAutomatic in class BaseTickLabel

Parameters:

yesNo - true to make them automatically moved and resized, false to make them independent from the size of the graph.

See Also:

Graph.setAutoLayout(int)

getAutomaticRotation

public int getAutomaticRotation()

Retrieves the angle of automatic rotation for the text within the rectangle for each of the O1-axis tick labels. Automatic graph layout uses this property to know which way to rotate labels when it determines that they need to be rotated. The doAutoLayout method always sets this property to AR_NO_ROTATE.

doAutoLayout(BaseGraphComponent.HONOR_PROPERTIES) respects this property. doAutoLayout(BaseGraphComponent.RESET_PROPERTIES) treats this property as AR_HORIZ_ROTATE_270.

Returns:

A constant that represents the angle of automatic rotation for the text within the rectangle for each of the O1-axis tick labels. Valid constants are listed in the See Also section.

See Also:

BaseGraphComponent.AR_NO_ROTATE, BaseGraphComponent.AR_HORIZ_ROTATE_90, BaseGraphComponent.AR_HORIZ_ROTATE_270, Graph.setAutoLayout(int)

setAutomaticRotation

public void setAutomaticRotation(int orient)

Specifies the angle of automatic rotation for the text within the rectangle for each of the O1-axis tick labels. Automatic graph layout uses this property to know which way to rotate labels when it determines that they need to be rotated. The doAutoLayout method always sets this property to AR_NO_ROTATE.

doAutoLayout(BaseGraphComponent.HONOR_PROPERTIES) respects this property. doAutoLayout(BaseGraphComponent.RESET_PROPERTIES) treats this property as AR_HORIZ_ROTATE_270.

Parameters:

orient - A constant that represents the angle of automatic rotation for the text within the rectangle for each of the O1-axis tick labels. Valid constants are listed in the See Also section. If you pass an invalid value, then the graph does not change the AutomaticRotation property value. It logs a message with the error handler.

See Also:

BaseGraphComponent.AR_NO_ROTATE, BaseGraphComponent.AR_HORIZ_ROTATE_90, BaseGraphComponent.AR_HORIZ_ROTATE_270

setTextRotation

public void setTextRotation(int orient)

Specifies the angle of rotation for the text within the rectangle for each of the O1-axis tick labels. Automatic rotation respects this property, but setting this property limits the strategies that automatic layout can use to display tick labels. If you specify rotation for tick labels, you eliminate several possibilities for better tick label layout.

doAutoLayout(BaseGraphComponent.HONOR_PROPERTIES) respects this property. doAutoLayout(BaseGraphComponent.RESET_PROPERTIES) treats this property as TR_HORIZ.

Overrides:

setTextRotation in class BaseTickLabel

Parameters:

orient - A constant that represents the angle of rotation for the text within the rectangle for each of the O1-axis tick labels. Valid constants are listed in the See Also section. If you pass an invalid value, then the graph does not change the TextRotation property value. It logs a message with the error handler.

See Also:

BaseGraphComponent.TR_HORIZ, BaseGraphComponent.TR_HORIZ_ROTATE_90, BaseGraphComponent.TR_HORIZ_ROTATE_270, Graph.setAutoLayout(int)

getTickLabelSkipCount

public int getTickLabelSkipCount()

Retrieves the number of O1-axis tick labels that the graph hides between each one that is displayed. This property takes effect when the TickLabelSkipMode property is set to TLS_MANUAL.

Automatic graph layout respects this property, if TickLabelSkipMode is TLS_MANUAL. Otherwise, automatic layout ignores this property. The doAutoLayout method sets it as needed, if TickLabelSkipMode is TLS_AUTOMATIC or if you pass RESET_PROPERTIES as the argument to doAutoLayout.

Returns:

The number of O1-axis tick labels that the graph hides between each one that is displayed.

See Also:

setTickLabelSkipMode(int), Graph.setAutoLayout(int), Graph.doAutoLayout(int)

setTickLabelSkipCount

public void setTickLabelSkipCount(int count)

Specifies the number of O1-axis tick labels that the graph hides between each one that is displayed. This property takes effect when the TickLabelSkipMode property is set to TLS_MANUAL.

Automatic graph layout respects this property, if TickLabelSkipMode is TLS_MANUAL. Otherwise, automatic layout ignores this property. The doAutoLayout method sets it as needed, if TickLabelSkipMode is TLS_AUTOMATIC or if you pass RESET_PROPERTIES as the argument to doAutoLayout.

Parameters:

count - The number of O1-axis tick labels that the graph hides between each one that is displayed.

See Also:

setTickLabelSkipMode(int), Graph.setAutoLayout(int), Graph.doAutoLayout(int)

getTickLabelSkipFirst

public int getTickLabelSkipFirst()

Retrieves the index of the first O1-axis tick label that is skipped. The values range from 0 to the number of tick labels on the axis. This property takes effect when the TickLabelSkipMode property is set to TLS_MANUAL.

Automatic graph layout respects this property, if TickLabelSkipMode is TLS_MANUAL. Otherwise, automatic layout ignores this property. The doAutoLayout method sets it as needed, if TickLabelSkipMode is TLS_AUTOMATIC or if you pass RESET_PROPERTIES as the argument to doAutoLayout.

Returns:

The index of the first O1TickLabel that is skipped.

See Also:

setTickLabelSkipMode(int), setTickLabelSkipCount(int), Graph.setAutoLayout(int), Graph.doAutoLayout(int)

setTickLabelSkipFirst

public void setTickLabelSkipFirst(int first)

Specifies the index of the first 01-axis tick label that is skipped. The values range from 0 to the number of tick labels on the axis. This property takes effect when the TickLabelSkipMode property is set to TLS_MANUAL.

Automatic graph layout respects this property, if TickLabelSkipMode is TLS_MANUAL. Otherwise, automatic layout ignores this property. The doAutoLayout method sets it as needed, if TickLabelSkipMode is TLS_AUTOMATIC or if you pass RESET_PROPERTIES as the argument to doAutoLayout.

Parameters:

first - The index of the first O1-axis tick label that is skipped. This index should not be greater than the value of TickLabelSkipCount. For example, if you set the graph to skip two labels between each displayed label, you cannot start with the fourth label (index 3).

See Also:

setTickLabelSkipMode(int), setTickLabelSkipCount(int), Graph.setAutoLayout(int), Graph.doAutoLayout(int)

getTickLabelSkipMode

public int getTickLabelSkipMode()

Retrieves the type of skipping that is used for the O1-axis tick labels. Automatic graph layout respects this property.

The doAutoLayout method always sets this property to TLS_AUTOMATIC. doAutoLayout(BaseGraphComponent.HONOR_PROPERTIES) respects this property. doAutoLayout(BaseGraphComponent.RESET_PROPERTIES) treats this property as TLS_AUTOMATIC.

Returns:

A constant that represents the type of skipping that is used for the 01-axis tick labels.

See Also:

setTickLabelSkipCount(int), setTickLabelSkipFirst(int), BaseGraphComponent.TLS_AUTOMATIC, BaseGraphComponent.TLS_MANUAL, BaseGraphComponent.TLS_NOSKIP, Graph.setAutoLayout(int), Graph.doAutoLayout(int)

setTickLabelSkipMode

public void setTickLabelSkipMode(int mode)

Specifies the type of skipping that is used for the O1-axis tick labels. Automatic graph layout respects this property.

The doAutoLayout method always sets this property to TLS_MANUAL so you can adjust the related properties as needed. doAutoLayout(BaseGraphComponent.HONOR_PROPERTIES) respects this property. doAutoLayout(BaseGraphComponent.RESET_PROPERTIES) treats this property as TLS_AUTOMATIC.

Parameters:

mode - A constant that represents the type of skipping that is used for the O1-axis tick labels. Valid constants are listed in the See Also section. If you enter an invalid parameter value, then the graph will log an ErrorHandler message, and will not change the TickLabelSkipMode property.

See Also:

BaseGraphComponent.TLS_AUTOMATIC, BaseGraphComponent.TLS_MANUAL, BaseGraphComponent.TLS_NOSKIP, Graph.setAutoLayout(int), Graph.doAutoLayout(int)

isTickLabelStaggered

public boolean isTickLabelStaggered()

Indicates whether all of the O1-axis tick labels are staggered. Automatic graph layout ignores this property, and doAutoLayout sets it as needed.

Overrides:

isTickLabelStaggered in class BaseTickLabel

Returns:

true if they are staggered, false if they are aligned.

See Also:

Graph.setAutoLayout(int), Graph.doAutoLayout(int)

setTickLabelStaggered

public void setTickLabelStaggered(boolean yesNo)

Specifies whether all of the O1-axis tick labels are staggered. Automatic graph layout ignores this property, and doAutoLayout sets it as needed.

Overrides:

setTickLabelStaggered in class BaseTickLabel

Parameters:

yesNo - true to stagger them, false to align them.

See Also:

Graph.setAutoLayout(int), Graph.doAutoLayout(int)

isTickLabelWrapped

public boolean isTickLabelWrapped()

Deprecated. As of 2.6.0.15, replaced by isWordWrapEnabled()

Indicates whether word wrap is enabled for all of the O1-axis tick labels.

Returns:

true if they are wrapped onto multiple lines, false if they are not.

setTickLabelWrapped

public void setTickLabelWrapped(boolean yesNo)

Deprecated. As of 2.6.0.15, replaced by setWordWrapEnabled(boolean)

Specifies whether word wrap is enabled for all of the O1-axis tick labels. multiple lines.

Parameters:

yesNo - true to wrap them, false to prohibit wrapping.

isWordWrapEnabled

public boolean isWordWrapEnabled()

Indicates whether word wrap is enabled for all of the O1-axis tick labels. Automatic graph layout ignores this property, and doAutoLayout sets it as needed.

Specified by:

isWordWrapEnabled in interface WordWrapEnabled

Returns:

true if it is enabled, false if it is not.

See Also:

Graph.setAutoLayout(int), Graph.doAutoLayout(int)

setWordWrapEnabled

public void setWordWrapEnabled(boolean yesNo)

Specifies whether word wrap is enabled for all of the O1-axis tick labels. Automatic graph layout ignores this property, and doAutoLayout sets it as needed.

Specified by:

setWordWrapEnabled in interface WordWrapEnabled

Parameters:

yesNo - true to wrap words, false to prohibit wrapping.

See Also:

Graph.setAutoLayout(int), Graph.doAutoLayout(int)