oracle.dss.graph
Class BaseDataAxis

java.lang.Object
  oracle.dss.dataView.BaseComponentXML
      oracle.dss.graph.BaseGraphComponent
          oracle.dss.graph.BaseDataAxis

All Implemented Interfaces:

Formattable, ViewFormatCallback, Line, Visible, BaseViewFormatCallback

Direct Known Subclasses:

X1Axis, Y1Axis, Y2Axis

public abstract class BaseDataAxis
extends BaseGraphComponent
implements Visible, Line, Formattable, ViewFormatCallback

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

Field Summary

protected static java.lang.String	a_ascending
protected static java.lang.String	a_axisLocation
protected static java.lang.String	a_axisMaxLabelVisible
protected static java.lang.String	a_axisMinLabelVisible
protected static java.lang.String	a_minAutoMajorTickStep
protected int	m_id
protected oracle.dss.graph.pfj.draw.IdentObj	m_identObj2
protected oracle.dss.graph.pfj.draw.IdentObj	m_labelIdentObj
protected oracle.dss.graph.pfj.draw.IdentObj	m_majorGridIdentObj
protected oracle.dss.graph.pfj.draw.IdentObj	m_minorGridIdentObj
protected ViewFormat	m_viewFormat

Fields inherited from class oracle.dss.graph.BaseGraphComponent

