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

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

All Implemented Interfaces:

javax.faces.component.StateHolder

public class Series
extends BIComplexAttributeBase

Since:

11.0

Field Summary

static org.apache.myfaces.trinidad.bean.PropertyKey	ASSIGNED_TO_Y2_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	BORDER_COLOR_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	BORDER_TRANSPARENT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	COLOR_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	FITLINE_TYPE_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_WIDTH_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	MARKER_COLOR_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	MARKER_SHAPE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	MARKER_TYPE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	PIE_SLICE_EXPLODE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SFX_KEY
static org.apache.myfaces.trinidad.bean.FacesBean.Type	TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	VISIBILITY_KEY

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

ID_KEY, m_parent, TRANSIENT_KEY

Constructor Summary

Series()

Method Summary

protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
java.awt.Color	getBorderColor() Retrieves the border color of the series.
java.awt.Color	getColor() Retrieves the fill color of the series.
int	getFitlineType() Retrieves the type of fitline for a series.
int	getIndex() Retrieves the index for this series.
int	getLineStyle() Retrieves the style of the data line for the specified series.
int	getLineWidth() Retrieves the width for the data line for this series.
java.awt.Color	getMarkerColor() Retrieves the fill color for the markers of the series.
int	getMarkerShape() Retrieves the shape for the data markers that belong to the series.
int	getMarkerType() Retrieves the type of markers used for the series.
int	getPieSliceExplode() Retrieves the distance that separates an exploded slice from the rest of the pie in a pie graph or from the rest of the ring in a ring graph.
SpecialEffects	getSpecialEffects()
int	getVisibility() Get the visibility of the series.
boolean	isAssignedToY2() Indicates whether the series of data is plotted against the Y2-axis.
boolean	isBorderTransparent() Indicates whether the borders for the markers of the series are transparent.
protected void	resetStyleProperties()
void	restoreState(javax.faces.context.FacesContext context, java.lang.Object stateObj)
void	setAssignedToY2(boolean y2) Specifies whether the series of data is plotted against the Y2-axis.
void	setBorderColor(java.awt.Color newColor) Specifies the border color of the series.
void	setBorderTransparent(boolean yesNo) Specifies whether the borders for the markers of the series are transparent.
void	setColor(java.awt.Color newColor) Specifies the fill color of the series.
void	setFitlineType(int type) Specifies the type of fitline, such as exponential, or logarithmic, to display for a series.
void	setIndex(int index) Specifies the index for this series
void	setLineStyle(int style) Specifies the style of the data line for the specified series.
void	setLineWidth(int width) Specifies the width for the data lines for this series.
void	setMarkerColor(java.awt.Color newColor) Specifies the fill color for the markers of the series.
void	setMarkerShape(int shape) Specifies the shape for the data makers that belong to the series.
void	setMarkerType(int type) Specifies the type of markers used for the series.
void	setPieSliceExplode(int explode) Specifies how far the slices for the series are exploded.
void	setSpecialEffects(SpecialEffects sfx)
void	setVisibility(int visibility) Set the visibility of the series.

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

applyProperties, getBooleanProperty, getFacesBean, getId, getParent, getProperty, getPropertyKey, getSetAttributeIndex, isTransient, isUpdated, processSetAttribute, processSetAttributeAndAdd, 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

COLOR_KEY

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

INDEX_KEY

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

MARKER_COLOR_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey MARKER_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

FITLINE_TYPE_KEY

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

MARKER_TYPE_KEY

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

MARKER_SHAPE_KEY

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

ASSIGNED_TO_Y2_KEY

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

VISIBILITY_KEY

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

SFX_KEY

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

BORDER_COLOR_KEY

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

BORDER_TRANSPARENT_KEY

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

PIE_SLICE_EXPLODE_KEY

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

Constructor Detail

Series

public Series()

Method Detail

getColor

public java.awt.Color getColor()

Retrieves the fill color of the series.

Returns:

The fill color of the series. For transparent fill color, this returns null.

setColor

public void setColor(java.awt.Color newColor)

Specifies the fill color of the series.

Parameters:

newColor - The fill color of the series. If this is null, the fill color is made transparent.

getBorderColor

public java.awt.Color getBorderColor()

Retrieves the border color of the series.

Returns:

The border color of the series. For transparent border color, this returns null.

setBorderColor

public void setBorderColor(java.awt.Color newColor)

Specifies the border color of the series.

Parameters:

newColor - The border color of the series. If this is null, the border color is made transparent.

isBorderTransparent

public boolean isBorderTransparent()

Indicates whether the borders for the markers of the series are transparent.

Returns:

true if the borders are transparent, false if the borders are visible.

setBorderTransparent

public void setBorderTransparent(boolean yesNo)

Specifies whether the borders for the markers of the series are transparent.

Parameters:

yesNo - true to make the borders transparent, false to make the borders visible.

getMarkerColor

public java.awt.Color getMarkerColor()

Retrieves the fill color for the markers of the series.

Returns:

The fill color for the markers of the series. For transparent fill color, this returns null.

setMarkerColor

public void setMarkerColor(java.awt.Color newColor)

Specifies the fill color for the markers of the series.

Parameters:

newColor - The fill color for the markers of the series. If this is null, the fill color is made transparent.

setLineWidth

public void setLineWidth(int width)

Specifies the width for the data lines for this series.

The value that you set in this method takes effect only when the DepthRadius attribute of the graph is set to zero.

Parameters:

width - The width to set for the data line for the series.

getLineWidth

public int getLineWidth()

Retrieves the width for the data line for this series.

Returns:

The width of the data line for the series.

