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

Class Annotation

java.lang.Object

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

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

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

All Implemented Interfaces:

javax.faces.component.StateHolder

public class Annotation
extends BaseTextComponent

Defines properties for an annotation of a graph.

Since:

R11

Field Summary

Fields

Modifier and Type	Field and Description
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	GROUP_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	HORZ_ALIGN_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	LOCATION_KEY
protected java.awt.Color	m_defaultFontColor
protected int	m_defaultFontSize
protected int	m_defaultFontStyle
protected java.lang.String	m_defaultFontTypeface
static org.apache.myfaces.trinidad.bean.PropertyKey	POSITION_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	RENDERED_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SERIES_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	VERT_ALIGN_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	XVALUE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	YVALUE_KEY

Fields inherited from class oracle.adf.view.faces.bi.component.graph.BaseTextComponent

GRAPH_FONT_KEY

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

ID_KEY, m_parent, TRANSIENT_KEY

Constructor Summary

Constructors

Constructor and Description
Annotation()

Method Summary

Methods

Modifier and Type	Method and Description
protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
java.awt.Color	getBorderColor() Retrieves the color of the annotation.
java.awt.Color	getFillColor() Retrieves the color of the annotation.
int	getGroup() Retrieves the Group associated with this annotation.
int	getHorizontalAlignment() Retrieves the horizontal alignment for the annotation.
java.lang.String	getLocation() Returns the location of the annotation relative to the markers in the plot area.
java.lang.String	getPosition() Retrieves the position for the annotation.
int	getSeries() Retrieves the Series associated with this annotation.
java.lang.String	getText() Retrieves the text for the annotation.
int	getVerticalAlignment() Retrieves the vertical alignment for the annotation.
double	getXValue() Returns the x value of the annotation.
double	getYValue() Returns the y value of the annotation.
boolean	isRendered() Indicates whether the annotation is rendered.
void	setBorderColor(java.awt.Color newColor) Specifies the color of the annotation.
void	setFillColor(java.awt.Color newColor) Specifies the color of the annotation.
void	setGroup(int index) Specifies the Group associated with this annotation.
void	setHorizontalAlignment(int align) Sets the horizontal alignment for the annotation.
void	setHorizontalAlignment(java.lang.String align) Specifies the horizontal positioning of the annotation.
void	setLocation(java.lang.String str) Specifies the location of the annotation relative to the markers in the plot area.
void	setPosition(java.lang.String str) Specifies the position for the annotation.
void	setRendered(boolean rendered) Specifies whether the annotation is rendered.
void	setSeries(int index) Specifies the Series associated with this annotation.
void	setText(java.lang.String str) Specifies the text of the annotation.
void	setVerticalAlignment(int align) Sets the vertical alignment for the annotation.
void	setVerticalAlignment(java.lang.String align) Specifies the vertical positioning of the annotation.
void	setXValue(double value) Set the x value of the annotation.
void	setYValue(double value) Set the y value of the annotation.

Methods inherited from class oracle.adf.view.faces.bi.component.graph.BaseTextComponent

getGraphFont, setGraphFont

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

m_defaultFontTypeface

protected java.lang.String m_defaultFontTypeface

m_defaultFontStyle

protected int m_defaultFontStyle

m_defaultFontSize

protected int m_defaultFontSize

m_defaultFontColor

protected java.awt.Color m_defaultFontColor

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

TEXT_KEY

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

HORZ_ALIGN_KEY

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

VERT_ALIGN_KEY

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

RENDERED_KEY

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

SERIES_KEY

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

GROUP_KEY

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

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

POSITION_KEY

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

LOCATION_KEY

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

Constructor Detail

Annotation

public Annotation()

Method Detail

setSeries

public void setSeries(int index)

Specifies the Series associated with this annotation.

Parameters:

index -

getSeries

public int getSeries()

Retrieves the Series associated with this annotation.

Returns:

the index

setGroup

public void setGroup(int index)

Specifies the Group associated with this annotation.

Parameters:

index -

getGroup

public int getGroup()

Retrieves the Group associated with this annotation.

Returns:

the index

setXValue

public void setXValue(double value)

Set the x value of the annotation. This setting only applies if the position is absolute or percentage. If position is percentage, this value must be between 0 and 100.

Parameters:

value - the x value of the annotation

getXValue

public double getXValue()

Returns the x value of the annotation. This setting only applies if the position is absolute or percentage. If position is percentage, this value must be between 0 and 100.

Returns:

the x value of the annotation

setYValue

public void setYValue(double value)

Set the y value of the annotation. This setting only applies if the position is absolute or percentage. If position is percentage, this value must be between 0 and 100.

