org.pepstock.charba.client.controllers

Class Controllers

java.lang.Object

org.pepstock.charba.client.controllers.Controllers

public final class Controllers
extends Object

Global configuration to set controllers at global level.
It maps the CHART.JS object of controller, chart.controllers.

Author:

Andrea "Stock" Stocchero

Method Summary

Modifier and Type	Method and Description
boolean	extend(Controller controller) Registers a controller as global, to apply to all charts.
static Controllers	get() Singleton method to get static instance.
ControllerType	getTypeByString(String type) Returns the controller type by name as string.
Set<String>	getTypeNames() Gets all global registered controllers types.
boolean	isRegistered(String type) Checks if the controller is registered by its type.

Methods inherited from class java.lang.Object

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

Method Detail

get

public static Controllers get()

Singleton method to get static instance.

Returns:

controller instance

extend

public boolean extend(Controller controller)

Registers a controller as global, to apply to all charts.

Parameters:

controller - controller instance

Returns:

true if registered, otherwise false if the controller is already registered with the controller type of controller instance.

isRegistered

public boolean isRegistered(String type)

Checks if the controller is registered by its type.

Parameters:

type - type of new chart as string.

Returns:

true if registered, otherwise false.

getTypeNames

public Set<String> getTypeNames()

Gets all global registered controllers types.

Returns:

all global registered controllers types.

getTypeByString

public ControllerType getTypeByString(String type)

Returns the controller type by name as string.

Parameters:

type - controller type as string.

Returns:

the controller type if exists or null if does not exist.