oracle.dss.graph
Class ZTickLabel

oracle.dss.graph.BaseGraphComponent
  |
  +--oracle.dss.graph.BaseText
        |
        +--oracle.dss.graph.ZTickLabel

All Implemented Interfaces:

DataviewFontAttribute, FontAttribute, HorizontalAlignment

public class ZTickLabel

extends BaseText

implements HorizontalAlignment

Identifies a tick mark on the Z-axis of a 3-D graph.

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	getHorizontalAlignment() Retrieves the horizontal alignment for the text within the rectangle of the tick label.
int	getTextRotation() Retrieves the rotation for the rectangle for all of the Z-axis tick labels.
int	getTickLabelSkipCount() Retrieves the number of Z-axis tick labels that the graph hides between each one that is displayed.
int	getTickLabelSkipFirst() Retrieves the index of the first Z-axis tick label that is skipped.
int	getTickLabelSkipMode() Retrieves the type of skipping that is used for the Z-axis tick labels.
boolean	selectObject(int series, int group) Selects all of the Z-axis tick labels in the graph.
void	setHorizontalAlignment(int a) Specifies the horizontal alignment of the text within the rectangle of the tick label.
void	setTextRotation(int orient) Specifies the rotation for the rectangle for all of the Z-axis tick labels.
void	setTickLabelSkipCount(int count) Specifies the number of Z-axis tick labels that the graph hides between each one that is displayed.
void	setTickLabelSkipFirst(int first) Specifies the index of the first Z-axis tick label that is skipped.
void	setTickLabelSkipMode(int mode) Specifies the type of skipping that is used for the Z-axis tick labels.

Methods inherited from class oracle.dss.graph.BaseText

getDataviewFont, getFont, getGraphFont, isFontSizeAbsolute, setFont, setFontSizeAbsolute

Method Detail

selectObject

public boolean selectObject(int series,
                            int group)

Selects all of the Z-axis tick labels in the graph. Because Z-axis tick labels are series components, the group parameter is irrelevant.

Overrides:

selectObject in class BaseGraphComponent

Parameters:

series - The series in the graph that these tick labels belong to.

group - Any integer.

Returns:

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

getTextRotation

public int getTextRotation()

Retrieves the rotation for the rectangle for all of the Z-axis tick labels.

Returns:

A constant that represents the rotation for the rectangle for all of the Z-axis tick labels. Valid constants are listed in the See Also section.

See Also:

BaseGraphComponent.TR_HORIZ, BaseGraphComponent.TR_HORIZ_ROTATE_90, BaseGraphComponent.TR_HORIZ_ROTATE_270

setTextRotation

public void setTextRotation(int orient)

Specifies the rotation for the rectangle for all of the Z-axis tick labels.

Parameters:

orient - A constant that represents the rotation for the rectangle for all of the Z-axis tick labels. Valid constants are listed in the See Also section. If you enter an invalid parameter value, the graph logs an ErrorHandler message and leaves the TextRotation property unchanged.

See Also:

BaseGraphComponent.TR_HORIZ, BaseGraphComponent.TR_HORIZ_ROTATE_90, BaseGraphComponent.TR_HORIZ_ROTATE_270

getTickLabelSkipCount

public int getTickLabelSkipCount()

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

Returns:

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

setTickLabelSkipCount

public void setTickLabelSkipCount(int count)

Specifies the number of Z-axis tick labels that the graph hides between each one that is displayed. If the count is less than 0, an error is logged with the error handler and the property value is not changed.

Parameters:

count - The number of Z-axis tick labels for the graph to hide between each one that is displayed.

getTickLabelSkipFirst

public int getTickLabelSkipFirst()

Retrieves the index of the first Z-axis tick label that is skipped. The values range from 0 to the number of tick labels on the axis.

Returns:

The index of the first ZTickLabel that is skipped.

setTickLabelSkipFirst

public void setTickLabelSkipFirst(int first)

Specifies the index of the first Z-axis tick label that is skipped. The values range from 0 to the number of tick labels on the axis. If the index is less than 0, an error is logged with the error handler and the property value is not changed.

Parameters:

first - The index of the first Z-axis tick label that is skipped.

getTickLabelSkipMode

public int getTickLabelSkipMode()

Retrieves the type of skipping that is used for the Z-axis tick labels.

Returns:

A constant that represents the type of skipping that is used for the Z-axis tick labels. Valid constants are listed in the See Also section.

See Also:

BaseGraphComponent.TLS_AUTOMATIC, BaseGraphComponent.TLS_MANUAL, BaseGraphComponent.TLS_NOSKIP

setTickLabelSkipMode

public void setTickLabelSkipMode(int mode)

Specifies the type of skipping that is used for the Z-axis tick labels.

Parameters:

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

See Also:

BaseGraphComponent.TLS_AUTOMATIC, BaseGraphComponent.TLS_MANUAL, BaseGraphComponent.TLS_NOSKIP

setHorizontalAlignment

public void setHorizontalAlignment(int a)

Specifies the horizontal alignment of the text within the rectangle of the tick label.

This method has no effect on axis titles in a 3-D graph.

Specified by:

setHorizontalAlignment in interface HorizontalAlignment

Parameters:

a - A Swing constant that represents the horizontal alignment for the text of the tick label. Valid constants are LEFT, CENTER, and RIGHT.

getHorizontalAlignment

public int getHorizontalAlignment()

Retrieves the horizontal alignment for the text within the rectangle of the tick label. When the text has been rotated to a vertical position, the horizontal alignment properties appear to move the text up and down, rather than left and right.

Specified by:

getHorizontalAlignment in interface HorizontalAlignment

Returns:

A SwingConstant value that represents the horizontal alignment for the text of this tick label. Valid constants are LEFT, CENTER, and RIGHT.