oracle.adf.view.faces.bi.component.gauge
Class TickMark

java.lang.Object
  oracle.adf.view.faces.bi.component.BIComplexAttributeBase
      oracle.adf.view.faces.bi.component.gauge.TickMark

All Implemented Interfaces:

javax.faces.component.StateHolder

public class TickMark
extends BIComplexAttributeBase

Since:

11.0

Field Summary

static org.apache.myfaces.trinidad.bean.PropertyKey	CONTENT_KEY
protected java.awt.Color	m_defaultMajorTickColor
protected java.lang.Integer	m_defaultMajorTickCount
protected java.lang.Double	m_defaultMajorTickStep
protected java.awt.Color	m_defaultMinorTickColor
protected java.lang.Double	m_defaultMinorTickStep
static org.apache.myfaces.trinidad.bean.PropertyKey	MAJOR_INCREMENT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	MAJORTICK_COLOR_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	MAJORTICK_COUNT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	MINOR_INCREMENT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	MINORTICK_COLOR_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

TickMark()

Method Summary

protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
int	getContent() Gets the tick content specification for all gauges in this gauge set.
double	getMajorIncrement() Gets the majorTick step of all gauges in this gauge set.
java.awt.Color	getMajorTickColor() Gets the color for the majorTick of all gauges in this gauge set.
java.lang.Integer	getMajorTickCount() Deprecated. Replaced by getMajorIncrement()
double	getMinorIncrement() Gets the minorTick step of all gauges in this gauge set.
java.awt.Color	getMinorTickColor() Gets the color for the minorTick of all gauges in this gauge set.
protected void	resetStyleProperties()
void	setContent(int content) Sets the content of tick labels in a gauge.
void	setContent(java.lang.String content) Specifies where tick labels occur within a gauge set.
void	setMajorIncrement(double tickStep) Sets the MajorTick step for all gauges in this gauge set.
void	setMajorTickColor(java.awt.Color tickColor) Sets the MajorTick color for all gauges in this gauge set.
void	setMajorTickCount(int tickCount) Deprecated. Replaced by setMajorIncrement(double tickStep)
void	setMinorIncrement(double tickStep) Sets the MinorTick step for all gauges in this gauge set.
void	setMinorTickColor(java.awt.Color tickColor) Sets the MinorTick color for all gauges in this gauge set.

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

applyProperties, getBooleanProperty, getFacesBean, getId, getParent, getProperty, getPropertyKey, getSetAttributeIndex, isTransient, isUpdated, processSetAttribute, processSetAttributeAndAdd, 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

TYPE

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

CONTENT_KEY

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

MAJORTICK_COUNT_KEY

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

MAJORTICK_COLOR_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey MAJORTICK_COLOR_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

MINORTICK_COLOR_KEY

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

m_defaultMajorTickColor

protected java.awt.Color m_defaultMajorTickColor

m_defaultMajorTickCount

protected java.lang.Integer m_defaultMajorTickCount

m_defaultMinorTickColor

protected java.awt.Color m_defaultMinorTickColor

m_defaultMajorTickStep

protected java.lang.Double m_defaultMajorTickStep

m_defaultMinorTickStep

protected java.lang.Double m_defaultMinorTickStep

Constructor Detail

TickMark

public TickMark()

Method Detail

getContent

public int getContent()

Gets the tick content specification for all gauges in this gauge set. Returned value represents 0 or more values added together to specify which tick marks should appear in a gauge.

Returns:

Integer representing 0 or more tick types to display; valid values include those constants in GaugeConstants beginning with TICK_.

setContent

public void setContent(int content)

Sets the content of tick labels in a gauge.

Parameters:

content - Integer representing the types of tick labels to be displayed; valid constants are in the GaugeConstants class starting with TICK_.

setContent

public void setContent(java.lang.String content)

Specifies where tick labels occur within a gauge set. Valid values include any combination of the following separated by spaces or commas. Default value is: TC_MIN_MAX | TC_INCREMENTS

Parameters:

content - Valid values are:

• increments -Displays tick labels by increments.
• majorTick - Displays tick labels for minimum, maximum, and increments.
• minMax - Displays tick labels for minimum and maximum values.
• metric - Displays tick labels for actual metric values.
• none - Displays no tick labels.
• threshold - Displays tick labels for threshold values.

getMajorTickCount

@Deprecated
public java.lang.Integer getMajorTickCount()

Deprecated. Replaced by getMajorIncrement()

Gets the majorTickCount of all gauges in this gauge set.

Returns:

Integer representing the majorTickCount

setMajorTickCount

@Deprecated
public void setMajorTickCount(int tickCount)

Deprecated. Replaced by setMajorIncrement(double tickStep)

Sets the MajorTick count for all gauges in this gauge set. When the specified count is < 0 the increments are calculated automatically based on the gauge width.

Parameters:

tickCount - Integer representing MajorTick count.

getMajorTickColor

public java.awt.Color getMajorTickColor()

Gets the color for the majorTick of all gauges in this gauge set.

Returns:

Color representing the color of the majorTicks

setMajorTickColor

public void setMajorTickColor(java.awt.Color tickColor)

Sets the MajorTick color for all gauges in this gauge set.

Parameters:

tickColor - Color representing MajorTick color.

getMajorIncrement

public double getMajorIncrement()

Gets the majorTick step of all gauges in this gauge set. The distance between two major tick marks. If less than or equal to 0 major increments will not be shown. The major tick are the ones that will display a labeled value underneath the tick mark.

Returns:

MajorTick step.

getMinorIncrement

public double getMinorIncrement()

Gets the minorTick step of all gauges in this gauge set. The distance between two minor tick marks. If less than or equal to 0 minor increments will not be shown. The minor tick are the ones that will not show a label underneath the tick mark.

Returns:

MinorTick step.

setMajorIncrement

public void setMajorIncrement(double tickStep)

Sets the MajorTick step for all gauges in this gauge set. The distance between two major tick marks. If less than or equal to 0 major increments will not be shown. The major tick are the ones that will display a labeled value underneath the tick mark.

Parameters:

tickStep - representing MajorTick step.

setMinorIncrement

public void setMinorIncrement(double tickStep)

Sets the MinorTick step for all gauges in this gauge set. The distance between two minor tick marks. If less than or equal to 0 minor increments will not be shown. The minor tick are the ones that will not show a label underneath the tick mark.

Parameters:

tickStep - representing MinorTick step.

getMinorTickColor

public java.awt.Color getMinorTickColor()

Gets the color for the minorTick of all gauges in this gauge set.

Returns:

Color representing the color of the minorTicks

setMinorTickColor

public void setMinorTickColor(java.awt.Color tickColor)

Sets the MinorTick color for all gauges in this gauge set.

Parameters:

tickColor - Color representing MinorTick color.

resetStyleProperties

protected void resetStyleProperties()

getBeanType

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

Specified by:

getBeanType in class BIComplexAttributeBase