com.extjs.gxt.charts.client
Class Chart

java.lang.Object
  extended by com.google.gwt.user.client.ui.UIObject
      extended by com.google.gwt.user.client.ui.Widget
          extended by com.extjs.gxt.ui.client.widget.Component
              extended by com.extjs.gxt.ui.client.widget.BoxComponent
                  extended by com.extjs.gxt.ui.client.widget.flash.FlashComponent
                      extended by com.extjs.gxt.charts.client.Chart
All Implemented Interfaces:
Observable, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.IsWidget

public class Chart
extends FlashComponent

Chart component that uses the Open Flash Chart flash charting library. See http://teethgrinder.co.uk/open-flash-chart-2.

Events:
Ready : ChartEvent(chart)
Fires after the chart is ready.
ChartClick : ChartEvent(chart, chartModel, chartConfig, dataConfig, value)
Fires after a data point is clicked.


Nested Class Summary
 
Nested classes/interfaces inherited from class com.extjs.gxt.ui.client.widget.flash.FlashComponent
FlashComponent.WMode
 
Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject
com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled
 
Field Summary
static EventType ChartClick
          ChartClick event type.
 
Fields inherited from class com.extjs.gxt.ui.client.widget.flash.FlashComponent
swfElement, swfObject
 
Fields inherited from class com.extjs.gxt.ui.client.widget.BoxComponent
adjustSize, cacheSizes, ensureVisibilityOnSizing, height, lastSize, layer, shim, width
 
Fields inherited from class com.extjs.gxt.ui.client.widget.Component
afterRender, attachables, baseStyle, disabled, disabledStyle, disableTextSelection, dummy, focusable, hidden, mask, maskMessage, maskMessageStyleName, monitorWindowResize, rendered, resizeHandler, setElementRender, stateId, swallowEvents, toolTip, windowResizeDelay, windowResizeTask
 
Fields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX
 
Constructor Summary
Chart(java.lang.String url)
          Creates a new chart using the given url.
 
Method Summary
 void addChartListener(ChartListener listener)
          Adds a chart listener.
 void delayedRefresh(int delay)
          Refreshes the chart using the current model data using a delay.
 ChartModel getChartModel()
          Returns the chart model.
 java.lang.String getJsonData()
          Returns the OFC API JSON data that the chart is using.
 boolean isLoaded()
          Returns the true is the chart has loaded correctly and is ready for configuration/updates
protected  void onAttach()
           
protected  void onClick(int configIndex, int dataIndex)
           
protected  void onDetach()
           
protected  java.lang.String onGetChartData()
           
protected  void onReady()
           
protected  void processModel(ChartModel model)
           
 void refresh()
          Refreshes the chart using the current model data.
 void removeChartListener(ChartListener listener)
          Removes the chart listener.
 void setChartModel(ChartModel model)
          Sets the chart model.
 void setJsonData(java.lang.String jsonData)
          Sets the chart data directly without using a chart model.
 
Methods inherited from class com.extjs.gxt.ui.client.widget.flash.FlashComponent
getExpressInstall, getFlashVersion, getSwfHeight, getSwfId, getSwfWidth, getWmode, injectFlash, isIeFixEnabled, onRender, setExpressInstall, setFlashVersion, setIeFixEnabled, setSwfHeight, setSwfId, setSwfWidth, setWmode
 
Methods inherited from class com.extjs.gxt.ui.client.widget.BoxComponent
adjustPosition, adjustSize, afterRender, createComponentEvent, getBounds, getHeight, getHeight, getPosition, getPositionEl, getResizeEl, getShadow, getShadowOffset, getShadowPosition, getSize, getWidth, getWidth, hideShadow, hideShim, hideUnders, isAutoHeight, isAutoWidth, isDeferHeight, isShim, onHide, onPosition, onResize, onShow, onUnload, setAutoHeight, setAutoWidth, setBounds, setBounds, setDeferHeight, setHeight, setHeight, setPagePosition, setPagePosition, setPixelSize, setPosition, setShadow, setShadowOffset, setShadowPosition, setShim, setSize, setSize, setWidth, setWidth, sync, syncSize
 
