Package org.wicketstuff.gchart

Class ChartLibLoaderBehavior

java.lang.Object

org.apache.wicket.behavior.Behavior

org.wicketstuff.gchart.ChartLibLoaderBehavior

All Implemented Interfaces:

Serializable, IComponentAwareEventSink, IComponentAwareHeaderContributor, IClusterable, ChartLibLoader, JavaScriptable

public class ChartLibLoaderBehavior
extends Behavior
implements JavaScriptable, ChartLibLoader

Behavior to bundle the Google chart lib loading and package declaration for multiple charts on one page. All needed packages are merged in a set, so the loading is done only once as the docs request. To use add this behavior to the page (not the chart) and give the instance as param to every constructor of a chart component of the page. The Charts will register in the loader by ChartLibLoader.addChart(org.wicketstuff.gchart.Chart) and lib loading is done centralized. Use this behavior at page when you display multiple charts on the page (Since Google Charts version 45 this is mandatory, but still recommended.)

Author:

Dieter Tremel

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	LOADER_SCRIPT_ID

Constructor Summary

Constructors

Constructor	Description
ChartLibLoaderBehavior()

Method Summary

Modifier and Type	Method	Description
boolean	addChart(Chart chart)	Add a chart to the loader, so it's package is loaded to.
void	bind(Component component)
List<Chart>	getCharts()
HeaderItem	getHeaderItem()	Get the HeaderItem the loader adds, only to make dependencies to.
String	getLoaderUrl()	Get Google loader URL.
Locale	getLocale()	The Locale is used to render a language = "de" in the load statement like in the example:
boolean	isRenderLocale()
boolean	removeChart(Chart chart)	Remove a previous added chart.
void	renderHead(Component component, IHeaderResponse response)
void	setLocale(Locale locale)
void	setRenderLocale(boolean renderLocale)
String	toJavaScript()	Return the JavaScript part.

Methods inherited from class org.apache.wicket.behavior.Behavior

afterRender, beforeRender, canCallListener, detach, getStatelessHint, isEnabled, isTemporary, onAttribute, onComponentTag, onConfigure, onEvent, onException, onRemove, onTag, unbind

Methods inherited from class java.lang.Object

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

Field Detail

LOADER_SCRIPT_ID

public static final String LOADER_SCRIPT_ID

Constructor Detail

ChartLibLoaderBehavior

public ChartLibLoaderBehavior()

Method Detail

bind

public void bind(Component component)

Overrides:

bind in class Behavior

addChart

public boolean addChart(Chart chart)

Description copied from interface: ChartLibLoader

Add a chart to the loader, so it's package is loaded to.

Specified by:

addChart in interface ChartLibLoader

Parameters:

chart - Chart to add.

Returns:

True if Chart is added.

removeChart

public boolean removeChart(Chart chart)

Description copied from interface: ChartLibLoader

Remove a previous added chart.

Specified by:

removeChart in interface ChartLibLoader

Parameters:

chart - Chart to remove.

Returns:

True if the Chart was managed and is removed now, false otherwise.

getLocale

public Locale getLocale()

The Locale is used to render a language = "de" in the load statement like in the example:

 
 // Load Google Charts for the Japanese locale.
 google.charts.load('current', {'packages':['corechart'], 'language': 'ja'});
 

If this behavior is attached to the Page, Locale is set from the Page which normally is identical to Session.getLocale(). To override use setLocale(java.util.Locale).

Returns:

Locale used for the package language option.

setLocale

public void setLocale(Locale locale)

getCharts

public List<Chart> getCharts()

isRenderLocale

public boolean isRenderLocale()

setRenderLocale

public void setRenderLocale(boolean renderLocale)

getLoaderUrl

public String getLoaderUrl()

Get Google loader URL. Can be overwritten, if Google changes URL in future.

Returns:

Returns Chart.LOADER_URL.

toJavaScript

public String toJavaScript()

Description copied from interface: JavaScriptable

Return the JavaScript part.

Specified by:

toJavaScript in interface JavaScriptable

Returns:

JavaScript String for use as part of chart declaration.

getHeaderItem

public HeaderItem getHeaderItem()

Description copied from interface: ChartLibLoader

Get the HeaderItem the loader adds, only to make dependencies to.

Specified by:

getHeaderItem in interface ChartLibLoader

Returns:

HeaderItem that the loader contributes.

renderHead

public void renderHead(Component component,
                       IHeaderResponse response)

Specified by:

renderHead in interface IComponentAwareHeaderContributor

Overrides:

renderHead in class Behavior