oracle.dss.graph
Class SliceLabel

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

All Implemented Interfaces:

DataviewFontAttribute, FontAttribute, Formattable, Visible

public class SliceLabel

extends BaseText

implements Visible, FontAttribute, Formattable, DataviewFontAttribute

Describes a slice of a pie in a pie or ring graph. Each slice represents a data value.

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	getTextRotation() Retrieves the rotation for the rectangle of this label.
int	getTextType() Retrieves a text type for this label.
ViewFormat	getViewFormat() Retrieves a ViewFormat object for this label.
boolean	isVisible() Indicates whether slice labels appear in the graph.
boolean	selectObject(int series, int group) Selects the label for an individual slice.
void	setTextRotation(int rotate) Specifies the rotation of rectangle of this label.
void	setTextType(int i) Specifies a text type of this label.
void	setViewFormat(ViewFormat viewFormat) Specifies a ViewFormat object for this label.
void	setVisible(boolean yesNo) Specifies whether slice labels appear in the graph.

Methods inherited from class oracle.dss.graph.BaseText

getDataviewFont, getFont, getGraphFont, isFontSizeAbsolute, setFont, setFontSizeAbsolute

Methods inherited from interface oracle.dss.dataView.FontAttribute

getFont, setFont

Methods inherited from interface oracle.dss.dataView.DataviewFontAttribute

getDataviewFont

Method Detail

selectObject

public boolean selectObject(int series,
                            int group)

Selects the label for an individual slice.

Overrides:

selectObject in class BaseGraphComponent

Parameters:

series - The series of the slice label that you want to select.

group - The group of the slice label that you want to select.

Returns:

true if successful, false if not.

getTextType

public int getTextType()

Retrieves a text type for this label. Text type represents the kind of information that this label displays such as value or percent value. The constants are listed in the See Also section.

Returns:

A constant that represents a text type for this label.

See Also:

BaseGraphComponent.LD_TEXT, BaseGraphComponent.LD_VALUE, BaseGraphComponent.LD_PERCENT, BaseGraphComponent.LD_TEXT_PERCENT

setTextType

public void setTextType(int i)

Specifies a text type of this label. Text type represents the kind of information that this label displays such as value or percent value. The constants are listed in the See Also section.

Parameters:

i - A constant that represents a text type of this label.

See Also:

BaseGraphComponent.LD_TEXT, BaseGraphComponent.LD_VALUE, BaseGraphComponent.LD_PERCENT, BaseGraphComponent.LD_TEXT_PERCENT

getTextRotation

public int getTextRotation()

Retrieves the rotation for the rectangle of this label. The constants are listed in the See Also section.

Returns:

A constant that represents the rotation for the rectangle of this label.

See Also:

BaseGraphComponent.TR_HORIZ, BaseGraphComponent.TR_HORIZ_ROTATE_90, BaseGraphComponent.TR_HORIZ_ROTATE_270

setTextRotation

public void setTextRotation(int rotate)

Specifies the rotation of rectangle of this label. The constants are listed in the See Also section.

Parameters:

rotate - A constant that represents the rotation of the rectangle of this label. 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

getViewFormat

public ViewFormat getViewFormat()

Retrieves a ViewFormat object for this label. The ViewFormat objects allow you to format numbers.

Specified by:

getViewFormat in interface Formattable

Returns:

A ViewFormat object for this label.

setViewFormat

public void setViewFormat(ViewFormat viewFormat)

Specifies a ViewFormat object for this label. The ViewFormat objects allow you to format numbers.

Specified by:

setViewFormat in interface Formattable

Parameters:

viewFormat - A ViewFormat object for this label.

isVisible

public boolean isVisible()

Indicates whether slice labels appear in the graph.

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 slice labels appear in the graph. Setting the Visible property to false has the same effect as setting the LabelPosition property of the Slice to BaseGraphComponent.LP_NO_LABELS.

Specified by:

setVisible in interface Visible

Parameters:

yesNo - true to display slice labels, false to hide them.

See Also:

Slice.setLabelPosition(int), BaseGraphComponent.LP_NO_LABELS