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

java.lang.Object
  oracle.adf.view.faces.bi.component.BIComplexAttributeBase
      oracle.adf.view.faces.bi.component.graph.ReferenceObject

All Implemented Interfaces:

javax.faces.component.StateHolder

public class ReferenceObject
extends BIComplexAttributeBase

Defines properties for a reference object in a graph.

Since:

R11

Field Summary

static org.apache.myfaces.trinidad.bean.PropertyKey	ASSOCIATION_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	COLOR_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	DISPLAYED_IN_LEGEND_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	HIGH_VALUE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	INDEX_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	LINE_STYLE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	LINE_VALUE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	LINE_WIDTH_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	LOCATION_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	LOW_VALUE_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	SFX_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SHORTDESC_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	TYPE_KEY

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

ID_KEY, m_parent, TRANSIENT_KEY

Constructor Summary

ReferenceObject()

Method Summary

int	getAssociation() Retrieves a constant that identifies the component this reference object is associated with.
protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
java.awt.Color	getColor() Retrieves the color of the reference object.
java.lang.Object	getHighValue() Retrieves the high value of the reference Area.
int	getIndex() Retrieves the index of this reference line.
int	getLineStyle() Retrieves the style of the line.
java.lang.Object	getLineValue() Retrieves the value at which the reference line is displayed.
int	getLineWidth() Retrieves the width of the reference line in pixels.
int	getLocation() Returns the location of the reference object.
java.lang.Object	getLowValue() Retrieves the low value of the reference Area.
int	getSeries() Retrieves the series this reference object is associated with.
java.lang.String	getShortDesc() Retrieves the short description of the reference object.
SpecialEffects	getSpecialEffects() Retrieve the special effect of the reference object
java.lang.String	getText() Retrieves the text for the reference object.
int	getType() Returns the type of the reference object.
boolean	isDisplayedInLegend() Indicates whether the reference object appears in the legend.
void	setAssociation(int component) Specifies a constant that represents the component this reference object is associated with.
void	setAssociation(java.lang.String component) A constant that identifies the component that this reference object is associated with.
void	setColor(java.awt.Color newColor) Specifies the color of the reference object.
void	setDisplayedInLegend(boolean visible) Specifies whether to display the reference object in the legend.
void	setHighValue(java.lang.Object value) Specifies the high value of the reference area.
void	setIndex(int index) Specifies the index of this reference line.
void	setLineStyle(int style) Specifies the style of the line.
void	setLineStyle(java.lang.String style) Specifies the style of the pareto line.
void	setLineValue(java.lang.Object value) Specifies the value at which the reference line is displayed.
void	setLineWidth(int width) Specifies the width of the reference line in pixels.
void	setLocation(int location) Specifies the location of the reference object.
void	setLocation(java.lang.String location) Specifies whether the reference line is to appear in front of or behind the graph.
void	setLowValue(java.lang.Object value) Specifies the low value of the reference area.
void	setSeries(int series) Specifies the series this reference object is associated with.
void	setShortDesc(java.lang.String shortDesc) Specifies the short description of the reference object.
void	setSpecialEffects(SpecialEffects sfx) Specifies the special effect of the reference object
void	setText(java.lang.String str) Specifies the text of the reference object.
void	setType(int type) Specifies the type of the reference object.
void	setType(java.lang.String type) Identifies whether the reference object represents a line or an area.

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

TYPE

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

TYPE_KEY

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

ASSOCIATION_KEY

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

LOCATION_KEY

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

SERIES_KEY

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

COLOR_KEY

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

LINE_WIDTH_KEY

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

LINE_STYLE_KEY

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

TEXT_KEY

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

RENDERED_KEY

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

LINE_VALUE_KEY

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

LOW_VALUE_KEY

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

HIGH_VALUE_KEY

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

DISPLAYED_IN_LEGEND_KEY

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

INDEX_KEY

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

SFX_KEY

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

