com.whitestein.lsps.vaadin.ui.components

Class UIGenericChart

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.ui.AbstractComponent

com.vaadin.addon.charts.Chart

com.whitestein.lsps.vaadin.ui.components.UIGenericChart

All Implemented Interfaces:

com.vaadin.event.ContextClickEvent.ContextClickNotifier, com.vaadin.event.MethodEventSource, com.vaadin.server.ClientConnector, com.vaadin.server.Sizeable, com.vaadin.shared.Connector, com.vaadin.ui.Component, UIComponent, UIComponentWithHints2, Serializable

Direct Known Subclasses:

UICartesianChart, UIGaugeChart, UIPieChart

public class UIGenericChart
extends com.vaadin.addon.charts.Chart
implements UIComponentWithHints2

Generic chart component integrated with LSPS that supports chart click listeners and configuration through the 'config' hint.

Author:

mhi

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.vaadin.ui.Component

com.vaadin.ui.Component.ErrorEvent, com.vaadin.ui.Component.Event, com.vaadin.ui.Component.Focusable, com.vaadin.ui.Component.Listener

Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector

com.vaadin.server.ClientConnector.AttachEvent, com.vaadin.server.ClientConnector.AttachListener, com.vaadin.server.ClientConnector.ConnectorErrorEvent, com.vaadin.server.ClientConnector.DetachEvent, com.vaadin.server.ClientConnector.DetachListener

Nested classes/interfaces inherited from interface com.vaadin.server.Sizeable

com.vaadin.server.Sizeable.Unit

Field Summary

Fields

Modifier and Type	Field and Description
protected UIComponentData	componentData Component data used by this component

Fields inherited from class com.vaadin.ui.AbstractComponent

DESIGN_ATTR_PLAIN_TEXT

Fields inherited from interface com.vaadin.server.Sizeable

SIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS

Constructor Summary

Constructors

Constructor and Description
UIGenericChart(UIComponentData componentData) Full constructor.

Method Summary

Modifier and Type	Method and Description
boolean	applyHint(String hintName, Variant<Object> newValue, Variant<Object> oldValue) Applies the given hint to this component.
protected void	clearPayloads()
protected boolean	configure(com.vaadin.addon.charts.model.Configuration configuration) Configure chart options.
UIComponentData	getComponentData() Returns the component definition (LSPS RecordHolder instance which is subtype of "ui::Component") associated with this Vaadin component.
Object	getPayloadFor(com.vaadin.addon.charts.model.DataSeriesItem item)
com.vaadin.ui.AbstractComponent	getWidget() Returns the Vaadin widget which implements the UI part of this component.
void	refresh() This method is called from LSPS rendering engine.
protected void	setPayloadFor(com.vaadin.addon.charts.model.DataSeriesItem item, Object payload)
String	toString()
boolean	unapplyHint(String hintName, Variant<Object> oldValue) The hint has been removed from the hint map.
protected void	updateAxis(com.vaadin.addon.charts.model.Axis axis, Variant.RecordVariant axisDefinition) Updates the chart axis with the values from the axis definition.

Methods inherited from class com.vaadin.addon.charts.Chart

addChartClickListener, addChartDrillupListener, addChartSelectionListener, addCheckBoxClickListener, addLegendItemClickListener, addPointClickListener, addPointSelectListener, addPointUnselectListener, addSeriesHideListener, addSeriesShowListener, addXAxesExtremesChangeListener, addYAxesExtremesChangeListener, beforeClientResponse, drawChart, drawChart, drawChart, getConfiguration, getDrilldownCallback, getJsonConfig, getState, isTimeline, readDesign, removeChartClickListener, removeChartDrillupListener, removeChartSelectionListener, removeCheckBoxClickListener, removeLegendItemClickListener, removePointClickListener, removePointSelectListener, removePointUnselectListener, removeSeriesHideListener, removeSeriesShowListener, removeXAxesExtremesChangeListener, removeYAxesExtremesChangeListener, setConfiguration, setDrilldownCallback, setJsonConfig, setSeriesVisibilityTogglingDisabled, setTimeline, writeDesign

Methods inherited from class com.vaadin.ui.AbstractComponent