Parameters:

value - the y value of the annotation

getYValue

public double getYValue()

Returns the y value of the annotation. This setting only applies if the position is absolute or percentage. If position is percentage, this value must be between 0 and 100.

Returns:

the y value of the annotation

getFillColor

public java.awt.Color getFillColor()

Retrieves the color of the annotation.

Returns:

The color of the specified annotation.

setFillColor

public void setFillColor(java.awt.Color newColor)

Specifies the color of the annotation.

Parameters:

newColor - The color for the annotation. The default is Red (0xffcc0000)

getBorderColor

public java.awt.Color getBorderColor()

Retrieves the color of the annotation.

Returns:

The color of the specified annotation.

setBorderColor

public void setBorderColor(java.awt.Color newColor)

Specifies the color of the annotation.

Parameters:

newColor - The color for the annotation. The default is Red (0xffcc0000)

getText

public java.lang.String getText()

Retrieves the text for the annotation. This text will appear as a Legend text for this annotation.

Returns:

The text for the annotation.

setText

public void setText(java.lang.String str)

Specifies the text of the annotation. This text will appear as a Legend text for this annotation.

Parameters:

str - The text of the annotation.

getPosition

public java.lang.String getPosition()

Retrieves the position for the annotation. Valid values are:
dataValue - Use the series and group to position the annotation.
absolute - Use the x and y values to position the annotation.
percentage - Position the annotation by a percentage of the plot area. This setting treats the x and y values as percentages, where the possible values are from 0 to 100.
When the position is set to absolute or percentage, the annotation is positioned at exactly the xy location specified, without taking into account overlap or clipping.

Returns:

the position for the annotation.

setPosition

public void setPosition(java.lang.String str)

Specifies the position for the annotation. Valid values are:
dataValue - Use the series and group to position the annotation.
absolute - Use the x and y values to position the annotation.
percentage - Position the annotation by a percentage of the plot area. This setting treats the x and y values as percentages, where the possible values are from 0 to 100.
When the position is set to absolute or percentage, the annotation is positioned at exactly the xy location specified, without taking into account overlap or clipping.

Parameters:

str - the position for the annotation.

getHorizontalAlignment

public int getHorizontalAlignment()

Retrieves the horizontal alignment for the annotation. Valid values are SwingConstants.LEFT, SwingConstants.CENTER, SwingConstants.RIGHT, and SwingConstants.LEADING.

Returns:

a constant that represents the horizontal alignment

setHorizontalAlignment

public void setHorizontalAlignment(int align)

Sets the horizontal alignment for the annotation. Valid values are SwingConstants.LEFT, SwingConstants.CENTER, SwingConstants.RIGHT, and SwingConstants.LEADING.

Parameters:

align - a constant that represents the horizontal alignment

setHorizontalAlignment

public void setHorizontalAlignment(java.lang.String align)

Specifies the horizontal positioning of the annotation. This setting only applies when the annotation position is absolute or percentage.

Parameters:

align - Valid values are:

• CENTER
• LEADING
• LEFT (Default)
• RIGHT

getVerticalAlignment

public int getVerticalAlignment()

Retrieves the vertical alignment for the annotation. Valid values are SwingConstants.TOP, SwingConstants.CENTER, and SwingConstants.BOTTOM.

Returns:

a constant that represents the vertical alignment

setVerticalAlignment

public void setVerticalAlignment(int align)

Sets the vertical alignment for the annotation. Valid values are SwingConstants.TOP, SwingConstants.CENTER, and SwingConstants.BOTTOM.

Parameters:

align - a constant that represents the vertical alignment

setVerticalAlignment

public void setVerticalAlignment(java.lang.String align)

Specifies the vertical positioning of the annotation. This setting only applies when the annotation position is absolute or percentage.

Parameters:

align - Valid values are:

• CENTER (Default)
• TOP
• BOTTOM

isRendered

public boolean isRendered()

Indicates whether the annotation is rendered.

Returns:

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

setRendered

public void setRendered(boolean rendered)

Specifies whether the annotation is rendered.

Parameters:

rendered - true to make it rendered, false to make it not rendered.

getLocation

public java.lang.String getLocation()

Returns the location of the annotation relative to the markers in the plot area. Valid values are "back" and "front".

Returns:

the position of the annotation

setLocation

public void setLocation(java.lang.String str)

Specifies the location of the annotation relative to the markers in the plot area. Valid values are "back" and "front".

Parameters:

str - the position of the annotation

getBeanType

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

Specified by:

getBeanType in class BIComplexAttributeBase