oracle.dss.graph
Class BaseDataAxis

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

All Implemented Interfaces:

Formattable, Visible

Direct Known Subclasses:

X1Axis, Y1Axis, Y2Axis

public abstract class BaseDataAxis

extends BaseGraphComponent

implements Visible, Formattable

The base class for data axes of the graph. A data axis is an axis for numeric data.

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	getAxisLocation() Retrieves the location of this data axis in the graph.
abstract double	getAxisMaxAutoValue() Retrieves the high value of the automatic range for this data axis.
abstract double	getAxisMaxValue() Retrieves the high value for the range of this data axis, when the high value is not set automatically.
abstract double	getAxisMinAutoValue() Retrieves the low value for the automatic range of this data axis.
abstract double	getAxisMinValue() Retrieves the low value for the range of this data axis, when the low value is not set automatically.
DataEndPoints	getDataEndPoints() Retrieves the DataEndPoints object that identifies the maximum and minimum values of the data that is displayed for this axis.
java.awt.Color	getLineColor() Retrieves the color of this data axis.
int	getLineWidth() Retrieves the width of this data axis in pixels.
double	getLogarithmicBase() Retrieves a logarithmic or linear scale for this data axis.
double	getMajorTickStep() Retrieves the number of tick marks that the graph hides between tick marks that are displayed on this data axis.
double	getMinAutoMajorTickStep() Retrieves the minimum tick step that can be set automically for the major tick mark of this axis.
ViewFormat	getViewFormat() Retrieves a ViewFormat object for this data axis.
boolean	isAscending() Indicates whether the axis is drawn in ascending or descending order.
abstract boolean	isAxisAutoScaledFromZero() Indicates whether the automatic range on this data axis begins with zero.
abstract boolean	isAxisMaxAutoScaled() Indicates whether the graph automatically sets the high value for this data axis.
boolean	isAxisMaxLabelVisible() Indicates whether the maximum label appears on this axis.
abstract boolean	isAxisMinAutoScaled() Indicates whether the graph automatically sets the minimum value for this data axis.
boolean	isAxisMinLabelVisible() Indicates whether the minimum label appears on this axis.
boolean	isMajorTickStepAutomatic() Indicates whether the number of tick marks that the graph hides between tick marks that are displayed is calculated automatically.
boolean	isScaledLogarithmic() Indicates whether this data axis is scaled logarithmically.
boolean	isVisible() Indicates whether this data axis is visible.
boolean	selectObject(int series, int group) Selects this data axis in the graph.
void	setAscending(boolean yesNo) Specifies whether the axis will be drawn in ascending or descending order.
abstract void	setAxisAutoScaledFromZero(boolean yesNo) Specifies whether the automatic range on this data axis begins with zero.
void	setAxisLocation(int location) Specifies the location of this data axis in the graph.
abstract void	setAxisMaxAutoScaled(boolean yesNo) Specifies whether the graph automatically sets the high value for this data axis.
void	setAxisMaxLabelVisible(boolean visible) Specifies whether the maximum label appears on this axis.
abstract void	setAxisMaxValue(double value) Specifies the high value for the range of this data axis, when the high value is not set automatically.
abstract void	setAxisMinAutoScaled(boolean yesNo) Specifies whether the graph automatically sets the the minimum value for this data axis.
void	setAxisMinLabelVisible(boolean visible) Specifies whether the minimum label appears on this axis.
abstract void	setAxisMinValue(double value) Specifies the low value for the range of this data axis, when the low value is not set automatically.
void	setLineColor(java.awt.Color newColor) Specifies the color of this data axis.
void	setLineWidth(int width) Specifies the width of this data axis in pixels.
void	setLogarithmicBase(double value) Selects a logarithmic or linear scale for this data axis.
void	setMajorTickStep(double value) Specifies the number of tick marks that the graph hides between tick marks that are displayed on this data axis.
void	setMajorTickStepAutomatic(boolean yesNo) Specifies whether the number of tick marks that the graph hides between tick marks that are displayed is calculated automatically.
void	setMinAutoMajorTickStep(double value) Specifies the minimum value for the major tickstep.
void	setScaledLogarithmic(boolean yesNo) Specifies whether this data axis is scaled logarithmically.
void	setViewFormat(ViewFormat viewFormat) Specifies a ViewFormat object for this data axis.
void	setVisible(boolean visible) Specifies whether this data axis is visible.

