edu.wright.hendrix11.d3.chart

Class ChartComponent

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

edu.wright.hendrix11.d3.MasterComponent

edu.wright.hendrix11.d3.chart.ChartComponent

All Implemented Interfaces:

EventListener, PartialStateHolder, StateHolder, TransientStateHolder, ComponentSystemEventListener, FacesListener, SystemEventListenerHolder

public class ChartComponent
extends MasterComponent

Author:

Joe Hendrix

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE
static String	DEFAULT_RENDERER

Fields inherited from class javax.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Constructor Summary

Constructors

Constructor and Description
ChartComponent()

Method Summary

Modifier and Type	Method and Description
ChartModel	getChartModel() Returns the Java object holding the chart data and data configuration.
String	getFamily()
Boolean	getGridX() Returns whether to show the grid along the x axis.
Boolean	getGridY() Returns whether to show the grid along the y axis.
String	getLegendPosition() Returns where to show the legend.
Boolean	getShowLegend() Returns whether to show the legend.
String	getTitle() Returns the title of the chart.
String	getType() Returns the type of chart to render.
void	setChartModel(ChartModel model) Sets the Java object holding the chart data and data configuration.
void	setGridX(Boolean gridX) Sets whether to show the grid along the x axis.
void	setGridY(Boolean gridY) Sets whether to show the grid along the y axis.
void	setLegendPosition(String legendPosition) Sets where to show the legend.
void	setShowLegend(Boolean showLegend) Sets whether to show the legend.
void	setTitle(String title) Sets the title of the chart.
void	setType(String type) Sets the type of chart to render.

Methods inherited from class edu.wright.hendrix11.d3.MasterComponent

getStyle, getStyleClass, setStyle, setStyleClass

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree

Methods inherited from class java.lang.Object

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

Field Detail

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

See Also:

Constant Field Values

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

DEFAULT_RENDERER

public static final String DEFAULT_RENDERER

See Also:

Constant Field Values

Constructor Detail

ChartComponent

public ChartComponent()

Method Detail

getFamily

public String getFamily()

Specified by:

getFamily in class UIComponent

getGridX

public Boolean getGridX()

Returns whether to show the grid along the x axis.

Returns:

Boolean whether to show the grid along the x axis

setGridX

public void setGridX(Boolean gridX)

Sets whether to show the grid along the x axis.

Parameters:

gridX - whether to show the grid along the x axis

getShowLegend

public Boolean getShowLegend()

Returns whether to show the legend.

Returns:

Boolean whether to show the legend

setShowLegend

public void setShowLegend(Boolean showLegend)

Sets whether to show the legend.

Parameters:

showLegend - whether to show the legend

getGridY

public Boolean getGridY()

Returns whether to show the grid along the y axis.

Returns:

Boolean whether to show the grid along the y axis

setGridY

public void setGridY(Boolean gridY)

Sets whether to show the grid along the y axis.

Parameters:

gridY - whether to show the grid along the y axis

getType

public String getType()

Returns the type of chart to render. Available values are:

• line
• spline
• step
• area
• area-spline
• area-step
• bar
• scatter
• pie
• donut
• gauge

Returns:

String the type of chart to render

setType

public void setType(String type)

Sets the type of chart to render. Available values are:

• line
• spline
• step
• area
• area-spline
• area-step
• bar
• scatter
• pie
• donut
• gauge

Parameters:

type - the type of chart to render

getTitle

public String getTitle()

Returns the title of the chart.

Returns:

String the title of the chart

setTitle

public void setTitle(String title)

Sets the title of the chart.

Parameters:

title - the title of the chart

getLegendPosition

public String getLegendPosition()

Returns where to show the legend. Possible values include:

• bottom
• right
• inset

Returns:

String where to show the legend

setLegendPosition

public void setLegendPosition(String legendPosition)

Sets where to show the legend. Possible values include:

• bottom
• right
• inset

Parameters:

legendPosition - where to show the legend

getChartModel

public ChartModel getChartModel()

Returns the Java object holding the chart data and data configuration.

Returns:

the Java object holding the chart data and data configuration

setChartModel

public void setChartModel(ChartModel model)

Sets the Java object holding the chart data and data configuration.

Parameters:

model - the Java object holding the chart data and data configuration