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

Class Alert

java.lang.Object

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

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

All Implemented Interfaces:

javax.faces.component.StateHolder

public class Alert
extends BIComplexAttributeBase

Defines properties for an alert on a graph.

Since:

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

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.myfaces.trinidad.bean.PropertyKey	IMAGE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	RENDERED_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	TEXT_KEY
static org.apache.myfaces.trinidad.bean.FacesBean.Type	TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	XVALUE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	YAXIS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	YVALUE_KEY

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

ID_KEY, m_parent, TRANSIENT_KEY

Constructor Summary

Constructors

Constructor and Description
Alert()

Method Summary

Modifier and Type	Method and Description
protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
java.lang.String	getImageSource() Retrieves the url pointing to the icon for the alert.
java.lang.String	getText() Retrieves the text for the alert.
java.lang.Object	getXValue() Retrieves the x-value associated with this alert.
java.lang.Object	getYValue() Retrieves the y-value associated with this alert.
int	getYValueAssignment() Indicates whether the Y value is plotted against the Y1 or Y2-axis.
boolean	isRendered() Indicates whether the alert is rendered.
void	setImageSource(java.lang.String url) Specifies the text of the alert.
void	setRendered(boolean rendered) Specifies whether the alert is rendered.
void	setText(java.lang.String str) Specifies the text of the alert.
void	setXValue(java.lang.Object value) Specifies the x-value associated with this alert.
void	setYValue(java.lang.Object value) Specifies the y-value associated with this alert.
void	setYValueAssignment(int axis) Specifies whether the Y value is plotted against the Y1 or Y2-axis.
void	setYValueAssignment(java.lang.String axis) Identifies which axis the yValue attribute is associated with.

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

TYPE

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

XVALUE_KEY

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

YVALUE_KEY

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

TEXT_KEY

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

IMAGE_KEY

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

RENDERED_KEY

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

YAXIS_KEY

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

Constructor Detail

Alert

public Alert()

Method Detail

setXValue

public void setXValue(java.lang.Object value)

Specifies the x-value associated with this alert.

Parameters:

value -

getXValue

public java.lang.Object getXValue()

Retrieves the x-value associated with this alert.

Returns:

value

setYValue

public void setYValue(java.lang.Object value)

Specifies the y-value associated with this alert.

Parameters:

value -

getYValue

public java.lang.Object getYValue()

Retrieves the y-value associated with this alert.

Returns:

value

getText

public java.lang.String getText()

Retrieves the text for the alert. This text will appear as a tooltip text for this alert.

Returns:

The text for the alert.

setText

public void setText(java.lang.String str)

Specifies the text of the alert. This text will appear as a tooltip text for this alert.

Parameters:

str - The text of the alert.

setYValueAssignment

public void setYValueAssignment(int axis)

Specifies whether the Y value is plotted against the Y1 or Y2-axis.

Parameters:

axis - The axis Y value is plotted against.

setYValueAssignment

public void setYValueAssignment(java.lang.String axis)

Identifies which axis the yValue attribute is associated with.

Parameters:

axis - The axis Y value is plotted against.

• Y1AXIS - (Default) yValue is associated with the y1-axis.
• Y2AXIS - yValue is associated with the y2-axis.

getYValueAssignment

public int getYValueAssignment()

Indicates whether the Y value is plotted against the Y1 or Y2-axis.

Returns:

The integer representing the axis Y value is plotted against.

getImageSource

public java.lang.String getImageSource()

Retrieves the url pointing to the icon for the alert.

Returns:

The url for the alert.

setImageSource

public void setImageSource(java.lang.String url)

Specifies the text of the alert. This text will appear as a tooltip text for this alert.

Parameters:

str - The text of the alert.

isRendered

public boolean isRendered()

Indicates whether the alert is rendered.

Returns:

true if it is rendered, false if it is inrendered.

setRendered

public void setRendered(boolean rendered)

Specifies whether the alert is rendered.

Parameters:

yesNo - true to make it rendered, false to make it inrendered.

getBeanType

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

Specified by:

getBeanType in class BIComplexAttributeBase