a_assignedToY2, a_association, a_automaticRotation, a_axisAutoScaledFromZero, a_axisMaxAutoScaled, a_axisMaxValue, a_axisMinAutoScaled, a_axisMinValue, a_axisZoomMaxValue, a_axisZoomMinValue, a_backGround, a_borderStyle, a_borderTransparent, a_borderUsingDefaults, a_borderWidth, a_color, a_defaultAssignedToY2, a_defaultBorderColor, a_defaultBorderTransparent, a_defaultColor, a_defaultFitlineType, a_defaultLineWidth, a_defaultMarkerColor, a_defaultMarkerShape, a_defaultMarkerType, a_displayedInLegend, a_explicitEnd, a_explicitStart, a_fitlineType, a_focusFactor, a_group, a_height, a_high_value, a_horizontalAlignment, a_imageSource, a_isometricProjection, a_labelPosition, a_legendMarkersPerRow, a_legendOrientation, a_legendTextPosition, a_lightSourceX, a_lightSourceY, a_lightSourceZ, a_line_value, a_lineColor, a_lineIndex, a_lineStyle, a_lineWidth, a_location, a_logarithmicBase, a_low_value, a_majorTickStep, a_majorTickStepAutomatic, a_markerColor, a_markerShape, a_markerSize, a_markersPerRowAutomatic, a_markerTextAngleDefault, a_markerTextPlace, a_markerTextRadiusDefault, a_markerType, a_minorTickStep, a_minorTickStepType, a_mode, a_panX, a_panY, a_pieSliceExplode, a_quadrantLineCountX, a_quadrantLineCountY, a_quadrantLineValueX, a_quadrantLineValueY, a_rendered, a_rollover_behavior, a_scaledLogarithmic, a_series, a_sharePanelProperties, a_sizeX, a_sizeY, a_sizeZ, a_skippedWithLabels, a_squareRisers, a_text, a_textFittingAutomatic, a_textRotation, a_textType, a_thresholdMaxValue, a_thresholdMinValue, a_tickLabelSkipCount, a_tickLabelSkipFirst, a_tickLabelSkipMode, a_tickLabelStaggered, a_tickLabelWrapped, a_tickStyle, a_translationX, a_translationY, a_translationZ, a_transparent, a_type, a_verticalAlignment, a_viewerX, a_viewerY, a_viewerZ, a_visibility, a_visible, a_wallThickX, a_wallThickY, a_wallThickZ, a_width, a_wordWrapEnabled, a_x, a_xValue, a_y, a_yValue, a_yValueAssignment, a_zoomFactor, al_both, AL_BOTH, al_left, AL_LEFT, al_right, AL_RIGHT, ap_always, AP_ALWAYS, ap_never, AP_NEVER, ar_horiz_rotate_270, AR_HORIZ_ROTATE_270, ar_horiz_rotate_90, AR_HORIZ_ROTATE_90, ar_no_rotate, AR_NO_ROTATE, dy2_auto_assign, DY2_AUTO_ASSIGN, dy2_false, DY2_FALSE, dy2_true, DY2_TRUE, FP_LG_CHECK, FP_LG_CROSSHATCH, FP_LG_DIAG_UP_LT, FP_LG_DIAG_UP_RT, FP_LG_DIAMOND_CHECK, FP_LG_TRIANGLE_CHECK, FP_MAX, FP_SM_CHECK, FP_SM_CROSSHATCH, FP_SM_DIAG_UP_LT, FP_SM_DIAG_UP_RT, FP_SM_DIAMOND_CHECK, FP_SM_TRIANGLE_CHECK, fs_bold, FS_BOLD, fs_bold_italic_underline, FS_BOLD_ITALIC_UNDERLINE, fs_bold_underline, FS_BOLD_UNDERLINE, fs_italic, FS_ITALIC, fs_italic_bold, FS_ITALIC_BOLD, fs_italic_underline, FS_ITALIC_UNDERLINE, fs_plain, FS_PLAIN, fs_underline, FS_UNDERLINE, ft_color, FT_COLOR, ft_exponential, FT_EXPONENTIAL, ft_gradient, FT_GRADIENT, ft_linear, FT_LINEAR, ft_logarithmic, FT_LOGARITHMIC, ft_none, FT_NONE, FT_PATTERN, ft_texture, FT_TEXTURE, gd_diagonal_135, GD_DIAGONAL_135, gd_diagonal_45, GD_DIAGONAL_45, gd_down, GD_DOWN, gd_down_left, GD_DOWN_LEFT, gd_down_right, GD_DOWN_RIGHT, gd_left, GD_LEFT, gd_radial, GD_RADIAL, gd_radial_bottom_left, GD_RADIAL_BOTTOM_LEFT, gd_radial_bottom_right, GD_RADIAL_BOTTOM_RIGHT, gd_radial_top_left, GD_RADIAL_TOP_LEFT, gd_radial_top_right, GD_RADIAL_TOP_RIGHT, gd_right, GD_RIGHT, gd_up, GD_UP, gd_up_left, GD_UP_LEFT, gd_up_right, GD_UP_RIGHT, gs_automatic, GS_AUTOMATIC, gs_extended, GS_EXTENDED, gs_grid, GS_GRID, gs_in, GS_IN, gs_none, GS_NONE, gs_out, GS_OUT, gs_span, GS_SPAN, lap_bottom, LAP_BOTTOM, lap_left, LAP_LEFT, lap_right, LAP_RIGHT, lap_top, LAP_TOP, ld_percent, LD_PERCENT, ld_text, LD_TEXT, ld_text_percent, LD_TEXT_PERCENT, ld_value, LD_VALUE, LEGENDMARKERSLIMIT, lo_automatic, LO_AUTOMATIC, lo_horizontal, LO_HORIZONTAL, lo_vertical, LO_VERTICAL, lp_inside, LP_INSIDE, lp_no_labels, LP_NO_LABELS, lp_outside_feeler_if_needed, LP_OUTSIDE_FEELER_IF_NEEDED, lp_outside_with_feeler, LP_OUTSIDE_WITH_FEELER, lp_outside_without_feeler, LP_OUTSIDE_WITHOUT_FEELER, ls_dash, LS_DASH, ls_dash_dot, LS_DASH_DOT, ls_dotted, LS_DOTTED, ls_solid, LS_SOLID, ltp_above, LTP_ABOVE, ltp_below, LTP_BELOW, ltp_on_left, LTP_ON_LEFT, ltp_on_marker, LTP_ON_MARKER, ltp_on_right, LTP_ON_RIGHT, m_commonGraph, m_identObj, m_pfj, ms_automatic, MS_AUTOMATIC, ms_circle, MS_CIRCLE, ms_diamond, MS_DIAMOND, ms_human, MS_HUMAN, ms_none, MS_NONE, ms_plus, MS_PLUS, ms_square, MS_SQUARE, ms_triangle_down, MS_TRIANGLE_DOWN, ms_triangle_up, MS_TRIANGLE_UP, mt_area, MT_AREA, mt_bar, MT_BAR, mt_centered_stepped_line, MT_CENTERED_STEPPED_LINE, MT_CURVE_AREA, mt_curve_line, MT_CURVE_LINE, mt_default, MT_DEFAULT, mt_marker, MT_MARKER, mt_stepped_line, MT_STEPPED_LINE, mtp_center, MTP_CENTER, mtp_custom, MTP_CUSTOM, mtp_inside_max, MTP_INSIDE_MAX, mtp_inside_min, MTP_INSIDE_MIN, mtp_on_maxedge, MTP_ON_MAXEDGE, mtp_outside_max, MTP_OUTSIDE_MAX, QUADRANTLINEVALUELIMIT, ro_area, RO_AREA, ro_back, RO_BACK, ro_front, RO_FRONT, ro_line, RO_LINE, sv_hidden, SV_HIDDEN, sv_visible, SV_VISIBLE, tdm_stretched, TDM_STRETCHED, tdm_tiled, TDM_TILED, tls_automatic, TLS_AUTOMATIC, tls_manual, TLS_MANUAL, tls_noskip, TLS_NOSKIP, tr_horiz, TR_HORIZ, tr_horiz_rotate_270, TR_HORIZ_ROTATE_270, tr_horiz_rotate_90, TR_HORIZ_ROTATE_90, tsm_explicit, TSM_EXPLICIT, tsm_off, TSM_OFF, va_bottom, va_center, va_top, VF_PIE_SLICE_LABEL, VF_STOCK_VOLUME, VF_X1, VF_Y1, VF_Y2, VF_Z