Method Detail

selectObject

public boolean selectObject(int series,
                            int group)

Selects this data axis in the graph. Because the this data axis does 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.

setAscending

public void setAscending(boolean yesNo)

Specifies whether the axis will be drawn in ascending or descending order.

Parameters:

yesNo - true to draw it in ascending order, false to draw it in descending order.

isAscending

public boolean isAscending()

Indicates whether the axis is drawn in ascending or descending order.

Returns:

yesNo true if it is drawn in ascending order, false if it is drawn in descending order.

isAxisAutoScaledFromZero

public abstract boolean isAxisAutoScaledFromZero()

Indicates whether the automatic range on this data axis begins with zero.

Returns:

true if it begins with zero, false if it begins with the lowest data value on the axis.

setAxisAutoScaledFromZero

public abstract void setAxisAutoScaledFromZero(boolean yesNo)

Specifies whether the automatic range on this data axis begins with zero.

Parameters:

yesNo - true to make it begin with zero, false to make it begin with the lowest data value on the axis.

isAxisMaxAutoScaled

public abstract boolean isAxisMaxAutoScaled()

Indicates whether the graph automatically sets the high value for this data axis. When this method returns false, the graph uses the value that is set in the setAxisMaxValue method.

Returns:

true if the high value is automatically set, false if the graph uses the value that is set in the setAxisMaxValue method.

See Also:

setAxisMaxValue(double)

setAxisMaxAutoScaled

public abstract void setAxisMaxAutoScaled(boolean yesNo)

Specifies whether the graph automatically sets the high value for this data axis. When the AxisMaxAutoScaled property is false, then the graph uses the value of the setAxisMaxValue property. When the AxisMaxAutoScaled property is true, then the graph calculates the maximum value and sets it as the value of both the AxisMaxValue property and the AxisMaxAutoValue property.

Parameters:

yesNo - true to make the graph set the high value automatically, false to make the graph use the value that is set in the setAxisMaxValuemethod.

See Also:

setAxisMaxValue(double)

isAxisMinAutoScaled

public abstract boolean isAxisMinAutoScaled()

Indicates whether the graph automatically sets the minimum value for this data axis. When this method is set to false, the graph uses the value that is set in the setAxisMinValue method.

Returns:

true if the minimum value is set automatically, false if the graph uses the value that is set in the setAxisMinValue method.

See Also:

setAxisMinValue(double)

setAxisMinAutoScaled

public abstract void setAxisMinAutoScaled(boolean yesNo)

Specifies whether the graph automatically sets the the minimum value for this data axis. When the AxisMinAutoScaled property is false, the graph uses the value of the AxisMinValue property. When the AxisMinAutoScaled property is true, then the graph calculates the minimum value and sets it as the value of both the AxisMinValue property and the AxisMinAutoValue property.

Parameters:

true - to make the graph set the minimum value automatically, false to make the graph use the value that is set in the setAxisMinValue method.

See Also:

setAxisMinValue(double)

getAxisMaxAutoValue

public abstract double getAxisMaxAutoValue()

Retrieves the high value of the automatic range for this data axis.

Returns:

The high value of the automatic range for this data axis.

getAxisMaxValue

public abstract double getAxisMaxValue()

Retrieves the high value for the range of this data axis, when the high value is not set automatically. To make the axis use the value that this method returns, set the setAxisMaxAutoScaled method to false.

Returns:

The high value for the range of this data axis, when the high value is not set automatically.

See Also:

setAxisMaxAutoScaled(boolean)

setAxisMaxValue

public abstract void setAxisMaxValue(double value)

Specifies the high value for the range of this data axis, when the high value is not set automatically. To make the axis use the parameter value that is passed by this method, set the setAxisMaxAutoScaled method to false.

Parameters:

value - The high value for the range of this data axis, when the high value is not set automatically.

See Also:

setAxisMaxAutoScaled(boolean)

getAxisMinAutoValue

public abstract double getAxisMinAutoValue()

Retrieves the low value for the automatic range of this data axis.

Returns:

The low value for the automatic range of this data axis.

getAxisMinValue

public abstract double getAxisMinValue()

Retrieves the low value for the range of this data axis, when the low value is not set automatically. To make the axis use the value that this method returns, set the setAxisMinAutoScaled method to false.

Returns:

The low value for the range of this data axis, when the low value is not set automatically.

See Also:

setAxisMinAutoScaled(boolean)

setAxisMinValue

public abstract void setAxisMinValue(double value)

Specifies the low value for the range of this data axis, when the low value is not set automatically. To make the axis use the parameter value that is passed by this method, set the setAxisMinAutoScaled method to false.

Parameters:

value - The low value for the range of this data axis, when the low value is not set automatically.

See Also:

setAxisMinAutoScaled(boolean)

getAxisLocation

public int getAxisLocation()

Retrieves the location of this data axis in the graph. The constants are defined in BaseGraphComponent and begin with AL_.

Returns:

A constant that represents the location of this data axis in the graph.

See Also:

BaseGraphComponent.AL_LEFT, BaseGraphComponent.AL_RIGHT, BaseGraphComponent.AL_BOTH

setAxisLocation

public void setAxisLocation(int location)

Specifies the location of this data axis in the graph. The constants are defined in BaseGrpahComponent and begin with AL_.

Parameters:

location - A constant that represents the location of this data axis in the graph. If you enter an invalid parameter value, then the graph logs an ErrorHandler message, and will not change the AxisLocation attribute.

See Also:

BaseGraphComponent.AL_LEFT, BaseGraphComponent.AL_RIGHT, BaseGraphComponent.AL_BOTH

isAxisMinLabelVisible

public boolean isAxisMinLabelVisible()

Indicates whether the minimum label appears on this axis.

Returns:

true if the minimum label appears on this axis, false if it does not.

setAxisMinLabelVisible

public void setAxisMinLabelVisible(boolean visible)

Specifies whether the minimum label appears on this axis.

Parameters:

visible - true to display the minimum label, false to hide it.

isAxisMaxLabelVisible

public boolean isAxisMaxLabelVisible()

Indicates whether the maximum label appears on this axis.

Returns:

true if the maximum label appears on this axis, false if it does not.

setAxisMaxLabelVisible

public void setAxisMaxLabelVisible(boolean visible)

Specifies whether the maximum label appears on this axis.

Parameters:

visible - true to display the maximum label, false to hide it.

getLineColor

public java.awt.Color getLineColor()

Retrieves the color of this data axis.

Returns:

The color of this data axis.

setLineColor

public void setLineColor(java.awt.Color newColor)

Specifies the color of this data axis.

Parameters:

newColor - The color of this data axis.

getLineWidth

public int getLineWidth()

Retrieves the width of this data axis in pixels.

Returns:

The width of this data axis in pixels.

setLineWidth

public void setLineWidth(int width)

Specifies the width of this data axis in pixels.

Parameters:

width - The width of this data axis in pixels.

getMajorTickStep

public double getMajorTickStep()

Retrieves the number of tick marks that the graph hides between tick marks that are displayed on this data axis. For example, if you set MajorTickStep to 10, then the tick marks appear at 0, 10, 20, 30, and so on. (This assumes that AxisAutoScaledFromZero and AxisMinAutoScaled are both set to true.)