Methods inherited from class com.extjs.gxt.ui.client.widget.Component
addAttachable, addListener, addPlugin, addStyleName, addStyleOnOver, addWidgetListener, applyState, assertAfterRender, assertPreRender, beforeRender, blur, clearState, createObservable, createStyles, disable, disableContextMenu, disableEvents, disableTextSelection, doAttachChildren, doDetachChildren, el, enable, enableEvents, fireEvent, fireEvent, fireEvent, fly, focus, frame, getAriaSupport, getBaseStyle, getBorders, getContextMenu, getData, getElement, getFocusEl, getFocusSupport, getHideMode, getId, getItemId, getListeners, getModel, getObservable, getPlugins, getState, getStateId, getTabIndex, getTitle, getToolTip, getWindowResizeDelay, hasListeners, hasListeners, hide, hideToolTip, initState, isDisabledEvents, isDisableTextSelection, isEnabled, isMasked, isMonitorWindowResize, isRendered, isStateful, isVisible, isVisible, mask, mask, mask, notifyHide, notifyShow, onBrowserEvent, onComponentEvent, onDetachHelper, onDisable, onEnable, onEnsureDebugId, onHideContextMenu, onLoad, onRightClick, onShowContextMenu, onWindowResize, previewEvent, recalculate, removeAllListeners, removeAttachagle, removeFromParent, removeListener, removeStyleName, removeStyleOnOver, removeSwallow, removeToolTip, removeWidgetListener, render, render, repaint, saveState, setAriaRole, setAriaState, setAriaSupport, setBorders, setContextMenu, setData, setEl, setElement, setElement, setEnabled, setFiresEvents, setHideMode, setId, setIntStyleAttribute, setItemId, setModel, setMonitorWindowResize, setParent, setStateful, setStateId, setStyleAttribute, setStyleName, setTabIndex, setTitle, setToolTip, setToolTip, setVisible, setWindowResizeDelay, setZIndex, show, sinkEvents, swallowEvent, swallowEvent, toString, unframe, unmask
 
Methods inherited from class com.google.gwt.user.client.ui.Widget
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, setLayoutData
 
Methods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, removeStyleDependentName, setElement, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent, unsinkEvents
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

ChartClick

public static final EventType ChartClick
ChartClick event type.

Constructor Detail

Chart

public Chart(java.lang.String url)
Creates a new chart using the given url.

Parameters:
url - the url
Method Detail

addChartListener

public void addChartListener(ChartListener listener)
Adds a chart listener. This listener will only receive events from the chart model and / or all chart configs that have been enabled for events.

Note: Only adding a listener to a chart (with no listeners enabled on the chart model or chart config) will result in no chart events being fired.

Parameters:
listener - the listener

getChartModel

public ChartModel getChartModel()
Returns the chart model.

Returns:
the chart model

getJsonData

public java.lang.String getJsonData()
Returns the OFC API JSON data that the chart is using.

Note: JSON string can be either set directly via setJsonData(String), or constructed dynamically via setChartModel(ChartModel).

Returns:
the json data

isLoaded

public boolean isLoaded()
Returns the true is the chart has loaded correctly and is ready for configuration/updates

Returns:
true if the chart has loaded

delayedRefresh

public void delayedRefresh(int delay)
Refreshes the chart using the current model data using a delay.

Parameters:
delay - the delay in ms

refresh

public void refresh()
Refreshes the chart using the current model data.


removeChartListener

public void removeChartListener(ChartListener listener)
Removes the chart listener.

Parameters:
listener - the listener to be removed

setChartModel

public void setChartModel(ChartModel model)
Sets the chart model.

Parameters:
model - the model

setJsonData

public void setJsonData(java.lang.String jsonData)
Sets the chart data directly without using a chart model.

Parameters:
jsonData - the JSON OFC API data

onClick

protected void onClick(int configIndex,
                       int dataIndex)

onAttach

protected void onAttach()
Overrides:
onAttach in class FlashComponent

onDetach

protected void onDetach()
Overrides:
onDetach in class FlashComponent

onGetChartData

protected java.lang.String onGetChartData()

onReady

protected void onReady()

processModel

protected void processModel(ChartModel model)