oracle.dss.graph
Class BaseTitle

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

All Implemented Interfaces:

DataviewFontAttribute, FontAttribute, Visible

Direct Known Subclasses:

GraphBaseTitle

public abstract class BaseTitle

extends BaseText

implements Visible

The abstract base class for the Graph title components.

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 title.
java.lang.String	getText() Retrieves the text for the title.
int	getTextRotation() Retrieves the angle of rotation for the text within the rectangle of the title.
java.lang.String	getUnParseText() Retrieves the unparsed text for the title.
boolean	isVisible() Indicates whether the title is visible.
boolean	selectObject(int series, int group) Selects the title in the graph.
void	setHorizontalAlignment(int a) Specifies the horizontal alignment of the text within the rectangle of the title.
void	setText(java.lang.String str) Specifies the text for the title.
void	setTextRotation(int rotate) Specifies the angle of rotation for the text within the rectangle of the title.
void	setVisible(boolean yesNo) Specifies whether the title is visible.

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 the title in the graph. Because the title does not represent data, parameter values are irrelevent.

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 title. 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 layout and doAutoLayout change the size of the rectangles for the GraphTitle, GraphSubtitle, and GraphFootnote so that they are just big enough for the text. Automatic layout and doAutoLayout then align the titles with the graph, based on the value of this property.

Returns:

A swing constant that represents the horozontal alignment for the text of this title.

setHorizontalAlignment

public void setHorizontalAlignment(int a)

Specifies the horizontal alignment of the text within the rectangle of the title. 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 layout and doAutoLayout change the size of the rectangles for the GraphTitle, GraphSubtitle, and GraphFootnote so that they are just big enough for the text. Automatic layout and doAutoLayout then align the titles with the graph, based on the value of this property.

Parameters:

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

getText

public java.lang.String getText()

Retrieves the text for the title.

Returns:

The text for the title.

getUnParseText

public java.lang.String getUnParseText()

Retrieves the unparsed text for the title. Unparsed text is text with variable names instead of variable definitions.

Returns:

The unparsed text for the title.

setText

public void setText(java.lang.String str)

Specifies the text for the title. When you specify text for a title, the Visible property of the title is automatically set to true.

If you use token substitution, pass a key string to this method, not a token string.

Parameters:

str - The text of this title.

See Also:

TokenSubstitution.getKeyString(java.lang.String)

getTextRotation

public int getTextRotation()

Retrieves the angle of rotation for the text within the rectangle of the title. The constants begin with TR_HORIZ.

Returns:

A constant that represents the angle of rotation for the text within the rectangle of the title.

setTextRotation

public void setTextRotation(int rotate)

Specifies the angle of rotation for the text within the rectangle of the title. The constants begin with TR_HORIZ.

Parameters:

rotate - A constant that represents the angle of rotation of the text within the rectangle of the title. When you pass an invalid value, the graph does not set the TextRotation attibute. It logs a message with the error handler.

isVisible

public boolean isVisible()

Indicates whether the title is visible.

Specified by:

isVisible in interface Visible

Returns:

true if it is visible, false if it is invisible.

setVisible

public void setVisible(boolean yesNo)

Specifies whether the title is visible.

Specified by:

setVisible in interface Visible

Parameters:

yesNo - true to make it visible, false to make it invisible.