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

Class BaseTick

java.lang.Object

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

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

All Implemented Interfaces:

javax.faces.component.StateHolder

Direct Known Subclasses:

BaseMajorTick, BaseMinorTick

public abstract class BaseTick
extends BIComplexAttributeBase

Base class for tick marks in a graph.

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.myfaces.trinidad.bean.PropertyKey	LINE_COLOR_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	LINE_STYLE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	LINE_WIDTH_KEY
protected java.awt.Color	m_defaultLineColor
protected int	m_defaultLineStyle
protected int	m_defaultLineWidth
protected int	m_defaultTickStyle
static org.apache.myfaces.trinidad.bean.PropertyKey	TICK_STYLE_KEY
static org.apache.myfaces.trinidad.bean.FacesBean.Type	TYPE

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

ID_KEY, m_parent, TRANSIENT_KEY

Constructor Summary

Constructors

Constructor and Description
BaseTick()

Method Summary

Modifier and Type	Method and Description
protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
java.awt.Color	getLineColor() Retrieves the color for the object.
int	getLineStyle() Retrieves the style of the line.
int	getLineWidth() Retrieves the width of the object in pixels.
int	getTickStyle() Retrieves the style of the axis tick marks.
protected void	resetStyleProperties()
void	setLineColor(java.awt.Color newColor) Specifies the color for the object.
void	setLineStyle(int style) Specifies the style of the line.
void	setLineStyle(java.lang.String style) Specifies the style for the major tick line.
void	setLineWidth(int width) Specifies the width of the object in pixels.
void	setTickStyle(int style) Specifies the style of the axis tick marks.
void	setTickStyle(java.lang.String style) Specifies the style of the axis tick marks.

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

applyProperties, 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_defaultLineColor

protected java.awt.Color m_defaultLineColor

m_defaultLineWidth

protected int m_defaultLineWidth

m_defaultLineStyle

protected int m_defaultLineStyle

m_defaultTickStyle

protected int m_defaultTickStyle

TYPE

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

TICK_STYLE_KEY

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

LINE_COLOR_KEY

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

LINE_WIDTH_KEY

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

LINE_STYLE_KEY

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

Constructor Detail

BaseTick

public BaseTick()

Method Detail

getTickStyle

public int getTickStyle()

Retrieves the style of the axis tick marks. The style of the tick marks is defined by the style of the axis grid that they belong to. The constants are defined by the BaseGraphComponent class and begin with GS_.

Returns:

A constant that represents the style of the axis tick marks.

setTickStyle

public void setTickStyle(int style)

Specifies the style of the axis tick marks. The style of the tick marks is defined by the style of the axis grid that they belong to. The constants are defined by the BaseGraphComponent class and begin with GS_.

Parameters:

style - A constant that represents the style of the axis tick marks. If you enter an invalid parameter value, then the graph ignores it and logs an ErrorHandler message.

setTickStyle

public void setTickStyle(java.lang.String style)

Specifies the style of the axis tick marks. The style of the tick marks is defined by the style of the axis grid that they belong to. The constants are defined by the BaseGraphComponent class and begin with GS_.

Parameters:

style - A constant that represents the style of the axis tick marks. If you enter an invalid parameter value, then the graph ignores it and logs an ErrorHandler message. Specifies the type of tick mark to be used for ticks on this axis. Valid values are:

• GS_AUTOMATIC - (Default) Graph determines the tick style automatically.
• GS_EXTENDED - Tick marks span the plot area, and extend beyond the axis.
• GS_GRID - Tick marks span the plot area, but they do not extend beyond the axis.
• GS_IN - Tick lines appear above the axis.
• GS_NONE - No tick lines appear.
• GS_SPAN - Tick marks span across the axis.
• GS_OUT - Tick lines appear below the axis.

getLineColor

public java.awt.Color getLineColor()

Retrieves the color for the object.

Returns:

The color for the object.

setLineColor

public void setLineColor(java.awt.Color newColor)

Specifies the color for the object.

Parameters:

newColor - The color for the object.

getLineWidth

public int getLineWidth()

Retrieves the width of the object in pixels.

Returns:

The width of the object in pixels.

setLineWidth

public void setLineWidth(int width)

Specifies the width of the object in pixels.

Parameters:

width - The width of the object in pixels.

getLineStyle

public int getLineStyle()

Retrieves the style of the line.

Returns:

The style of the line.

See Also:

BaseGraphComponent.LS_SOLID, BaseGraphComponent.LS_DASH, BaseGraphComponent.LS_DOTTED, BaseGraphComponent.LS_DASH_DOT

setLineStyle

public void setLineStyle(int style)

Specifies the style of the line.

Parameters:

style - The style of the line.

See Also:

BaseGraphComponent.LS_SOLID, BaseGraphComponent.LS_DASH, BaseGraphComponent.LS_DOTTED, BaseGraphComponent.LS_DASH_DOT

setLineStyle

public void setLineStyle(java.lang.String style)

Specifies the style for the major tick line. Valid values are:

Parameters:

style - The style of the line.

• LS_SOLID - (Default) Use a solid line.
• LS_DASH - Use a dash line.
• LS_DOTTED - Use a dotted line.
• LS_DASH_DOT - Use a line with combination of dashes and dots.

resetStyleProperties

protected void resetStyleProperties()

getBeanType

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

Specified by:

getBeanType in class BIComplexAttributeBase