com.infragistics.faces.chart.component
Class Chart

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          com.infragistics.faces.chart.component.Chart

All Implemented Interfaces:

ISeriesBase, ISeriesGroup, javax.faces.component.StateHolder

Direct Known Subclasses:

HtmlChart

public class Chart

extends javax.faces.component.UIComponentBase

implements ISeriesGroup

Chart components represent a top-level user chart.

Individual chart components may contain nested legends, captions, series, series groups or chart components.

Field Summary

static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static java.lang.String	RENDERER_TYPE

Constructor Summary

Chart()

Method Summary

void	broadcast(javax.faces.event.FacesEvent event)
void	dataBind(javax.faces.context.FacesContext context)
void	encodeBegin(javax.faces.context.FacesContext context)
java.util.List	getAxes() Returns the collection of nested axis objects associated with this chart.
Caption	getCaption() Returns the nested caption object associated with this chart.
java.lang.String	getChartType() Returns the chart type for nested series.
java.lang.String	getDataMapping() Returns the data mapping used to convert the external data model to internal names.
javax.faces.el.MethodBinding	getDataPointListener() Returns the MethodBinding representing a DataPointListener method that is notified of a DataPointEvent each time a datapoint or series is clicked by the user
javax.faces.model.DataModel	getDataSource() Returns the data source used to create the individual data points for this series.
java.lang.String	getFamily()
java.lang.String	getGroupType() Returns the grouping type applied to nested series.
Legend	getLegend() Returns the nested legend component associated with this chart.
java.util.List	getLights() Returns the collection of nested light components associated with this chart.
java.lang.String	getPaneStyle() Returns the CSS style applied to the chart background when this chart is rendered.
java.lang.String	getPaneStyleClass() Returns the CSS style class applied to the chart background when this chart is rendered.
float	getPerspective() Returns the perspective (0.0 to 1.0) used to render three dimensional charts.
java.lang.String	getProjectionType() Returns the projectionType for this chart.
java.lang.String	getRotation() Returns the rotation used to render three dimensional charts.
java.util.List	getSeries() Returns the collection of nested series and series groups associated with this chart.
java.lang.String	getStyle() Returns the CSS style applied when this chart is rendered.
java.lang.String	getStyleClass() Returns the CSS style class applied when this chart is rendered.
boolean	hasPerspective() Returns true if this chart defines a perspective setting.
boolean	isAutoLayout() Returns the layout mode for child legends, captions and nested charts.
void	restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
java.lang.Object	saveState(javax.faces.context.FacesContext context)
void	setAutoLayout(boolean autoLayout) Sets the layout mode for child legends, captions and nested charts.
void	setAxes(java.util.List axes) Sets the collection of Axis objects applied to all nested series.
void	setCaption(Caption caption) Sets the nested caption object associated with this chart.
void	setChartType(java.lang.String chartType) Sets the chart type for nested series.
void	setDataMapping(java.lang.String dataMapping) Sets the data mapping used to convert the external data model to internal names.
void	setDataPointListener(javax.faces.el.MethodBinding dataPointListener) Sets the MethodBinding that represents a DataPointListener method that is notified of a DataPointEvent each time a datapoint or series is clicked by the user.
void	setDataSource(javax.faces.model.DataModel dataSource) Sets the data source used to create the individual data points for this series.
void	setGroupType(java.lang.String groupType) Sets the grouping type applied to nested series.
void	setLegend(Legend legend) Sets the legend component associated with this chart.
void	setLights(java.util.List lights) Sets the collection of nested light components.
void	setPaneStyle(java.lang.String paneStyle) Sets the CSS style applied to the chart background when this chart is rendered.
void	setPaneStyleClass(java.lang.String paneStyleClass) Sets the CSS style class applied to the chart background when this chart is rendered.
void	setPerspective(float perspective) Sets the perspective (0.0 to 1.0) used to render three dimensional charts.
void	setProjectionType(java.lang.String projectionType) Sets the projectionType for this chart.
void	setRotation(java.lang.String rotation) Sets the rotation used to render three dimensional charts.
void	setSeries(java.util.List series) Sets the collection of nested series and series groups.
void	setStyle(java.lang.String style) Sets the CSS style applied when this chart is rendered.
void	setStyleClass(java.lang.String styleClass) Sets the CSS style class applied when this chart is rendered.

