oracle.adf.view.faces.bi.component.graph

Class BaseDataAxis

java.lang.Object

oracle.adf.view.faces.bi.component.BIComplexAttributeBase

oracle.adf.view.faces.bi.component.graph.BaseAxis

oracle.adf.view.faces.bi.component.graph.BaseDataAxis

All Implemented Interfaces:

javax.faces.component.StateHolder

Direct Known Subclasses:

X1Axis, Y1Axis, Y2Axis

public class BaseDataAxis
extends BaseAxis

Base class for data axes in a graph.

Since:

11.0

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.myfaces.trinidad.bean.PropertyKey	AXIS_MAX_AUTO_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	AXIS_MAX_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	AXIS_MIN_AUTO_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	AXIS_MIN_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	AXIS_ZOOM_MAX_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	AXIS_ZOOM_MIN_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	LOG_BASE_KEY
protected double	m_axisLogBase
protected boolean	m_axisMaxAutoScaled
protected boolean	m_axisMinAutoScaled
protected boolean	m_axisScaledLogarithmic
protected boolean	m_axisTickAuto
static org.apache.myfaces.trinidad.bean.PropertyKey	MAJOR_INCREMENT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	MAJOR_TICK_STEP_AUTO_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	MAJOR_TICK_STEP_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	MINOR_INCREMENT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	NUMBER_FORMAT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SCALED_LOG_KEY
static org.apache.myfaces.trinidad.bean.FacesBean.Type	TYPE

Fields inherited from class oracle.adf.view.faces.bi.component.graph.BaseAxis

LINE_COLOR_KEY, LINE_WIDTH_KEY, m_axisLineColor, m_axisLineWidth, m_rendered, RENDERED_KEY, SCROLLING_KEY, SCROLLING_KEY_NAME

Fields inherited from class oracle.adf.view.faces.bi.component.BIComplexAttributeBase

ID_KEY, m_parent, TRANSIENT_KEY

Constructor Summary

Constructors

Constructor and Description
BaseDataAxis()

Method Summary

Methods

Modifier and Type	Method and Description
void	applyProperties(java.util.HashMap map) Applications should not call this method.
double	getAxisMaxValue() Retrieves the high value for the range of this axis, when the high value is not set automatically.
double	getAxisMinValue() Retrieves the low value for the range of this axis, when the low value is not set automatically.
double	getAxisZoomMaxValue() Retrieves the high value for the range that the axis can zoom to, when the high value is not set automatically.
double	getAxisZoomMinValue() Retrieves the low value for the range that the axis can zoom to, when the low value is not set automatically.
protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
double	getLogarithmicBase() Retrieves a logarithmic or linear scale for this data axis.
double	getMajorIncrement() Retrieves the increment between major tick marks.
double	getMajorTickStep() Deprecated. Use majorIncrement APIs
double	getMinorIncrement() Retrieves the increment between minor tick marks.
NumberFormat	getNumberFormat() Deprecated. Use getConverter in the associated tick label Gets the number format
boolean	isAxisMaxAutoScaled() Indicates whether the graph automatically sets the high value for this axis.
boolean	isAxisMinAutoScaled() Indicates whether the graph automatically sets the minimum value for this axis.
boolean	isMajorTickStepAutomatic() Deprecated. Use majorIncrement APIs
boolean	isScaledLogarithmic() Indicates whether this data axis is scaled logarithmically.
protected void	resetStyleProperties()
void	setAxisMaxAutoScaled(boolean auto) Specifies whether the graph automatically sets the high value for this axis.
void	setAxisMaxValue(double value) Specifies the high value for the range of this axis, when the high value is not set automatically.
void	setAxisMinAutoScaled(boolean auto) Specifies whether the graph automatically sets the the minimum value for this axis.
void	setAxisMinValue(double value) Specifies the low value for the range of this axis, when the low value is not set automatically.
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.
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	setLogarithmicBase(double value) Selects a logarithmic or linear scale for this data axis.
void	setMajorIncrement(double value) Specifies the increment between major tick marks.
void	setMajorTickStep(double value) Deprecated. Use majorIncrement APIs
void	setMajorTickStepAutomatic(boolean auto) Deprecated. Use majorIncrement APIs
void	setMinorIncrement(double value) Specifies the increment between minor tick marks.
void	setNumberFormat(NumberFormat format) Deprecated. Use setConverter in the associated tick label Sets the number format
void	setScaledLogarithmic(boolean logScale) Specifies whether this data axis is scaled logarithmically.

Methods inherited from class oracle.adf.view.faces.bi.component.graph.BaseAxis

getLineColor, getLineWidth, getScrolling, isRendered, setLineColor, setLineWidth, setRendered, setScrolling

Methods inherited from class oracle.adf.view.faces.bi.component.BIComplexAttributeBase

getBooleanProperty, getFacesBean, getId, getParent, getProperty, getPropertyKey, getSetAttributeIndex, isTransient, isUpdated, processSetAttribute, processSetAttributeAndAdd, registerAttachedObjectKey, restoreState, saveState, setBooleanProperty, setId, setParent, setProperty, setTransient, setUpdated

Methods inherited from class java.lang.Object

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

Field Detail

m_axisMinAutoScaled