SHORTDESC_KEY

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

Constructor Detail

ReferenceObject

public ReferenceObject()

Method Detail

setIndex

public void setIndex(int index)

Specifies the index of this reference line.

Parameters:

index -

getIndex

public int getIndex()

Retrieves the index of this reference line.

Returns:

the index

getType

public int getType()

Returns the type of the reference object.

Returns:

Constant that identifies the type of the reference object Valid constants are listed in the See Also section.

See Also:

BaseGraphComponent.RO_LINE, BaseGraphComponent.RO_AREA

setType

public void setType(int type)

Specifies the type of the reference object.

Parameters:

type - Constant that identifies the type of the reference object. By default object is of type reference line Valid constants are listed in the See Also section.

See Also:

BaseGraphComponent.RO_LINE, BaseGraphComponent.RO_AREA

setType

public void setType(java.lang.String type)

Identifies whether the reference object represents a line or an area. Valid values are:

Parameters:

type - Constant that identifies the type of the reference object. By default object is of type reference line Valid constants are

• RO_LINE - (Default) Specifies a reference line.
• RO_AREA - Specifies a reference area.

getLocation

public int getLocation()

Returns the location of the reference object.

Returns:

Constant that identifies the location of the reference object Valid constants are listed in the See Also section.

See Also:

BaseGraphComponent.RO_FRONT, BaseGraphComponent.RO_BACK

setLocation

public void setLocation(int location)

Specifies the location of the reference object.

Parameters:

location - Constant that identifies the location of the reference object. By default object is located at the back Valid constants are listed in the See Also section.

See Also:

BaseGraphComponent.RO_FRONT, BaseGraphComponent.RO_BACK

setLocation

public void setLocation(java.lang.String location)

Specifies whether the reference line is to appear in front of or behind the graph. Valid values are:

Parameters:

location - Constant that identifies the location of the reference object. By default object is located at the back. Valid constants are

• RO_BACK - (Default) Reference line appears behind the graph.
• RO_FRONT - Reference line appears in front of the graph.

getAssociation

public int getAssociation()

Retrieves a constant that identifies the component this reference object is associated with. The component is either an axis, or a series.

Returns:

Constant that identifies the component this reference object is associated with.

See Also:

GraphConstants.Y1AXIS, GraphConstants.Y2AXIS, GraphConstants.X1AXIS, GraphConstants.SERIES

setAssociation

public void setAssociation(int component)

Specifies a constant that represents the component this reference object is associated with.

Parameters:

component - Constant that identifies the component this reference object is associated with. By default it is associated with the Y1AXIS.

See Also:

GraphConstants.Y1AXIS, GraphConstants.Y2AXIS, GraphConstants.X1AXIS, GraphConstants.SERIES

setAssociation

public void setAssociation(java.lang.String component)

A constant that identifies the component that this reference object is associated with. The component is either an axis or a series. Valid values are the following:

Parameters:

component - Constant that identifies the component this reference object is associated with. By default it is associated with the Y1AXIS.

• Y1AXIS - (Default) Reference object is associated with the y1-axis.
• Y2AXIS - Reference object is associated with the y2-axis.
• X1AXIS - Reference object is associated with the x-axis.
• SERIES - Reference object is associated with a data series.

getSeries

public int getSeries()

Retrieves the series this reference object is associated with.

Returns:

The zero-based number of the series that this reference object is associated with.

setSeries

public void setSeries(int series)

Specifies the series this reference object is associated with.

Parameters:

series - The zero-based number of the series that this reference object is associated with. By default it is associated with the first series.

getColor

public java.awt.Color getColor()

Retrieves the color of the reference object.

Returns:

The color of the specified reference object.

setColor

public void setColor(java.awt.Color newColor)

Specifies the color of the reference object.

Parameters:

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

getLineWidth

public int getLineWidth()

Retrieves the width of the reference line in pixels. Not relevant to reference areas.

Returns:

The width of the reference line in pixels.

setLineWidth

public void setLineWidth(int width)

Specifies the width of the reference line in pixels. Not relevant to reference areas.

Parameters:

width - The width for the reference line in pixels. The default line width is single pixel.

getLineStyle

public int getLineStyle()

Retrieves the style of the line. Not relevant to reference areas.

Returns:

A constant that represents the line style of the specified reference line. Valid constants are listed in the See Also section.

See Also:

BaseGraphComponent.LS_SOLID, BaseGraphComponent.LS_DASH, BaseGraphComponent.LS_DOTTED, BaseGraphComponent.LS_DASH_DOT

setLineStyle

public void setLineStyle(int style)

Specifies the style of the line. Not relevant to reference areas.

Parameters:

style - The style of the line. By default the line style is LS_SOLID

See Also:

BaseGraphComponent.LS_SOLID, BaseGraphComponent.LS_DASH, BaseGraphComponent.LS_DOTTED, BaseGraphComponent.LS_DASH_DOT

setLineStyle

public void setLineStyle(java.lang.String style)

Specifies the style of the pareto line.

Parameters:

style - The style of the line.

• LS_SOLID - (Default) Use a solid line.
• LS_DASH - Use a dash line.
• LS_DOTTED - Use a dotted line.
• LS_DASH_DOT - Use a line with combination of dashes and dots.

getText

public java.lang.String getText()

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

Returns:

The text for the reference object.

setText

public void setText(java.lang.String str)

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

Parameters:

str - The text of the reference object.

isDisplayedInLegend

public boolean isDisplayedInLegend()

Indicates whether the reference object appears in the legend.

Returns:

true if the specified reference object appears in the legend, false if it does not.

setDisplayedInLegend

public void setDisplayedInLegend(boolean visible)

Specifies whether to display the reference object in the legend.

Parameters:

visible - true to display the object in the legend, false to remove it from the legend.

getLineValue

public java.lang.Object getLineValue()

Retrieves the value at which the reference line is displayed. Not relevant to reference areas.

Returns:

An object representing the value at which the reference object is displayed along the axis. This Object will be of type Number when reference object is of type "Line".

setLineValue

public void setLineValue(java.lang.Object value)

Specifies the value at which the reference line is displayed. Not relevant to reference areas.

Parameters:

value - The value at which to display the reference object. This Object will be of type Number when reference object is of type "Line".

getLowValue

public java.lang.Object getLowValue()

Retrieves the low value of the reference Area. Not relevant to reference lines.

Returns:

An object representing the low value of the reference area

setLowValue

public void setLowValue(java.lang.Object value)

Specifies the low value of the reference area.

Parameters:

value - The low value of the reference area.

getHighValue

public java.lang.Object getHighValue()

Retrieves the high value of the reference Area. Not relevant to reference lines.

Returns:

An object representing the high value of the reference area

setHighValue

public void setHighValue(java.lang.Object value)

Specifies the high value of the reference area.

Parameters:

value - The high value of the reference area.

getSpecialEffects

public SpecialEffects getSpecialEffects()

Retrieve the special effect of the reference object

Returns:

the special effect

setSpecialEffects

public void setSpecialEffects(SpecialEffects sfx)

Specifies the special effect of the reference object

Parameters:

sfx - the special effect

setShortDesc

public void setShortDesc(java.lang.String shortDesc)

Specifies the short description of the reference object. The graph does locale specific formatting for the numbers in the tooltips. If custom formatting is needed, the shortDesc should be used (and the numbers manually formatted)

Parameters:

shortDesc - the short description

getShortDesc

public java.lang.String getShortDesc()

Retrieves the short description of the reference object. The graph does locale specific formatting for the numbers in the tooltips. If custom formatting is needed, the shortDesc should be used (and the numbers manually formatted)

Returns:

the short description

getBeanType

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

Specified by:

getBeanType in class BIComplexAttributeBase