Methods inherited from class javax.faces.component.UIComponentBase

decode, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods inherited from class java.lang.Object

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

Field Detail

COMPONENT_FAMILY

public static java.lang.String COMPONENT_FAMILY

COMPONENT_TYPE

public static java.lang.String COMPONENT_TYPE

RENDERER_TYPE

public static java.lang.String RENDERER_TYPE

Constructor Detail

Chart

public Chart()

Method Detail

getPaneStyle

public java.lang.String getPaneStyle()

Returns the CSS style applied to the chart background when this chart is rendered.

Returns:

java.lang.String

getPaneStyleClass

public java.lang.String getPaneStyleClass()

Returns the CSS style class applied to the chart background when this chart is rendered.

Returns:

java.lang.String

setPaneStyle

public void setPaneStyle(java.lang.String paneStyle)

Sets the CSS style applied to the chart background when this chart is rendered.

Parameters:

paneStyle - String

setPaneStyleClass

public void setPaneStyleClass(java.lang.String paneStyleClass)

Sets the CSS style class applied to the chart background when this chart is rendered.

Parameters:

paneStyleClass - String

getFamily

public java.lang.String getFamily()

isAutoLayout

public boolean isAutoLayout()

Returns the layout mode for child legends, captions and nested charts.

Returns:

boolean

getAxes

public java.util.List getAxes()

Returns the collection of nested axis objects associated with this chart.

Specified by:

getAxes in interface ISeriesBase

Returns:

com.infragistics.faces.chart.component.Axis

getCaption

public Caption getCaption()

Returns the nested caption object associated with this chart.

Returns:

com.infragistics.faces.chart.component.Caption

getChartType

public java.lang.String getChartType()

Returns the chart type for nested series.

Specified by:

getChartType in interface ISeriesBase

Returns:

com.infragistics.faces.chart.enumeration.ChartType (area, column, doughnut, line, pie, rangeArea, rangeColumn)

getGroupType

public java.lang.String getGroupType()

Returns the grouping type applied to nested series.

Specified by:

getGroupType in interface ISeriesGroup

Returns:

com.infragistics.faces.chart.enumeration.SeriesGroupType (cluster, overlay, stack, stack100)

getDataPointListener

public javax.faces.el.MethodBinding getDataPointListener()

Returns the MethodBinding representing a DataPointListener method that is notified of a DataPointEvent each time a datapoint or series is clicked by the user

Returns:

javax.faces.el.MethodBinding

getDataSource

public javax.faces.model.DataModel getDataSource()

Returns the data source used to create the individual data points for this series.

Specified by:

getDataSource in interface ISeriesBase

Returns:

javax.faces.model.DataModel

getDataMapping

public java.lang.String getDataMapping()

Returns the data mapping used to convert the external data model to internal names.

Specified by:

getDataMapping in interface ISeriesBase

Returns:

java.lang.String

getLegend

public Legend getLegend()

Returns the nested legend component associated with this chart.

Returns:

com.infragistics.faces.chart.component.Legend

getLights

public java.util.List getLights()

Returns the collection of nested light components associated with this chart.

Returns:

com.infragistics.faces.chart.component.Light

hasPerspective

public boolean hasPerspective()

Returns true if this chart defines a perspective setting.

Returns:

com.infragistics.faces.chart.component.Legend

getPerspective

public float getPerspective()

Returns the perspective (0.0 to 1.0) used to render three dimensional charts.

Returns:

float

getProjectionType

public java.lang.String getProjectionType()

Returns the projectionType for this chart.

Returns:

com.infragistics.faces.chart.enumeration.ProjectionType (oblique, 3d, 2d)

getRotation

public java.lang.String getRotation()