Fields inherited from class oracle.dss.dataView.BaseComponentXML

m_jsfHashMap

Constructor Summary

BaseDataAxis(CommonGraph graph)

Method Summary

protected int	convertAxisLocationToInt(java.lang.String str)
protected java.lang.String	convertAxisLocationToString(int loc)
void	formatChanged(int attributeId, java.lang.String attributeName, java.lang.Object oldValue, java.lang.Object newValue)
abstract double	getAutoMajorTickStep()
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.
abstract double	getAxisZoomMaxValue() Retrieves the high value for the range that the axis can zoom to, when the high value is not set automatically.
abstract double	getAxisZoomMinValue() Retrieves the low value for the range that the axis can zoom to, 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.
static DataEndPoints	getDataEndPoints(CommonGraph graph, int id)
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.
protected boolean	getMajorTickStepXML(boolean allProperties, oracle.dss.util.xml.ObjectNode node)
double	getMinAutoMajorTickStep() Retrieves the minimum tick step that can be set automically for the major tick mark of this axis.
double	getMinorTickStep() Retrieves the number of tick marks that the graph hides between tick marks that are displayed on this data axis.
GraphConstants.MinorGridStepType	getMinorTickStepType() Indicates whether the number of minor tick marks that the graph hides between tick marks that are displayed is calculated automatically.
protected boolean	getMinorTickStepXML(boolean allProperties, oracle.dss.util.xml.ObjectNode node)
boolean	getNonstyleXML(boolean allProperties, oracle.dss.util.xml.ObjectNode node) Retrieves Non style properties of this component to XML returns whether if the node exists
boolean	getStyleXML(boolean allProperties, oracle.dss.util.xml.ObjectNode node)
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.
protected void	resetStyle()
void	resetToDefault()
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.
abstract void	setAxisZoomMaxValue(double value) Specifies the high value for the range that the axis can zoom to, when the high value is not set automatically.
abstract void	setAxisZoomMinValue(double value) Specifies the low value for the range that the axis can zoom to, 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.
protected void	setMajorTickStepXML(oracle.dss.util.xml.ObjectNode node)
void	setMinAutoMajorTickStep(double value) Specifies the minimum value for the major tickstep.
void	setMinorTickStep(double value) Specifies the number of tick marks that the graph hides between tick marks that are displayed on this data axis.
void	setMinorTickStepType(GraphConstants.MinorGridStepType mgst) Specifies whether the number of minor tick marks that the graph hides between tick marks that are displayed is calculated automatically.
protected void	setMinorTickStepXML(oracle.dss.util.xml.ObjectNode node)
void	setNonstyleXML(oracle.dss.util.xml.ObjectNode node, java.lang.String version, int reset)
void	setScaledLogarithmic(boolean yesNo) Specifies whether this data axis is scaled logarithmically.
void	setStyleXML(oracle.dss.util.xml.ObjectNode node)
void	setViewFormat(ViewFormat viewFormat) Specifies a ViewFormat object for this data axis.
void	setVisible(boolean visible) Specifies whether this data axis is visible.

Methods inherited from class oracle.dss.graph.BaseGraphComponent

convertAssociationToInt, convertFillPatternToString, convertGradientDirectionToString, convertHorizontalAlignmentToInt, convertHorizontalAlignmentToString, convertLineStyleToInt, convertLineStyleToString, convertLocationToInt, convertTextRotationtToInt, convertTickStyleToInt, convertTypeToInt, hexStringToInt, toHexString

Methods inherited from class oracle.dss.dataView.BaseComponentXML