To make the graph use the value that this method returns, set the setMajorTickStepAutomatic method to false.

Returns:

The interval (or step) at which to tick marks are displayed on this data axis.

See Also:

setMajorTickStepAutomatic(boolean)

setMajorTickStep

public void setMajorTickStep(double value)

Specifies the number of tick marks that the graph hides between tick marks that are displayed on this data axis. For example, if you set MajorTickStep to 10, then the tick marks appear at 0, 10, 20, 30, and so on. (This assumes that AxisAutoScaledFromZero and AxisMinAutoScaled are both set to true.)

To make the graph use the value that is set in this method, set the setMajorTickStepAutomatic method to false.

Parameters:

value - The interval (or step) at which to display tick marks on this data axis.

See Also:

setMajorTickStepAutomatic(boolean)

getMinAutoMajorTickStep

public double getMinAutoMajorTickStep()

Retrieves the minimum tick step that can be set automically for the major tick mark of this axis.

Returns:

The minimum value for the major tickstep.

setMinAutoMajorTickStep

public void setMinAutoMajorTickStep(double value)

Specifies the minimum value for the major tickstep. When the data axis is automatically scaled (when MajorTickStepAutomatic = true), then the automatically calculated tick step value will be greater than or equal to the specified value.

If the specified value is greater than the difference between minimum value and the maximum value for the axis, then this method ignores the MinAutoMajorTickStep value. The default value is 0.

Parameters:

value - The minimum value for the major tickstep.

See Also:

setMajorTickStepAutomatic(boolean)

isMajorTickStepAutomatic

public boolean isMajorTickStepAutomatic()

Indicates whether the number of tick marks that the graph hides between tick marks that are displayed is calculated automatically.

Returns:

true if the number is calculated automatically, false if it is set in the setMajorTickStep method.

See Also:

setMajorTickStep(double)

setMajorTickStepAutomatic

public void setMajorTickStepAutomatic(boolean yesNo)

Specifies whether the number of tick marks that the graph hides between tick marks that are displayed is calculated automatically.

Parameters:

yesNo - true to make the graph calculate it automatically, false to make the graph use the value that is set in the setMajorTickStep method.

See Also:

setMajorTickStep(double)

getViewFormat

public ViewFormat getViewFormat()

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

Specified by:

getViewFormat in interface Formattable

Returns:

A ViewFormat object for this data axis.

setViewFormat

public void setViewFormat(ViewFormat viewFormat)

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

Specified by:

setViewFormat in interface Formattable

Parameters:

A - ViewFormat object for this data axis.

getLogarithmicBase

public double getLogarithmicBase()

Retrieves a logarithmic or linear scale for this data axis.

Returns:

A logarithmic or linear scale for this data axis.

setLogarithmicBase

public void setLogarithmicBase(double value)

Selects a logarithmic or linear scale for this data axis.

Parameters:

value - A logarithmic or linear scale for this data axis.

isScaledLogarithmic

public boolean isScaledLogarithmic()

Indicates whether this data axis is scaled logarithmically.

Returns:

true if it is scaled logarithmically, false if it is not.

setScaledLogarithmic

public void setScaledLogarithmic(boolean yesNo)

Specifies whether this data axis is scaled logarithmically.

Parameters:

yesNo - true to scale it logarithmically, false to prohibit logarithmic scaling.

isVisible

public boolean isVisible()

Indicates whether this data axis is visible.

Specified by:

isVisible in interface Visible

Returns:

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

setVisible

public void setVisible(boolean visible)

Specifies whether this data axis is visible.

Specified by:

setVisible in interface Visible

Parameters:

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

getDataEndPoints

public DataEndPoints getDataEndPoints()

Retrieves the DataEndPoints object that identifies the maximum and minimum values of the data that is displayed for this axis.

Returns:

The DataEndPoints that has the maximum and minimum data values for the axis.