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

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

All Implemented Interfaces:

javax.faces.component.StateHolder

public class Indicator
extends BIComplexAttributeBase

Defines properties for the indicator on a dial or led gauge.

Since:

11.0

Field Summary

static org.apache.myfaces.trinidad.bean.PropertyKey	BORDER_COLOR_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	FILL_COLOR_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SFX_KEY
static org.apache.myfaces.trinidad.bean.FacesBean.Type	TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	TYPE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	USETHRESHOLDFILLCOLOR_KEY

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

ID_KEY, m_parent, TRANSIENT_KEY

Constructor Summary

Indicator()

Method Summary

protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
java.awt.Color	getBorderColor() Retrieves the border color of the indicator.
java.awt.Color	getFillColor() Retrieves the fill color of the indicator.
SpecialEffects	getSpecialEffects()
int	getType() Retrieves the type of this indicator.
boolean	isUseThresholdFillColor() Indicates whether the color of the threshold in which the indicator falls should override the indicator color.
protected void	resetStyleProperties()
void	restoreState(javax.faces.context.FacesContext context, java.lang.Object stateObj)
void	setBorderColor(java.awt.Color newColor) Specifies the border color of the indicator.
void	setFillColor(java.awt.Color newColor) Specifies the fill color of the indicator.
void	setSpecialEffects(SpecialEffects sfx)
void	setType(int type) Specifies the type of this indicator.
void	setType(java.lang.String type) Specifies the kind of indicator used.
void	setUseThresholdFillColor(boolean yesNo) Indicates whether the color of the threshold in which the indicator falls should override the indicator color.

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

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

FILL_COLOR_KEY

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

BORDER_COLOR_KEY

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

USETHRESHOLDFILLCOLOR_KEY

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

TYPE_KEY

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

SFX_KEY

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

Constructor Detail

Indicator

public Indicator()

Method Detail

getFillColor

public java.awt.Color getFillColor()

Retrieves the fill color of the indicator.

Returns:

The fill color of the indicator.

setFillColor

public void setFillColor(java.awt.Color newColor)

Specifies the fill color of the indicator.

Parameters:

newColor - The fill color of the indicator.

getBorderColor

public java.awt.Color getBorderColor()

Retrieves the border color of the indicator.

Returns:

The border color of the indicator.

setBorderColor

public void setBorderColor(java.awt.Color newColor)

Specifies the border color of the indicator.

Parameters:

newColor - The border color of the indicator.

isUseThresholdFillColor

public boolean isUseThresholdFillColor()

Indicates whether the color of the threshold in which the indicator falls should override the indicator color.

Returns:

true if threshold color should override indicator color, false otherwise.

setUseThresholdFillColor

public void setUseThresholdFillColor(boolean yesNo)

Indicates whether the color of the threshold in which the indicator falls should override the indicator color.

getType

public int getType()

Retrieves the type of this indicator.

Returns:

The type of this indicator.

setType

public void setType(int type)

Specifies the type of this indicator.

Parameters:

type - The type of this indicator.

setType

public void setType(java.lang.String type)

Specifies the kind of indicator used.

Parameters:

type - Valid values are:

• line - (Default) Specifies an indicator that is a line.
• fill - Specifies an indicator that fills the area up to the specified gauge value. This value does not apply to gauge with thresholds.
• needle - Specifies a thick needle indicator.

restoreState

public void restoreState(javax.faces.context.FacesContext context,
                         java.lang.Object stateObj)

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class BIComplexAttributeBase

getSpecialEffects

public SpecialEffects getSpecialEffects()

setSpecialEffects

public void setSpecialEffects(SpecialEffects sfx)

resetStyleProperties

protected void resetStyleProperties()

getBeanType

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

Specified by:

getBeanType in class BIComplexAttributeBase