Oracle Fusion Middleware Java API Reference for Oracle ADF Data Visualization Components
11g Release 1 (11.1.1.1.0)

E12063-02

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

java.lang.Object
  extended by oracle.adf.view.faces.bi.component.BIComplexAttributeBase
      extended by oracle.adf.view.faces.bi.component.graph.SeriesSet
All Implemented Interfaces:
javax.faces.component.StateHolder

public class SeriesSet
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 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 SERIES_MAP_KEY
           
static BIFacesBeanImpl.Type TYPE
           
 
Fields inherited from class oracle.adf.view.faces.bi.component.BIComplexAttributeBase
ID_KEY, m_parent, TRANSIENT_KEY
 
Constructor Summary
SeriesSet()
           
 
Method Summary
 void applyProperties(java.util.HashMap map)
          Applications do not need to call this method.
protected  org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
           
 int getDefaultAssignedToY2()
          Retrieves the default axis assignment for series.
 java.awt.Color getDefaultBorderColor()
          Retrieves the default border color of the series.
 java.awt.Color getDefaultColor()
          Retrieves the default fill color of series.
 int getDefaultFitlineType()
          Retrieves the default type of fitline for all series.
 int getDefaultLineWidth()
          Retrieves the default width for the data lines of series.
 java.awt.Color getDefaultMarkerColor()
          Retrieves the default fill color for the markers of series.
 int getDefaultMarkerShape()
          Retrieves the default shape for the data makers of series.
 int getDefaultMarkerType()
          Retrieves the default type of markers used for series.
 Series getSeries(int i, boolean createNew)
           
 java.util.Map getSeriesMap()
           
 boolean isDefaultBorderTransparent()
          Indicates whether the borders for the markers of the series are transparent.
protected  void resetStyleProperties()
           
 void setDefaultAssignedToY2(int assignedToY2)
          Specifies the default axis assignment for series.
 void setDefaultBorderColor(java.awt.Color newColor)
          Specifies the default border color of the series.
 void setDefaultBorderTransparent(boolean yesNo)
          Specifies whether the borders for the markers of the series are transparent.
 void setDefaultColor(java.awt.Color color)
          Specifies the default fill color of series.
 void setDefaultFitlineType(int type)
          Specifies the default type of fitline to use for series.
 void setDefaultLineWidth(int width)
          Specifies the default width for the data lines of series.
 void setDefaultMarkerColor(java.awt.Color color)
          Specifies the default fill color for the markers of series.
 void setDefaultMarkerShape(int shape)
          Specifies the default shape for the data markers of series.
 void setDefaultMarkerType(int type)
          Specifies the default marker type for series.
 void setSeriesMap(java.util.Map map)
           
 
Methods inherited from class oracle.adf.view.faces.bi.component.BIComplexAttributeBase
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 BIFacesBeanImpl.Type TYPE

COLOR_KEY

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

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

SERIES_MAP_KEY

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

SeriesSet

public SeriesSet()
Method Detail

setDefaultAssignedToY2

public void setDefaultAssignedToY2(int assignedToY2)
Specifies the default axis assignment for series.

Parameters:
assignedToY2 - A constant that represents the default axis assignment. Valid constants are listed in the See Also section.
See Also:
BaseGraphComponent.DY2_TRUE, BaseGraphComponent.DY2_FALSE, BaseGraphComponent.DY2_AUTO_ASSIGN

getDefaultAssignedToY2

public int getDefaultAssignedToY2()
Retrieves the default axis assignment for series.

Returns:
A constant that represents the default axis assignment. Valid constants are listed in the See Also section.
See Also:
BaseGraphComponent.DY2_TRUE, BaseGraphComponent.DY2_FALSE, BaseGraphComponent.DY2_AUTO_ASSIGN

setDefaultColor

public void setDefaultColor(java.awt.Color color)
Specifies the default fill color of series.

Parameters:
color - The default fill color for the markers of series. If color is null, then the graph assigns its own default colors to series, repeating colors as necessary.
See Also:
#setColor

getDefaultColor

public java.awt.Color getDefaultColor()
Retrieves the default fill color of series.

Returns:
The default fill color for the markers of series. If color is null, then the graph assigns its own default colors to series, repeating colors as necessary.
See Also:
#getColor

getDefaultBorderColor

public java.awt.Color getDefaultBorderColor()
Retrieves the default border color of the series.

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

setDefaultBorderColor

public void setDefaultBorderColor(java.awt.Color newColor)
Specifies the default border color of the series.

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

isDefaultBorderTransparent

public boolean isDefaultBorderTransparent()
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.

setDefaultBorderTransparent

