oracle.dss.graph
Class BaseReferenceLine

oracle.dss.graph.BaseGraphComponent
  |
  +--oracle.dss.graph.BaseReferenceLine

Direct Known Subclasses:

X1ReferenceLine, Y1ReferenceLine, Y2ReferenceLine

public abstract class BaseReferenceLine

extends BaseGraphComponent

The base class for reference lines of the graph. A single reference line object represents three lines along an axis. These lines highlight axis values that are of particular interest. For example, in a graph that plots medical test results, you might show reference lines for minimum and maximum acceptable values.

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

java.awt.Color	getLineColor(int index) Retrieves the color of the reference line.
int	getLineWidth(int index) Retrieves the width of the reference line in pixels.
java.lang.String	getText(int index) Retrieves the text for the reference line.
double	getValue(int index) Retrieves the value at which the reference line is displayed.
boolean	isDisplayedInLegend(int index) Indicates whether the reference line appears in the legend.
boolean	isVisible(int index) Indicates whether a reference line is visible.
boolean	selectObject(int series, int group) Selects the reference line on the graph.
void	setDisplayedInLegend(boolean visible, int index) Specifies whether to display the reference line in the legend.
void	setLineColor(java.awt.Color newColor, int index) Specifies the color of the reference line.
void	setLineWidth(int width, int index) Specifies the width of the reference line in pixels.
void	setText(java.lang.String str, int index) Specifies the text of the reference line.
void	setValue(double value, int index) Specifies the value at which the reference line is displayed.
void	setVisible(boolean visible, int index) Specifies whether to display a reference line.

Method Detail

selectObject

public boolean selectObject(int series,
                            int group)

Selects the reference line on the graph. Because references lines 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.

isDisplayedInLegend

public boolean isDisplayedInLegend(int index)

Indicates whether the reference line appears in the legend.

Parameters:

index - The index of the reference line. Valid values range from 0 to 2.

Returns:

true if the specified reference line appears in the legend, false if it does not.

setDisplayedInLegend

public void setDisplayedInLegend(boolean visible,
                                 int index)

Specifies whether to display the reference line in the legend.

Parameters:

visible - true to display the line in the legend, false to remove it from the legend.

index - The index of the reference line to display or remove. Valid values range from 0 to 2.

getLineColor

public java.awt.Color getLineColor(int index)

Retrieves the color of the reference line.

Parameters:

index - The index of the reference line whose color you want. Valid values range from 0 to 2.

Returns:

The color of the specified reference line.

setLineColor

public void setLineColor(java.awt.Color newColor,
                         int index)

Specifies the color of the reference line.

Parameters:

newColor - The color for the reference line.

index - The index of the reference line whose color to set. Valid values range from 0 to 2.

getLineWidth

public int getLineWidth(int index)

Retrieves the width of the reference line in pixels.

Parameters:

index - The index of the reference line whose width you want. Valid values range from 0 to 2.

Returns:

The width of the reference line in pixels.

setLineWidth

public void setLineWidth(int width,
                         int index)

Specifies the width of the reference line in pixels.

Parameters:

width - The width for the reference line in pixels.

index - The index of the reference line whose width to set. Valid values range from 0 to 2.

getText

public java.lang.String getText(int index)

Retrieves the text for the reference line.

Parameters:

index - The index of the reference line whose text you want. Valid values range from 0 to 2.

Returns:

The text for the reference line.

setText

public void setText(java.lang.String str,
                    int index)

Specifies the text of the reference line.

Parameters:

str - The text of the reference line.

index - The index of the reference line whose text to set. Valid values range from 0 to 2

getValue

public double getValue(int index)

Retrieves the value at which the reference line is displayed. The value is along the axis for this reference line.

Parameters:

index - The index of the reference line whose value you want. Valid values range from 0 to 2.

Returns:

The value at which the reference line is displayed along the axis.

setValue

public void setValue(double value,
                     int index)

Specifies the value at which the reference line is displayed. The reference line appears along its associated axis.

Parameters:

value - The value at which to display the reference line.

index - The index of the reference line whose value to set. Valid values range from 0 to 2.

isVisible

public boolean isVisible(int index)

Indicates whether a reference line is visible.

Parameters:

index - The index of the reference line whose visibility you want. Valid values range from 0 to 2.

Returns:

true if the specified reference line is visible, false if it is not.

setVisible

public void setVisible(boolean visible,
                       int index)

Specifies whether to display a reference line.

Parameters:

visible - true to display the reference line, false to hide it.

index - The index of the reference line to display or hide. Valid values range from 0 to 2.