oracle.dss.graph
Class BaseTickLabel

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

All Implemented Interfaces:

DataviewFontAttribute, FontAttribute, HorizontalAlignment

Direct Known Subclasses:

O1TickLabel, X1TickLabel, Y1TickLabel, Y2TickLabel

public abstract class BaseTickLabel

extends BaseText

implements HorizontalAlignment

Identifies a tick mark on an axis of the 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 of the text for all of the tick labels of this axis in the graph.
boolean	isTextFittingAutomatic() Indicates whether all of the this axis tick labels are automatically moved and resized relative to the size of the graph.
abstract boolean	isTickLabelStaggered() Indicates whether all of the tick labels of this axis are staggered.
boolean	selectObject(int series, int group) Selects all tick labels of this axis in the graph.
void	setHorizontalAlignment(int a) Specifies the horizontal alignment of the text within the rectangle of the tick label.
void	setTextFittingAutomatic(boolean yesNo) Specifies whether the tick labels are automatically moved and resized relative to the size of the graph.
void	setTextRotation(int orient) Specifies the rotation of the text for all of the tick labels of this axis in the graph.
abstract void	setTickLabelStaggered(boolean yesNo) Specifies whether all of the tick labels of this axis are staggered.

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 tick labels of this axis in the graph. Because tick labels do not represent data, the parameter values are irrelevant.

Overrides:

selectObject in class BaseGraphComponent

Parameters:

series - Any integer.

group - Any integer.

Returns:

true if successful, false if not.

getHorizontalAlignment

public int getHorizontalAlignment()

Retrieves the horizontal alignment for the text within the rectangle of the tick label. The constants are SwingConstants.LEFT, SwingConstants.CENTER, and SwingConstants.RIGHT. 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.

Automatic graph layout ignores this property. The doAutoLayout method sets this property.

Specified by:

getHorizontalAlignment in interface HorizontalAlignment

Returns:

A SwingConstant value that represents the horizontal alignment for the text of this tick label.

See Also:

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

setHorizontalAlignment

public void setHorizontalAlignment(int a)

Specifies the horizontal alignment of 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.

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

Automatic graph layout ignores this property. The doAutoLayout method sets this property.

Specified by:

setHorizontalAlignment in interface HorizontalAlignment

Parameters:

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

getTextRotation

public int getTextRotation()

Retrieves the rotation of the text for all of the tick labels of this axis in the graph.

Automatic rotation respects this property.

Returns:

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

See Also:

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

setTextRotation

public void setTextRotation(int orient)

Specifies the rotation of the text for all of the tick labels of this axis in the graph.

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.

Parameters:

orient - A constant that represents the rotation of the text for all of the tick labels of this axis in the graph. Valid constants are listed in the See Also section. If you pass an invalid value, the graph logs a message with the registered error handler, and TextRotation retains its previous value.

See Also:

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

isTickLabelStaggered

public abstract boolean isTickLabelStaggered()

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

Returns:

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

See Also:

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

setTickLabelStaggered

public abstract void setTickLabelStaggered(boolean yesNo)

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

Parameters:

yesNo - true to stagger the tick labels, false to align the tick labels.

See Also:

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

isTextFittingAutomatic

public boolean isTextFittingAutomatic()

Indicates whether all of the this axis tick labels are automatically moved and resized relative to the size of the graph. The return value of this method takes effect only when the FontSizeAbsolute property is set to false. Automatic graph layout ignores this property.

Returns:

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

See Also:

BaseText.isFontSizeAbsolute()

setTextFittingAutomatic

public void setTextFittingAutomatic(boolean yesNo)

Specifies whether the tick labels are automatically moved and resized relative to the size of the graph. For example, if the range of data on the axis is relatively small, and you do not have many tick labels, then the tick labels probably fit fine. If the range of data increases so that there are many more tick labels, then the tick labels might need to be smaller in order to remain legible. The tick label size might also need to change when a user resizes the plot area. Setting TextFittingAutomatic to true instructs the graph to resize the tick labels when appropriate.

In order for this method to take effect, the FontSizeAbsolute property must be set to false.

Automatic graph layout ignores this property.

Parameters:

yesNo - true to have the tick labels automatically resized, false prevent resizing.

See Also:

BaseText.isFontSizeAbsolute(), BaseText.setFontSizeAbsolute(boolean)