oracle.adfdt.view.dvt.binding.pattern.graph

Class Alert

java.lang.Object

oracle.adfdt.view.dvt.binding.pattern.options.ComplexExtendedProperties

oracle.adfdt.view.dvt.binding.pattern.graph.Alert

All Implemented Interfaces:

ExtendedProperties

public class Alert
extends ComplexExtendedProperties

A set of accessor methods that allow the user to change the structure and functionality of an alert.

Field Summary

Fields inherited from class oracle.adfdt.view.dvt.binding.pattern.options.ComplexExtendedProperties

AF_NS, DVT_NS, F_NS

Constructor Summary

Constructors

Constructor and Description
Alert()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getId() Description: Specifies the identifier for the component
java.lang.String	getImageSource() Description: Specifies the URL for the icon image that will be displayed for the alert.
java.lang.String	getTagName()
java.lang.String	getText() Description: Specifies text that appears in a tooltip when a mouse pointer hovers over the icon.
java.lang.String	getXValue() Description: Indicates the x-axis or ordinal axis value for the alert.
double	getYValue() Description: Indicates the y-axis value for the alert.
java.lang.String	getYValueAssignment() Description: Identifies which axis the yValue attribute is associated with.
java.lang.String	getYValueAsString() Description: Indicates the y-axis value for the alert.
boolean	isRendered() Description: Specifies whether the alert is visible in the graph.
java.lang.String	isRenderedAsString() Description: Specifies whether the alert is visible in the graph.
void	setId(java.lang.String id) Description: Specifies the identifier for the component
void	setImageSource(java.lang.String imageSource) Description: Specifies the URL for the icon image that will be displayed for the alert.
void	setRendered(boolean rendered) Description: Specifies whether the alert is visible in the graph.
void	setRenderedAsString(java.lang.String rendered) Description: Specifies whether the alert is visible in the graph.
void	setText(java.lang.String text) Description: Specifies text that appears in a tooltip when a mouse pointer hovers over the icon.
void	setXValue(java.lang.String xValue) Description: Indicates the x-axis or ordinal axis value for the alert.
void	setYValue(double yValue) Description: Indicates the y-axis value for the alert.
void	setYValueAssignment(java.lang.String yValueAssignment) Description: Identifies which axis the yValue attribute is associated with.
void	setYValueAsString(java.lang.String yValue) Description: Indicates the y-axis value for the alert.

Methods inherited from class oracle.adfdt.view.dvt.binding.pattern.options.ComplexExtendedProperties

_applyToRootElement, _applyToRootElement, applyChanges, applyChanges, applyChanges, applyChanges, applyChanges, cloneFrom, getAttribute, getComplexChild, getComplexChild, getComplexChildAsList, populateAttributesAndChildTags, removeComplexChildList, setAttribute, setComplexChild, setComplexChild, setComplexChildAsList

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Alert

public Alert()

Method Detail

getTagName

public java.lang.String getTagName()

Specified by:

getTagName in class ComplexExtendedProperties

getId

public java.lang.String getId()

Description: Specifies the identifier for the component

Returns:

the value of the id attribute of the Tag this class represents.

setId

public void setId(java.lang.String id)

Description: Specifies the identifier for the component

Parameters:

id - the value of the id attribute of the Tag this class represents.

getImageSource

public java.lang.String getImageSource()

Description: Specifies the URL for the icon image that will be displayed for the alert.

Returns:

the value of the imageSource attribute of the Tag this class represents.

setImageSource

public void setImageSource(java.lang.String imageSource)

Description: Specifies the URL for the icon image that will be displayed for the alert.

Parameters:

imageSource - the value of the imageSource attribute of the Tag this class represents.

isRendered

public boolean isRendered()

Description: Specifies whether the alert is visible in the graph. Valid values are "true" (Default) and "false".

Returns:

the value of the rendered attribute of the Tag this class represents.

setRendered

public void setRendered(boolean rendered)

Description: Specifies whether the alert is visible in the graph. Valid values are "true" (Default) and "false".

Parameters:

rendered - the value of the rendered attribute of the Tag this class represents.

isRenderedAsString

public java.lang.String isRenderedAsString()

Description: Specifies whether the alert is visible in the graph. Valid values are "true" (Default) and "false". This method is provided as a convenience to be able to retrieve an EL that was set on the rendered attribute.

Returns:

the value of the rendered attribute of the Tag this class represents.

setRenderedAsString

public void setRenderedAsString(java.lang.String rendered)

Description: Specifies whether the alert is visible in the graph. Valid values are "true" (Default) and "false". This method is provided as a convenience to be able to set an EL on the rendered attribute.

Parameters:

rendered - the value of the rendered attribute of the Tag this class represents.

getText

public java.lang.String getText()

Description: Specifies text that appears in a tooltip when a mouse pointer hovers over the icon.

Returns:

the value of the text attribute of the Tag this class represents.

setText

public void setText(java.lang.String text)

Description: Specifies text that appears in a tooltip when a mouse pointer hovers over the icon.

Parameters:

text - the value of the text attribute of the Tag this class represents.

getXValue

public java.lang.String getXValue()

Description: Indicates the x-axis or ordinal axis value for the alert. For example, in a bar graph, you might specify a group such as "Boston" or "Chicago" if points on the axis represent cities. In a scatter graph, this value is a number. The value for this attribute can be String, Double, or Date.

Returns:

the value of the xValue attribute of the Tag this class represents.

setXValue

public void setXValue(java.lang.String xValue)

Description: Indicates the x-axis or ordinal axis value for the alert. For example, in a bar graph, you might specify a group such as "Boston" or "Chicago" if points on the axis represent cities. In a scatter graph, this value is a number. The value for this attribute can be String, Double, or Date.

Parameters:

xValue - the value of the xValue attribute of the Tag this class represents.

getYValue

public double getYValue()
                 throws java.lang.NumberFormatException

Description: Indicates the y-axis value for the alert. The value must be a Double.

Returns:

the value of the yValue attribute of the Tag this class represents.

Throws:

java.lang.NumberFormatException

setYValue

public void setYValue(double yValue)

Description: Indicates the y-axis value for the alert. The value must be a Double.

Parameters:

yValue - the value of the yValue attribute of the Tag this class represents.

getYValueAsString

public java.lang.String getYValueAsString()
                                   throws java.lang.NumberFormatException

Description: Indicates the y-axis value for the alert. The value must be a Double. This method is provided as a convenience to be able to retrieve an EL that was set on the yValue attribute.

Returns:

the value of the yValue attribute of the Tag this class represents.

Throws:

java.lang.NumberFormatException

setYValueAsString

public void setYValueAsString(java.lang.String yValue)

Description: Indicates the y-axis value for the alert. The value must be a Double. This method is provided as a convenience to be able to set an EL on the yValue attribute.

Parameters:

yValue - the value of the yValue attribute of the Tag this class represents.

getYValueAssignment

public java.lang.String getYValueAssignment()

Description: Identifies which axis the yValue attribute is associated with. Valid values are: Y1AXIS - (Default) yValue is associated with the y1-axis. Y2AXIS - yValue is associated with the y2-axis.

Returns:

the value of the yValueAssignment attribute of the Tag this class represents.

setYValueAssignment

public void setYValueAssignment(java.lang.String yValueAssignment)

Description: Identifies which axis the yValue attribute is associated with. Valid values are: Y1AXIS - (Default) yValue is associated with the y1-axis. Y2AXIS - yValue is associated with the y2-axis.

Parameters:

yValueAssignment - the value of the yValueAssignment attribute of the Tag this class represents.