public void setDefaultBorderTransparent(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.

setDefaultMarkerColor

public void setDefaultMarkerColor(java.awt.Color color)
Specifies the default fill color for the markers of series.

Parameters:
color - The default fill color for the markers of series. If color is null, then the graph assigns its own default colors to series, repeating colors as necessary.
See Also:
#setColor

getDefaultMarkerColor

public java.awt.Color getDefaultMarkerColor()
Retrieves the default fill color for the markers of series.

Returns:
The default fill color for the markers of series. If color is null, then the graph assigns its own default colors to series, repeating colors as necessary.
See Also:
#getColor

setDefaultFitlineType

public void setDefaultFitlineType(int type)
Specifies the default type of fitline to use for series. The graph supports linear, exponential, and logarithmic fitlines.

Parameters:
type - A constant that represents the default type of fitline for series. Valid constants are listed in the See Also section.
See Also:
BaseGraphComponent.FT_EXPONENTIAL, BaseGraphComponent.FT_LOGARITHMIC, BaseGraphComponent.FT_LINEAR, BaseGraphComponent.FT_NONE

getDefaultFitlineType

public int getDefaultFitlineType()
Retrieves the default type of fitline for all series. The graph supports linear, exponential, and logarithmic fitlines.

Returns:
A constant that represents the default type of fitline for series. Valid constants are listed in the See Also section.
See Also:
BaseGraphComponent.FT_EXPONENTIAL, BaseGraphComponent.FT_LOGARITHMIC, BaseGraphComponent.FT_LINEAR, BaseGraphComponent.FT_NONE

setDefaultLineWidth

public void setDefaultLineWidth(int width)
Specifies the default width for the data lines of series. All of the data lines are the same width.

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

Parameters:
lineWidth - The default width for the data lines of series.
See Also:
Graph#setDepthRadius

getDefaultLineWidth

public int getDefaultLineWidth()
Retrieves the default width for the data lines of series.

Returns:
The default width for the data lines of series.

setDefaultMarkerShape

public void setDefaultMarkerShape(int shape)
Specifies the default shape for the data markers of series.

Parameters:
markerShape - A constant that represents the default shape for the data markers of series. Valid constants are listed in the See Also section. If marker shape is automatic, then the graph assigns its default shapes, repeating shapes if necessary.
See Also:
BaseGraphComponent.MS_CIRCLE, BaseGraphComponent.MS_DIAMOND, BaseGraphComponent.MS_NONE, BaseGraphComponent.MS_PLUS, BaseGraphComponent.MS_SQUARE, BaseGraphComponent.MS_TRIANGLE_DOWN, BaseGraphComponent.MS_TRIANGLE_UP, BaseGraphComponent.MS_AUTOMATIC

getDefaultMarkerShape

public int getDefaultMarkerShape()
Retrieves the default shape for the data makers of series.

Returns:
A constant that represents the default shape for the data markers of series. Valid constants are listed in the See Also section. If the marker shape is automatic, then the graph assigns its default shapes, repeating shapes if necessary.
See Also:
BaseGraphComponent.MS_CIRCLE, BaseGraphComponent.MS_DIAMOND, BaseGraphComponent.MS_NONE, BaseGraphComponent.MS_PLUS, BaseGraphComponent.MS_SQUARE, BaseGraphComponent.MS_TRIANGLE_DOWN, BaseGraphComponent.MS_TRIANGLE_UP, BaseGraphComponent.MS_AUTOMATIC

setDefaultMarkerType

public void setDefaultMarkerType(int type)
Specifies the default marker type for series. Markers in a single series have the same type. This method specifies a default type for all series.

Parameters:
markerType - The default type of markers used for series.
See Also:
BaseGraphComponent.MT_AREA, BaseGraphComponent.MT_BAR, BaseGraphComponent.MT_DEFAULT, BaseGraphComponent.MT_MARKER

getDefaultMarkerType

public int getDefaultMarkerType()
Retrieves the default type of markers used for series. Markers in a single series have the same type. This method specifies a default type for series.

Returns:
The default type of markers used for series.
See Also:
BaseGraphComponent.MT_AREA, BaseGraphComponent.MT_BAR, BaseGraphComponent.MT_DEFAULT, BaseGraphComponent.MT_MARKER

applyProperties

public void applyProperties(java.util.HashMap map)
Applications do not need to call this method. This is for internal use.

Overrides:
applyProperties in class BIComplexAttributeBase
Parameters:
map - hashMap that contains property value pairs.

resetStyleProperties

protected void resetStyleProperties()

getSeries

public Series getSeries(int i,
                        boolean createNew)

setSeriesMap

public void setSeriesMap(java.util.Map map)

getSeriesMap

public java.util.Map getSeriesMap()

getBeanType

protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
Specified by:
getBeanType in class BIComplexAttributeBase

Oracle Fusion Middleware Java API Reference for Oracle ADF Data Visualization Components
11g Release 1 (11.1.1.1.0)

E12063-02

Copyright © 1997, 2009, Oracle. All rights reserved.