getLineStyle

public int getLineStyle()

Retrieves the style of the data line for the specified series.

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 data line for the specified series.

The value that you set in this method takes effect only when the DepthRadius property of the graph is set to zero.

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

setMarkerType

public void setMarkerType(int type)

Specifies the type of markers used for the series. Markers that belong to the same series are the same type.

Parameters:

type - The type of markers used for the series. Valid constants are listed in the See Also section.

See Also:

BaseGraphComponent.MT_AREA, BaseGraphComponent.MT_BAR, BaseGraphComponent.MT_MARKER, BaseGraphComponent.MT_DEFAULT

getMarkerType

public int getMarkerType()

Retrieves the type of markers used for the series. Markers that belong to the same series are the same type.

Returns:

The type of markers used for the series. Valid constants are listed in the See Also section.

See Also:

BaseGraphComponent.MT_AREA, BaseGraphComponent.MT_BAR, BaseGraphComponent.MT_MARKER, BaseGraphComponent.MT_DEFAULT

setMarkerShape

public void setMarkerShape(int shape)

Specifies the shape for the data makers that belong to the series. The MarkerShape property applies only to data markers that appear in line, scatter, and bubble graphs. It does not affect the shape of bars or slices.

Parameters:

shape - A constant that represents the shape for the data markers that belong to this series. Valid constants are listed in the See Also section.

See Also:

BaseGraphComponent.MS_AUTOMATIC, BaseGraphComponent.MS_NONE, BaseGraphComponent.MS_CIRCLE, BaseGraphComponent.MS_DIAMOND, BaseGraphComponent.MS_PLUS, BaseGraphComponent.MS_SQUARE, BaseGraphComponent.MS_TRIANGLE_DOWN, BaseGraphComponent.MS_TRIANGLE_UP

getMarkerShape

public int getMarkerShape()

Retrieves the shape for the data markers that belong to the series. The MarkerShape property applies only to data markers that appear in line, scatter, and bubble graphs. It does not affect the shape of bars or slices.

Returns:

A constant that represents the shape for the data markers that belong to the series. Constants are listed in the See Also section.

See Also:

BaseGraphComponent.MS_AUTOMATIC, BaseGraphComponent.MS_NONE, BaseGraphComponent.MS_CIRCLE, BaseGraphComponent.MS_DIAMOND, BaseGraphComponent.MS_PLUS, BaseGraphComponent.MS_SQUARE, BaseGraphComponent.MS_TRIANGLE_DOWN, BaseGraphComponent.MS_TRIANGLE_UP

setFitlineType

public void setFitlineType(int type)

Specifies the type of fitline, such as exponential, or logarithmic, to display for a series.

Parameters:

type - A constant that represents the type of fitline to use for this series. Valid constants are listed in the See Also section.

See Also:

Fitline, BaseGraphComponent.FT_LINEAR, BaseGraphComponent.FT_EXPONENTIAL, BaseGraphComponent.FT_LOGARITHMIC, BaseGraphComponent.FT_NONE

getFitlineType

public int getFitlineType()

Retrieves the type of fitline for a series.

Returns:

A constant that represents the type of fitline for this series. Valid constants are listed in the See Also section.

See Also:

BaseGraphComponent.FT_LINEAR, BaseGraphComponent.FT_EXPONENTIAL, BaseGraphComponent.FT_LOGARITHMIC, BaseGraphComponent.FT_NONE

setAssignedToY2

public void setAssignedToY2(boolean y2)

Specifies whether the series of data is plotted against the Y2-axis.

Parameters:

yesNo - true to plot the series of data against the Y2-axis, false to plot it against the Y1-axis.

isAssignedToY2

public boolean isAssignedToY2()

Indicates whether the series of data is plotted against the Y2-axis.

Returns:

true if the series of data is plotted against the Y2-axis, false if it is plotted against the Y1-axis.

getPieSliceExplode

public int getPieSliceExplode()

Retrieves the distance that separates an exploded slice from the rest of the pie in a pie graph or from the rest of the ring in a ring graph. Exploded slices are pulled apart from the rest of the pie or ring that they belong to. The values range from 0 to 100.

Returns:

How far the slices for the series are exploded.

setPieSliceExplode

public void setPieSliceExplode(int explode)

Specifies how far the slices for the series are exploded. Exploded slices are pulled apart from the rest of the pie that they belong to. The values range from 0 to 100.

Parameters:

explode - How far the slices for the series are exploded.

setVisibility

public void setVisibility(int visibility)

Set the visibility of the series.

Parameters:

visibility - The visibility of the series. Constants are defined in BaseGraphComponent and begin with SV_.

See Also:

BaseGraphComponent.SV_VISIBLE, BaseGraphComponent.SV_HIDDEN

getVisibility

public int getVisibility()

Get the visibility of the series.

Returns:

The visibility of the series. Constants are defined in BaseGraphComponent and begin with SV_.

See Also:

BaseGraphComponent.SV_VISIBLE, BaseGraphComponent.SV_HIDDEN

restoreState

public void restoreState(javax.faces.context.FacesContext context,
                         java.lang.Object stateObj)

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class BIComplexAttributeBase

getSpecialEffects

public SpecialEffects getSpecialEffects()

setIndex

public void setIndex(int index)

Specifies the index for this series

getIndex

public int getIndex()

Retrieves the index for this series.

Returns:

The index for the series.

setSpecialEffects

public void setSpecialEffects(SpecialEffects sfx)

resetStyleProperties

protected void resetStyleProperties()

getBeanType

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

Specified by:

getBeanType in class BIComplexAttributeBase