protected boolean m_axisMinAutoScaled

m_axisMaxAutoScaled

protected boolean m_axisMaxAutoScaled

m_axisTickAuto

protected boolean m_axisTickAuto

m_axisLogBase

protected double m_axisLogBase

m_axisScaledLogarithmic

protected boolean m_axisScaledLogarithmic

TYPE

public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE

MAJOR_TICK_STEP_AUTO_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey MAJOR_TICK_STEP_AUTO_KEY

MAJOR_TICK_STEP_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey MAJOR_TICK_STEP_KEY

MAJOR_INCREMENT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey MAJOR_INCREMENT_KEY

MINOR_INCREMENT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey MINOR_INCREMENT_KEY

AXIS_MAX_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey AXIS_MAX_KEY

AXIS_MAX_AUTO_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey AXIS_MAX_AUTO_KEY

AXIS_ZOOM_MAX_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey AXIS_ZOOM_MAX_KEY

AXIS_MIN_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey AXIS_MIN_KEY

AXIS_MIN_AUTO_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey AXIS_MIN_AUTO_KEY

AXIS_ZOOM_MIN_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey AXIS_ZOOM_MIN_KEY

LOG_BASE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey LOG_BASE_KEY

SCALED_LOG_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SCALED_LOG_KEY

NUMBER_FORMAT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey NUMBER_FORMAT_KEY

Constructor Detail

BaseDataAxis

public BaseDataAxis()

Method Detail

isMajorTickStepAutomatic

@Deprecated
public boolean isMajorTickStepAutomatic()

Deprecated. Use majorIncrement APIs

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

@Deprecated
public void setMajorTickStepAutomatic(boolean auto)

Deprecated. Use majorIncrement APIs

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

Parameters:

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

getMajorTickStep

@Deprecated
public double getMajorTickStep()

Deprecated. Use majorIncrement APIs

Retrieves the increment between major tick marks. 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

@Deprecated
public void setMajorTickStep(double value)

Deprecated. Use majorIncrement APIs

Specifies the increment between major tick marks. 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)

getMajorIncrement

public double getMajorIncrement()

Retrieves the increment between major tick marks. For example, if you set MajorTickStep to 10, then the tick marks appear at 0, 10, 20, 30, and so on.

Returns:

the increment between major tick marks.

setMajorIncrement

public void setMajorIncrement(double value)

Specifies the increment between major tick marks. For example, if you set MajorTickStep to 10, then the tick marks appear at 0, 10, 20, 30, and so on. Setting this attribute will apply majorTickStepAutomatic to false.

Parameters:

the - increment between major tick marks.

getMinorIncrement

public double getMinorIncrement()

Retrieves the increment between minor tick marks. For example, if you set MinorIncrement to 5 and MajorTickStep to 10, then the tick marks appear at 0, 5, 15, 25, and so on.

Returns:

the increment between minor tick marks.

setMinorIncrement

public void setMinorIncrement(double value)

Specifies the increment between minor tick marks. For example, if you set MinorIncrement to 5 and MajorTickStep to 10, then the tick marks appear at 0, 5, 15, 25, and so on.

Parameters:

value - the increment between minor tick marks.

getAxisMaxValue

public double getAxisMaxValue()

Retrieves the high value for the range of this 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 axis, when the high value is not set automatically.

setAxisMaxValue

public void setAxisMaxValue(double value)

Specifies the high value for the range of this 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 axis, when the high value is not set automatically.

isAxisMaxAutoScaled

public boolean isAxisMaxAutoScaled()

Indicates whether the graph automatically sets the high value for this 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.

setAxisMaxAutoScaled

public void setAxisMaxAutoScaled(boolean auto)

Specifies whether the graph automatically sets the high value for this axis. When you set this method to false, the graph uses the value that is set in the setAxisMaxValue method.

Parameters:

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

getAxisZoomMaxValue

public 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 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.

getAxisMinValue

public double getAxisMinValue()

Retrieves the low value for the range of this 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 axis, when the low value is not set automatically.

setAxisMinValue

public void setAxisMinValue(double value)

Specifies the low value for the range of this 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 axis, when the low value is not set automatically.

isAxisMinAutoScaled

public boolean isAxisMinAutoScaled()

Indicates whether the graph automatically sets the minimum value for this 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.

setAxisMinAutoScaled

public void setAxisMinAutoScaled(boolean auto)

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

getAxisZoomMinValue

public 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 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.

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

Specifies whether this data axis is scaled logarithmically.

Parameters:

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

applyProperties

public void applyProperties(java.util.HashMap map)

Applications should not call this method.

Overrides:

applyProperties in class BIComplexAttributeBase

Parameters:

map -

resetStyleProperties

protected void resetStyleProperties()

Overrides:

resetStyleProperties in class BaseAxis

getNumberFormat

@Deprecated
public NumberFormat getNumberFormat()

Deprecated. Use getConverter in the associated tick label Gets the number format

Returns:

the number foramt

setNumberFormat

@Deprecated
public void setNumberFormat(NumberFormat format)

Deprecated. Use setConverter in the associated tick label Sets the number format

Parameters:

format - the number format

getBeanType

protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()

Overrides:

getBeanType in class BaseAxis