Skip navigation links

org.apache.myfaces.trinidad.component
Class UIXChart

java.lang.Object
javax.faces.component.UIComponent
org.apache.myfaces.trinidad.component.UIXComponent
org.apache.myfaces.trinidad.component.UIXComponentBase
org.apache.myfaces.trinidad.component.UIXChart

All Implemented Interfaces:

javax.faces.component.StateHolder

Direct Known Subclasses:

CoreChart

public class UIXChart

extends UIXComponentBase

<html:p> The Apache Trinidad Chart is used to display data in a Chart Format. </html:p>

Events:

Type	Phases	Description
org.apache.myfaces.trinidad.event.AttributeChangeEvent	Invoke Application Apply Request Values	Event delivered to describe an attribute change. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.

Field Summary

static PropertyKey	CHART_DRILL_DOWN_LISTENER_KEY
static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static FacesBean.Type	TYPE
static PropertyKey	VALUE_KEY

Fields inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY

Fields inherited from class javax.faces.component.UIComponent

bindings

Constructor Summary

	UIXChart() Construct an instance of the UIXChart.
protected	UIXChart(java.lang.String rendererType) Construct an instance of the UIXChart.

Method Summary

void	addChartDrillDownListener(ChartDrillDownListener listener) Adds a drilldown listener.
void	broadcast(javax.faces.event.FacesEvent event) Delivers an event to the appropriate listeners.
protected FacesBean.Type	getBeanType()
javax.el.MethodExpression	getChartDrillDownListener() Gets a method reference to a drill down listener that will be called when the user drills down into the chart data.The method must take a parameter of type org.apache.myfaces.trinidad.event.ChartDrillDownEvent.
java.lang.String	getFamily()
java.lang.Object	getValue() Gets the data model being used by this component.The specific model class must be derived from org.apache.myfaces.trinidad.model.ChartModel.
void	removeChartDrillDownListener(ChartDrillDownListener listener) Removes a drilldown listener.
void	setChartDrillDownListener(javax.el.MethodExpression chartDrillDownListener) Sets a method reference to a drill down listener that will be called when the user drills down into the chart data.The method must take a parameter of type org.apache.myfaces.trinidad.event.ChartDrillDownEvent.
void	setValue(java.lang.Object value) Sets the data model being used by this component.The specific model class must be derived from org.apache.myfaces.trinidad.model.ChartModel.

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getComponentChangeFilters, getContainerClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getParent, getProperty, getPropertyKey, getRenderedFacetsAndChildren, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, invokeOnChildrenComponents, invokeOnComponent, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeAttributeChangeListener, removeComponentChangeFilter, removeFacesListener, restoreState, satisfiesPartialTrigger, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression, toString, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponent

addPartialTarget, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setUpEncodingContext, setupVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitTree, visitTree

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getContainerClientId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TYPE

public static final FacesBean.Type TYPE

VALUE_KEY

public static final PropertyKey VALUE_KEY

CHART_DRILL_DOWN_LISTENER_KEY

public static final PropertyKey CHART_DRILL_DOWN_LISTENER_KEY

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

See Also:

Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

Constructor Detail

UIXChart

public UIXChart()

Construct an instance of the UIXChart.

UIXChart

protected UIXChart(java.lang.String rendererType)

Construct an instance of the UIXChart.

Method Detail

broadcast

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

Delivers an event to the appropriate listeners.

Overrides:

broadcast in class UIXComponentBase

Parameters:

event -

Throws:

javax.faces.event.AbortProcessingException

addChartDrillDownListener

public final void addChartDrillDownListener(ChartDrillDownListener listener)

Adds a drilldown listener.

Parameters:

listener - the selection listener to add

removeChartDrillDownListener

public final void removeChartDrillDownListener(ChartDrillDownListener listener)

Removes a drilldown listener.

Parameters:

listener - the selection listener to remove

getValue

public final java.lang.Object getValue()

Gets the data model being used by this component.The specific model class must be derived from org.apache.myfaces.trinidad.model.ChartModel. The derived class must override the abstract methods to provide the required values for chart display.

Returns:

the new value value

setValue

public final void setValue(java.lang.Object value)

Sets the data model being used by this component.The specific model class must be derived from org.apache.myfaces.trinidad.model.ChartModel. The derived class must override the abstract methods to provide the required values for chart display.

Parameters:

value - the new value value

getChartDrillDownListener

public final javax.el.MethodExpression getChartDrillDownListener()

Gets a method reference to a drill down listener that will be called when the user drills down into the chart data.The method must take a parameter of type org.apache.myfaces.trinidad.event.ChartDrillDownEvent.

Returns:

the new chartDrillDownListener value

setChartDrillDownListener

public final void setChartDrillDownListener(javax.el.MethodExpression chartDrillDownListener)

Sets a method reference to a drill down listener that will be called when the user drills down into the chart data.The method must take a parameter of type org.apache.myfaces.trinidad.event.ChartDrillDownEvent.

Parameters:

chartDrillDownListener - the new chartDrillDownListener value

getFamily

public java.lang.String getFamily()

Specified by:

getFamily in class UIXComponentBase

getBeanType

protected FacesBean.Type getBeanType()

Overrides:

getBeanType in class UIXComponentBase

Skip navigation links