getComponentName, getStyleXML, getXML, setNonstyleXML, setXML, setXML, setXML, setXML

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

m_identObj2

protected oracle.dss.graph.pfj.draw.IdentObj m_identObj2

For internal use only. Application developers should not use this

m_majorGridIdentObj

protected oracle.dss.graph.pfj.draw.IdentObj m_majorGridIdentObj

For internal use only. Application developers should not use this

m_minorGridIdentObj

protected oracle.dss.graph.pfj.draw.IdentObj m_minorGridIdentObj

For internal use only. Application developers should not use this

m_labelIdentObj

protected oracle.dss.graph.pfj.draw.IdentObj m_labelIdentObj

For internal use only. Application developers should not use this

m_viewFormat

protected ViewFormat m_viewFormat

For internal use only. Application developers should not use this

m_id

protected int m_id

For internal use only. Application developers should not use this

a_axisMaxLabelVisible

protected static final java.lang.String a_axisMaxLabelVisible

See Also:

Constant Field Values

For internal use only. Application developers should not use this

a_axisMinLabelVisible

protected static final java.lang.String a_axisMinLabelVisible

See Also:

Constant Field Values

For internal use only. Application developers should not use this

a_ascending

protected static final java.lang.String a_ascending

See Also:

Constant Field Values

For internal use only. Application developers should not use this

a_axisLocation

protected static final java.lang.String a_axisLocation

See Also:

Constant Field Values

For internal use only. Application developers should not use this

a_minAutoMajorTickStep

protected static final java.lang.String a_minAutoMajorTickStep

See Also:

Constant Field Values

For internal use only. Application developers should not use this

Constructor Detail

BaseDataAxis

public BaseDataAxis(CommonGraph graph)

Parameters:

graph - The graph that this object belongs to.

For internal use only. Application developers should not use this

Constructor. Application developers should not have to construct this object, because the graph does it automatically.

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.

resetToDefault

public void resetToDefault()

For internal use only. Application developers should not use this

Resets to default values.

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:

yesNo - 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)

getAxisZoomMaxValue

public abstract double getAxisZoomMaxValue()

Retrieves the high value for the range that the axis can zoom to, 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 zoom axis, when the high value is not set automatically.

setAxisZoomMaxValue

public abstract void setAxisZoomMaxValue(double value)

Specifies the high value for the range that the axis can zoom to, 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 zoom axis, when the high value is not set automatically.

getAxisZoomMinValue

public abstract double getAxisZoomMinValue()

Retrieves the low value for the range that the axis can zoom to, 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 zoom axis, when the low value is not set automatically.

setAxisZoomMinValue

public abstract void setAxisZoomMinValue(double value)

Specifies the low value for the range that the axis can zoom to, 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 zoom axis, when the low value is not set automatically.

getAutoMajorTickStep

public abstract double getAutoMajorTickStep()

Returns:

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

See Also:

setMajorTickStepAutomatic(boolean)

For internal use only. Application developers should not use this

Retrieves the tick step value for this axis that is automatically calculated by pfj based on a data source. This value may change only when a data source changes, or the maximum or minimum scale value on X1 axis changes.

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.

Specified by:

getLineColor in interface Line

Returns:

The color of this data axis.

setLineColor

public void setLineColor(java.awt.Color newColor)

Specifies the color of this data axis.

Specified by:

setLineColor in interface Line

Parameters:

newColor - The color of this data axis.

getLineWidth

public int getLineWidth()

Retrieves the width of this data axis in pixels.

Specified by:

getLineWidth in interface Line

Returns:

The width of this data axis in pixels.

setLineWidth

public void setLineWidth(int width)

Specifies the width of this data axis in pixels.

Specified by:

setLineWidth in interface Line

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)

getMinorTickStep

public double getMinorTickStep()

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 MinorTickStep 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 setMinorTickStepAutomatic method to false.

Returns:

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

See Also:

#setMinorTickStepAutomatic

setMinorTickStep

