oracle.adf.view.faces.bi.component.imageView
Class GradientStopStyle

java.lang.Object
  oracle.adf.view.faces.bi.component.BIComplexAttributeBase
      oracle.adf.view.faces.bi.component.imageView.GradientStopStyle

All Implemented Interfaces:

javax.faces.component.StateHolder

public class GradientStopStyle
extends BIComplexAttributeBase

Since:

release specific (what release of product did this appear in)

Field Summary

static org.apache.myfaces.trinidad.bean.PropertyKey	GRADIENT_STOP_COLOR_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	GRADIENT_STOP_POSITION_KEY
protected java.awt.Color	m_defaultGradientStopColor
protected double	m_defaultGradientStopPosition
protected int	m_defaultStopIndex
static org.apache.myfaces.trinidad.bean.PropertyKey	STOP_INDEX_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

GradientStopStyle()

Method Summary

protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
java.awt.Color	getGradientStopColor() Retrieves the color of a stop.
double	getGradientStopPosition() Retrieves position of a stop in the gradient of the graph.
int	getStopIndex() Retrieves the index of this GradientStop.
void	resetStyleProperties() Applications do not need to call this method.
void	setDefaultValues(int stopIndex, java.awt.Color stopColor, double stopPosition) Application developers do not need to call this method.
void	setGradientStopColor(java.awt.Color newColor) Specifies the color of a stop.
void	setGradientStopPosition(double newPos) Sets the position of a stop in a gradient.
void	setStopIndex(int index) Specifies the index of this GradientStop.

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

m_defaultStopIndex

protected int m_defaultStopIndex

m_defaultGradientStopColor

protected java.awt.Color m_defaultGradientStopColor

m_defaultGradientStopPosition

protected double m_defaultGradientStopPosition

TYPE

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

STOP_INDEX_KEY

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

GRADIENT_STOP_COLOR_KEY

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

GRADIENT_STOP_POSITION_KEY

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

Constructor Detail

GradientStopStyle

public GradientStopStyle()

Method Detail

getStopIndex

public int getStopIndex()

Retrieves the index of this GradientStop.

Returns:

the index

setStopIndex

public void setStopIndex(int index)

Specifies the index of this GradientStop.

Parameters:

index - of this GradientStop

getGradientStopColor

public java.awt.Color getGradientStopColor()

Retrieves the color of a stop.

Returns:

The color of the specified stop.

setGradientStopColor

public void setGradientStopColor(java.awt.Color newColor)

Specifies the color of a stop.

Parameters:

newColor - The color for the stop.

getGradientStopPosition

public double getGradientStopPosition()

Retrieves position of a stop in the gradient of the graph. The 0 position is at the start of the gradient. The 100 position is at the end of the gradient.

For example, if the gradient direction is GD_DOWN, and the position for stop 0 is 0, then the color for stop 0 appears at the top of the gradient. If the position for stop 1 is 50, then the color for stop 1 appears in the middle of the gradient. If the position for stop 2 is 100, then the color for stop 2 appears at the bottom of the gradient.

Returns:

The position of the stop in the gradient. Valid values are from 0 - 100.

setGradientStopPosition

public void setGradientStopPosition(double newPos)

Sets the position of a stop in a gradient. The 0 position is at the start of the gradient. The 100 position is at the end of the gradient. For example, if the gradient direction is GD_DOWN, and the position for stop 0 is 0, then the color for stop 0 appears at the top of the gradient. If the position for stop 1 is 50, then the color for stop 1 appears in the middle of the gradient. If the position for stop 2 is 100, then the color for stop 2 appears at the bottom of the gradient.

Parameters:

newPos - The position of the specified stop in the gradient. Valid values are from 0 - 100.

resetStyleProperties

public void resetStyleProperties()

Applications do not need to call this method. This is for internal use.

setDefaultValues

public void setDefaultValues(int stopIndex,
                             java.awt.Color stopColor,
                             double stopPosition)

Application developers do not need to call this method.

getBeanType

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

Specified by:

getBeanType in class BIComplexAttributeBase