org.apache.myfaces.trinidad.component
Class UIXChart

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by org.apache.myfaces.trinidad.component.UIXComponent
          extended by org.apache.myfaces.trinidad.component.UIXComponentBase
              extended by org.apache.myfaces.trinidad.component.UIXChart
All Implemented Interfaces:
EventListener, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder
Direct Known Subclasses:
CoreChart

public class UIXChart
extends UIXComponentBase

The Apache Trinidad Chart is used to display data in a Chart Format.

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 event might include the width of a column that supported client-side resizing.


Field Summary
static PropertyKey CHART_DRILL_DOWN_LISTENER_KEY
           
static String COMPONENT_FAMILY
           
static 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
BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY
 
Constructor Summary
  UIXChart()
          Construct an instance of the UIXChart.
protected UIXChart(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.
 String getFamily()
           
 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(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, addClientBehavior, addComponentChange, addComponentChange, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, clearInitialState, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientBehaviors, getClientId, getContainerClientId, getDefaultEventName, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getListenersForEventClass, getParent, getProperty, getPropertyKey, getRenderedFacetsAndChildren, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, initialStateMarked, invokeOnChildrenComponents, invokeOnComponent, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeAttributeChangeListener, removeFacesListener, restoreState, satisfiesPartialTrigger, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setupFlattenedChildrenContext, setupFlattenedContext, setValueBinding, setValueExpression, subscribeToEvent, tearDownFlattenedChildrenContext, tearDownFlattenedContext, toString, unsubscribeFromEvent, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl
 
Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponent
addPartialTarget, clearCachedClientIds, clearCachedClientIds, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, getStateHelper, getStateHelper, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setupChildrenEncodingContext, setupChildrenVisitingContext, setupEncodingContext, setUpEncodingContext, setupVisitingContext, tearDownChildrenEncodingContext, tearDownChildrenVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitAllChildren, visitChildren, visitChildren, visitTree, visitTree
 
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, setInView
 
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 String COMPONENT_FAMILY
See Also:
Constant Field Values

COMPONENT_TYPE

public static final String COMPONENT_TYPE
See Also:
Constant Field Values
Constructor Detail

UIXChart

public UIXChart()
Construct an instance of the UIXChart.


UIXChart

protected UIXChart(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 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(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 String getFamily()
Specified by:
getFamily in class UIXComponentBase

getBeanType

protected FacesBean.Type getBeanType()
Overrides:
getBeanType in class UIXComponentBase


Copyright © 2001-2012 The Apache Software Foundation. All Rights Reserved.