com.whitestein.lsps.vaadin.forms

Class WAbstractChart

java.lang.Object

com.whitestein.lsps.vaadin.forms.FormComponent

com.whitestein.lsps.vaadin.forms.WAbstractChart

All Implemented Interfaces:

com.vaadin.event.ConnectorEventListener, com.vaadin.server.ClientConnector.AttachListener, Serializable, EventListener

Direct Known Subclasses:

WCartesianChart, WGaugeChart, WPieChart

public abstract class WAbstractChart
extends FormComponent

A base class for all chart components.

Author:

jsa

See Also:

Serialized Form

Field Summary

Fields inherited from class com.whitestein.lsps.vaadin.forms.FormComponent

form, INTERNAL_STATE_RECORD_PROPERTY

Fields inherited from interface com.vaadin.server.ClientConnector.AttachListener

attachMethod

Constructor Summary

Constructors

Constructor and Description
WAbstractChart()

Method Summary

Modifier and Type	Method and Description
protected void	addPayload(com.vaadin.addon.charts.model.Series series, Variant<Object> payload, boolean shift) Adds a payload to the series.
protected com.vaadin.addon.charts.model.style.SolidColor	asColor(Variant.RecordVariant value)
protected Double	asDouble(Variant<Decimal> value)
protected String	asDoubleString(Decimal value)
protected Integer	asInt(Variant<Decimal> value)
protected String	asIntegerString(Decimal value)
protected void	clearPayloads() Clears the payloads from internal storage.
protected <T extends com.vaadin.addon.charts.model.Axis> T	configureAxis(T axis, Variant.RecordVariant def) Configures the axis attributes.
protected com.vaadin.addon.charts.model.AbstractPlotOptions	createPlotOptions(Variant.RecordVariant vPlotOptions)
protected com.vaadin.addon.charts.Chart	createWidget() Called once, to create the actual Vaadin component.
protected com.vaadin.addon.charts.model.AxisType	enumAxisType(EnumerationImpl enumImpl)
protected com.vaadin.addon.charts.model.DashStyle	enumDashStyle(EnumerationImpl enumImpl)
protected com.vaadin.addon.charts.model.MarkerSymbolEnum	enumMarkerSymbol(EnumerationImpl enumImpl) Resolves the 'forms::Marker' enum value.
protected com.vaadin.addon.charts.model.TickPosition	enumTickPosition(EnumerationImpl enumImpl)
protected com.vaadin.addon.charts.model.Configuration	getConfiguration()
protected Variant<Object>	getPayload(com.vaadin.addon.charts.model.Series series, int index) Gets the payload for an item in the given series.
com.vaadin.addon.charts.Chart	getWidget() Gets the Vaadin representation of this component.
void	preventGC(Set<ValueHolder> set) Override for all components which are actively using some record holders, not directly linked to the model.
protected void	redraw() Redraws the chart using the current configuration.
void	refresh() Redraws the chart and refreshes data source etc if they exists.
protected void	registerPayloads(com.vaadin.addon.charts.model.Series series, List<Variant<Object>> payloads) Registers the payloads for items in the given series.
protected <E extends Enum<E>> E	resolveEnumeration(EnumerationImpl enumImpl, String[] names, E[] values)
protected void	restoreInternalState(Map<String,Object> state) Restores the UI state of this component which was previously written by FormComponent.writeInternalState(Map).
void	setChartPlotOptions(RecordHolder plotOptions) Sets the default plot options.
void	setChartSubTitle(String subTitle) Sets the chart sub-title.
void	setChartTitle(String title) Sets the chart title.
protected <T extends com.vaadin.addon.charts.model.AbstractDataLabels> T	setupDataLabels(Variant.RecordVariant vDataLabels, T labels)
protected com.vaadin.addon.charts.model.Labels	setupLabels(Variant.RecordVariant vDataLabels, com.vaadin.addon.charts.model.Labels labels)
protected void	writeInternalState(Map<String,Object> state) Writes the UI state of this component to the provided map.

Methods inherited from class com.whitestein.lsps.vaadin.forms.FormComponent

addDataErrorMessage, addStyleName, attach, call, clearDataErrorMessages, createEvent, equals, getCaption, getComponentAlignment, getContextClickHandler, getCustomErrorMessage, getDataErrorMessages, getDescription, getExpandRatio, getHasChildrenAdapter, getHeight, getIcon, getModelingId, getNamespace, getStyleName, getTabIndex, getWidth, hashCode, isEnabled, isReadOnly, isVisible, localize, markAsDirty, removeStyleName, restoreState, saveState, setCaption, setComponentAlignment, setContextClickHandler, setContextMenuItems, setCustomErrorMessage, setDescription, setEnabled, setExpandRatio, setHeight, setIcon, setReadOnly, setStyleName, setTabIndex, setVisible, setWidth, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

WAbstractChart

public WAbstractChart()

Method Detail

createWidget

protected com.vaadin.addon.charts.Chart createWidget()

Description copied from class: FormComponent

Called once, to create the actual Vaadin component.

Specified by:

createWidget in class FormComponent

Returns:

the actual Vaadin component, may be null if the component has no UI counterpart.

getWidget

public com.vaadin.addon.charts.Chart getWidget()

Description copied from class: FormComponent

Gets the Vaadin representation of this component.

Overrides:

getWidget in class FormComponent

Returns:

the Vaadin representation of this form component.

getConfiguration

protected com.vaadin.addon.charts.model.Configuration getConfiguration()

setChartTitle

public void setChartTitle(String title)

Sets the chart title.

Parameters:

title - the title to set

setChartSubTitle

public void setChartSubTitle(String subTitle)

Sets the chart sub-title.

Parameters:

subTitle - the sub-title to set

setChartPlotOptions