public void setMinorTickStep(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 MinorTickStep 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 setMinorTickStepAutomatic method to false.

Parameters:

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

See Also:

#setMinorTickStepAutomatic

getMinAutoMajorTickStep

public double getMinAutoMajorTickStep()

Retrieves the minimum tick step that can be set automically for the major tick mark of this axis. A value of 0 means that there is no minimum set.

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 the specified value or a multiple of 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, which specifies no minimimun tick step.

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:

viewFormat - ViewFormat object for this data axis.

formatChanged

public void formatChanged(int attributeId,
                          java.lang.String attributeName,
                          java.lang.Object oldValue,
                          java.lang.Object newValue)

Specified by:

formatChanged in interface BaseViewFormatCallback

Parameters:

attributeId - the static constant in ViewFormat that identifies the attribute

attributeName - the name of the attribute that changed

oldValue - the old value of the attribute

newValue - the new value of the attribute

For internal use only. Application developers should not use this

Notification that one or more attributes on the ViewFormat have changed.

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.

getDataEndPoints

public static DataEndPoints getDataEndPoints(CommonGraph graph,
                                             int id)

Returns:

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

For internal use only. Application developers should not use this

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

convertAxisLocationToString

protected java.lang.String convertAxisLocationToString(int loc)

For internal use only. Application developers should not use this

convert text Axis location int constants to string constants

convertAxisLocationToInt

protected int convertAxisLocationToInt(java.lang.String str)

For internal use only. Application developers should not use this

convert text axis location string constants to int constants

resetStyle

protected void resetStyle()

For internal use only. Application developers should not use this

reset style properties

getNonstyleXML

public boolean getNonstyleXML(boolean allProperties,
                              oracle.dss.util.xml.ObjectNode node)

Description copied from class: BaseComponentXML

Retrieves Non style properties of this component to XML returns whether if the node exists

Overrides:

getNonstyleXML in class BaseComponentXML

For internal use only. Application developers should not use this

Retrieves Non style properties of this component to XML returns whether if the node exists

getStyleXML

public boolean getStyleXML(boolean allProperties,
                           oracle.dss.util.xml.ObjectNode node)

Overrides:

getStyleXML in class BaseComponentXML

For internal use only. Application developers should not use this

Retrieves XML from this component returns whether if the style is overridden

setNonstyleXML

public void setNonstyleXML(oracle.dss.util.xml.ObjectNode node,
                           java.lang.String version,
                           int reset)

Overrides:

setNonstyleXML in class BaseComponentXML

For internal use only. Application developers should not use this

Sets Nonstyle properties of this Axis from XML

setStyleXML

public void setStyleXML(oracle.dss.util.xml.ObjectNode node)

Overrides:

setStyleXML in class BaseComponentXML

For internal use only. Application developers should not use this

Sets Style properties of this Axis from XML

setMajorTickStepXML

protected void setMajorTickStepXML(oracle.dss.util.xml.ObjectNode node)

For internal use only. Application developers should not use this

Sets MajorTickStep property of this Axis from XML Note: Y2Axis sets both MajorTickStep and ParetoMajorTickStep properties.

setMinorTickStepXML

protected void setMinorTickStepXML(oracle.dss.util.xml.ObjectNode node)

For internal use only. Application developers should not use this

Sets MinorTickStep property of this Axis from XML Note: Y2Axis sets both MinorTickStep and ParetoMinorTickStep properties.

getMajorTickStepXML

protected boolean getMajorTickStepXML(boolean allProperties,
                                      oracle.dss.util.xml.ObjectNode node)

For internal use only. Application developers should not use this

Adds MajorTickStep property of this Axis to XML Note: Y2Axis adds both MajorTickStep and ParetoMajorTickStep properties to XML

getMinorTickStepXML

protected boolean getMinorTickStepXML(boolean allProperties,
                                      oracle.dss.util.xml.ObjectNode node)

For internal use only. Application developers should not use this

Adds MinorTickStep property of this Axis to XML Note: Y2Axis adds both MinorTickStep and ParetoMinorTickStep properties to XML

getMinorTickStepType

public GraphConstants.MinorGridStepType getMinorTickStepType()

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

Returns:

GraphConstants.MinorGridStepType.AUTO if the number is calculated automatically, GraphConstants.MinorGridStepType.ABSOLUTE if the minor ticks have increment value relative to the axis which is set in setMinorTickStep method. GraphConstants.MinorGridStepType.RELATIVE if the minor ticks have increment value relative to the major ticks which is set in setMinorTickStep method.

setMinorTickStepType

public void setMinorTickStepType(GraphConstants.MinorGridStepType mgst)

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

Parameters:

mgst - GraphConstants.MinorGridStepType.AUTO to make the graph calculate it automatically, GraphConstants.MinorGridStepType.ABSOLUTE to make the graph use the increment value that is set in the setMinorTickStep method relative to the axis. GraphConstants.MinorGridStepType.RELATIVE to make the graph use the increment value that is set in the setMinorTickStep method relative to the major ticks.