Returns the rotation used to render three dimensional charts.

Returns:

java.lang.String

getSeries

public java.util.List getSeries()

Returns the collection of nested series and series groups associated with this chart.

Specified by:

getSeries in interface ISeriesGroup

Returns:

com.infragistics.faces.chart.component.ISeriesBase

getStyle

public java.lang.String getStyle()

Returns the CSS style applied when this chart is rendered.

Returns:

java.lang.String

getStyleClass

public java.lang.String getStyleClass()

Returns the CSS style class applied when this chart is rendered.

Returns:

java.lang.String

setAutoLayout

public void setAutoLayout(boolean autoLayout)

Sets the layout mode for child legends, captions and nested charts.

Parameters:

autoLayout - boolean

setAxes

public void setAxes(java.util.List axes)

Sets the collection of Axis objects applied to all nested series.

Specified by:

setAxes in interface ISeriesBase

Parameters:

axes - java.util.List

setCaption

public void setCaption(Caption caption)

Sets the nested caption object associated with this chart.

Parameters:

caption - Caption

setChartType

public void setChartType(java.lang.String chartType)

Sets the chart type for nested series.

Specified by:

setChartType in interface ISeriesBase

Parameters:

chartType - String (area, column, doughnut, line, pie, rangeArea, rangeColumn)

setDataMapping

public void setDataMapping(java.lang.String dataMapping)

Sets the data mapping used to convert the external data model to internal names.

Specified by:

setDataMapping in interface ISeriesBase

Parameters:

dataMapping - String

setDataPointListener

public void setDataPointListener(javax.faces.el.MethodBinding dataPointListener)

Sets the MethodBinding that represents a DataPointListener method that is notified of a DataPointEvent each time a datapoint or series is clicked by the user.

Parameters:

dataPointListener - MethodBinding

setDataSource

public void setDataSource(javax.faces.model.DataModel dataSource)

Sets the data source used to create the individual data points for this series.

Specified by:

setDataSource in interface ISeriesBase

Parameters:

dataSource - DataModel

setGroupType

public void setGroupType(java.lang.String groupType)

Sets the grouping type applied to nested series.

Specified by:

setGroupType in interface ISeriesGroup

Parameters:

groupType - String (cluster, overlay, stack, stack100)

setLegend

public void setLegend(Legend legend)

Sets the legend component associated with this chart.

Parameters:

legend - Legend

setLights

public void setLights(java.util.List lights)

Sets the collection of nested light components.

Parameters:

lights - java.util.List

setPerspective

public void setPerspective(float perspective)

Sets the perspective (0.0 to 1.0) used to render three dimensional charts.

Parameters:

perspective - float

setProjectionType

public void setProjectionType(java.lang.String projectionType)

Sets the projectionType for this chart.

Parameters:

projectionType - String (oblique, 3d, 2d)

setRotation

public void setRotation(java.lang.String rotation)

Sets the rotation used to render three dimensional charts.

Parameters:

rotation - String

setSeries

public void setSeries(java.util.List series)

Sets the collection of nested series and series groups.

Specified by:

setSeries in interface ISeriesGroup

Parameters:

series - java.util.List

setStyle

public void setStyle(java.lang.String style)

Sets the CSS style applied when this chart is rendered.

Parameters:

style - String

setStyleClass

public void setStyleClass(java.lang.String styleClass)

Sets the CSS style class applied when this chart is rendered.

Parameters:

styleClass - String

restoreState

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

Specified by:

restoreState in interface javax.faces.component.StateHolder

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext context)

Specified by:

saveState in interface javax.faces.component.StateHolder

broadcast

public void broadcast(javax.faces.event.FacesEvent event)
               throws javax.faces.event.AbortProcessingException

Throws:

javax.faces.event.AbortProcessingException

dataBind

public void dataBind(javax.faces.context.FacesContext context)

Parameters:

context -

encodeBegin

public void encodeBegin(javax.faces.context.FacesContext context)
                 throws java.io.IOException

Throws:

java.io.IOException