public void setChartPlotOptions(RecordHolder plotOptions)

Sets the default plot options.

Parameters:

plotOptions - the plot options to set.

asInt

protected Integer asInt(Variant<Decimal> value)

asDouble

protected Double asDouble(Variant<Decimal> value)

asDoubleString

protected String asDoubleString(Decimal value)

asIntegerString

protected String asIntegerString(Decimal value)

asColor

protected com.vaadin.addon.charts.model.style.SolidColor asColor(Variant.RecordVariant value)

resolveEnumeration

protected <E extends Enum<E>> E resolveEnumeration(EnumerationImpl enumImpl,
                                                   String[] names,
                                                   E[] values)

enumAxisType

protected com.vaadin.addon.charts.model.AxisType enumAxisType(EnumerationImpl enumImpl)

enumTickPosition

protected com.vaadin.addon.charts.model.TickPosition enumTickPosition(EnumerationImpl enumImpl)

enumDashStyle

protected com.vaadin.addon.charts.model.DashStyle enumDashStyle(EnumerationImpl enumImpl)

enumMarkerSymbol

protected com.vaadin.addon.charts.model.MarkerSymbolEnum enumMarkerSymbol(EnumerationImpl enumImpl)

Resolves the 'forms::Marker' enum value. The 'forms::Marker.none' literal is resolved to null.

Parameters:

enumImpl -

Returns:

marker symbol or null if no marker should be displayed.

setupLabels

protected com.vaadin.addon.charts.model.Labels setupLabels(Variant.RecordVariant vDataLabels,
                                                           com.vaadin.addon.charts.model.Labels labels)

setupDataLabels

protected <T extends com.vaadin.addon.charts.model.AbstractDataLabels> T setupDataLabels(Variant.RecordVariant vDataLabels,
                                                                                         T labels)

createPlotOptions

protected com.vaadin.addon.charts.model.AbstractPlotOptions createPlotOptions(Variant.RecordVariant vPlotOptions)

configureAxis

protected <T extends com.vaadin.addon.charts.model.Axis> T configureAxis(T axis,
                                                                         Variant.RecordVariant def)

Configures the axis attributes.

Type Parameters:

T - the type of the axis.

Parameters:

axis - the axis to configure

def - the axis configuration

Returns:

the axis

getPayload

protected Variant<Object> getPayload(com.vaadin.addon.charts.model.Series series,
                                     int index)

Gets the payload for an item in the given series. Before calling this method the payloads for items in the series have to be registered.

Parameters:

series - the series

index - the index of the item for which to get the payload

Returns:

the payload or null if there is no payload

See Also:

registerPayloads(Series, List)

registerPayloads

protected void registerPayloads(com.vaadin.addon.charts.model.Series series,
                                List<Variant<Object>> payloads)

Registers the payloads for items in the given series.

Parameters:

series - the series

payloads - the payloads of items in the series

addPayload

protected void addPayload(com.vaadin.addon.charts.model.Series series,
                          Variant<Object> payload,
                          boolean shift)

Adds a payload to the series.

Parameters:

series -

payload -

shift - true to remove the first payload from the list

clearPayloads

protected void clearPayloads()

Clears the payloads from internal storage. This method should be called when a data series with payloads is either removed or replaced.

redraw

protected void redraw()

Redraws the chart using the current configuration.

refresh

public void refresh()

Redraws the chart and refreshes data source etc if they exists.

preventGC

public void preventGC(Set<ValueHolder> set)

Description copied from class: FormComponent

Override for all components which are actively using some record holders, not directly linked to the model. You will need to return those record holders here, otherwise they will be garbage-collected.

For example, WTabSheet maintains a set of opened tabs. These tab records are not referenced directly from forms::TabSheet and will therefore be garbage-collected. We however need those records to not to be GCed as the user may ask for them simply by calling getTab(Integer).

Please note that the component definition records (e.g. forms::Button) are already GC-protected and they do not need to be added to this set. Also, any child components currently attached to the UI are automatically protected and are not required to be registered in the set.

Overrides:

preventGC in class FormComponent

Parameters:

set - a set of records which are to be GC-prevented, never null. The component should add any records here. Default implementation does nothing.

writeInternalState

protected void writeInternalState(Map<String,Object> state)

Description copied from class: FormComponent

Writes the UI state of this component to the provided map. The written state is later used to restore the UI when a saved document or saved Todo is reopened.

Many UI attributes such as size, caption, etc. are not held in the records but are stored exclusively in the Vaadin components. In the records the getter/setter methods of such attributes directly delegate to the underlying component. For the purposes of the Save Document/Todo use case the state of such attributes has to be preserved.

Subclasses should override this method. The overriding method should call super.writeInternalState(state) to store the state form the super class as well. The attributes should be written to the provided state parameter. The type of the values written to the state can only by Java representation of LSPS types. That is java.util.Date, java.lang.String, Decimal, RecordHolder, ListHolder, ... The name of the attributes stored in the map should be unique and should not collide with the names used by any of the superclass. It is the responsibility of the overridden method to ensure that.

Subclasses overriding this method should also override FormComponent.restoreInternalState(Map) and restore the state written by this method.

Overrides:

writeInternalState in class FormComponent

Parameters:

state - a map to which this method should write the component's UI state.

See Also:

FormComponent.restoreInternalState(Map), FormComponent.saveState()

restoreInternalState

protected void restoreInternalState(Map<String,Object> state)

Description copied from class: FormComponent

Restores the UI state of this component which was previously written by FormComponent.writeInternalState(Map). Subclasses should override and call super.restoreInternalState(state);

Overrides:

restoreInternalState in class FormComponent

Parameters:

state - a map of attributes and their values

See Also:

FormComponent.writeInternalState(Map)