addContextClickListener, addListener, addShortcutListener, addStyleName, attach, detach, findAncestor, fireComponentErrorEvent, fireComponentEvent, focus, getActionManager, getCaption, getComponentError, getCustomAttributes, getData, getDebugId, getDescription, getErrorMessage, getExplicitImmediateValue, getHeight, getHeightUnits, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getState, getStyleName, getWidth, getWidthUnits, isCaptionAsHtml, isConnectorEnabled, isEnabled, isImmediate, isOrHasAncestor, isReadOnly, isResponsive, isVisible, removeContextClickListener, removeListener, removeShortcutListener, removeStyleName, setCaption, setCaptionAsHtml, setComponentError, setData, setDebugId, setDescription, setEnabled, setHeight, setHeight, setHeightUndefined, setIcon, setId, setImmediate, setLocale, setParent, setPrimaryStyleName, setReadOnly, setResponsive, setSizeFull, setSizeUndefined, setStyleName, setStyleName, setVisible, setWidth, setWidth, setWidthUndefined

Methods inherited from class com.vaadin.server.AbstractClientConnector

addAttachListener, addDetachListener, addExtension, addListener, addListener, addListener, addMethodInvocationToQueue, createState, encodeState, equals, fireEvent, getAllChildrenIterable, getConnectorId, getErrorHandler, getExtensions, getListeners, getResource, getRpcManager, getRpcProxy, getSession, getStateType, getUI, handleConnectorRequest, hashCode, hasListeners, isAttached, isThis, markAsDirty, markAsDirtyRecursive, registerRpc, registerRpc, removeAttachListener, removeDetachListener, removeExtension, removeListener, removeListener, removeListener, removeListener, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler, setResource

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.vaadin.ui.Component

getUI

Methods inherited from interface com.vaadin.server.ClientConnector

addAttachListener, addDetachListener, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, handleConnectorRequest, isAttached, markAsDirty, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Field Detail

componentData

protected final UIComponentData componentData

Component data used by this component

Constructor Detail

UIGenericChart

public UIGenericChart(UIComponentData componentData)

Full constructor.

Parameters:

componentData -

Method Detail

refresh

public void refresh()

Description copied from interface: UIComponent

This method is called from LSPS rendering engine. It should load all information needed from component definition record holder and apply them accordingly.

Note that this method should not attempt to apply any hints - hints are applied automatically after the component is refreshed. You however may read the hints value here - it is guaranteed that you will receive freshly updated hint value by reading UIComponentData.getHints().

Specified by:

refresh in interface UIComponent

configure

protected boolean configure(com.vaadin.addon.charts.model.Configuration configuration)

Configure chart options. Called from refresh(). If this function returns true, the chart is redrawn.

Parameters:

configuration -

Returns:

true if chart should be redrawn

updateAxis

protected void updateAxis(com.vaadin.addon.charts.model.Axis axis,
                          Variant.RecordVariant axisDefinition)

Updates the chart axis with the values from the axis definition.

Parameters:

axis -

axisDefinition -

applyHint

public boolean applyHint(String hintName,
                         Variant<Object> newValue,
                         Variant<Object> oldValue)

Description copied from interface: UIComponentWithHints2

Applies the given hint to this component.

Specified by:

applyHint in interface UIComponentWithHints2

Parameters:

hintName - the hint name, not null.

newValue - variant containing the new hint value, never null, may contain null value.

oldValue - variant containing the previous hint value, never null, may contain null value if the hint was missing or the old value was null.

Returns:

true if the hint is supported and was applied, false if the hint is not known to this component.

unapplyHint

public boolean unapplyHint(String hintName,
                           Variant<Object> oldValue)

Description copied from interface: UIComponentWithHints2

The hint has been removed from the hint map. Unapply from the component and revert the value to the default one.

Specified by:

unapplyHint in interface UIComponentWithHints2

Parameters:

hintName - the the hint name, not null.

oldValue - variant containing the previous hint value, never null, may contain null value if the old value was null.

Returns:

true if the hint is supported and was applied, false if the hint is not known to this component.

getComponentData

public UIComponentData getComponentData()

Description copied from interface: UIComponent

Returns the component definition (LSPS RecordHolder instance which is subtype of "ui::Component") associated with this Vaadin component.

Specified by:

getComponentData in interface UIComponent

Returns:

component definition. The definition record instance must be present in root scope (screen context).

toString

public String toString()

Overrides:

toString in class Object

clearPayloads

protected final void clearPayloads()

getPayloadFor

public Object getPayloadFor(com.vaadin.addon.charts.model.DataSeriesItem item)

setPayloadFor

protected final void setPayloadFor(com.vaadin.addon.charts.model.DataSeriesItem item,
                                   Object payload)

getWidget

public com.vaadin.ui.AbstractComponent getWidget()

Description copied from interface: UIComponent

Returns the Vaadin widget which implements the UI part of this component.

Specified by:

getWidget in interface UIComponent

Returns:

the widget, not null.