org.pepstock.charba.client.callbacks

Class ScriptableUtils

java.lang.Object

org.pepstock.charba.client.callbacks.ScriptableUtils

public final class ScriptableUtils
extends Object

Sets of common methods as utilities to manage scriptable options by callback and java interfaces.

Author:

Andrea "Stock" Stocchero

Method Summary

Modifier and Type	Method and Description
static <T> T	getOptionValue(ScriptableContext context, Scriptable<T> callback) Returns the value of the property as result of callback (the same type).
static <T> T	getOptionValue(ScriptableContext context, Scriptable<T> callback, T defaultValue) Returns the value of the property as result of callback (the same type), passing a default value.
static Object	getOptionValueAsColor(ScriptableContext context, Scriptable<?> callback, String defaultValue) Returns a color value of property by a callback, checking all different types of object which can be used as value of the property in color ones. By defaults, is able to manage also Pattern or CanvasPattern.
static Object	getOptionValueAsColor(ScriptableContext context, Scriptable<?> callback, String defaultValue, boolean hasPattern) Returns a color value of property by a callback, checking all different types of object which can be used as value of the property in color ones.
static <T extends Key> T	getOptionValueAsString(ScriptableContext context, Scriptable<T> callback) Returns the enumeration value as value of the property by invoking a callback which is typed to a key.
static <T extends Key> T	getOptionValueAsString(ScriptableContext context, Scriptable<T> callback, T defaultValue) Returns the enumeration value of the property by invoking a callback which is typed to a key, passing a default value.
static Object	handleCallbackResultAsColor(ScriptableContext context, Object result, String defaultValue, boolean hasPattern) Returns a color value of property by a callback, checking all different types of object which can be used as value of the property in color ones.
static IsChart	retrieveChart(ScriptableContext context, Object callback) Returns the chart instance if callback and chart itself are consistent.

Methods inherited from class java.lang.Object

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

Method Detail

retrieveChart

public static IsChart retrieveChart(ScriptableContext context,
                                    Object callback)

Returns the chart instance if callback and chart itself are consistent.

Parameters:

context - scriptable context

callback - callback to check if consistent

Returns:

a char instance if callback and chart itself are consistent

getOptionValueAsString

public static <T extends Key> T getOptionValueAsString(ScriptableContext context,
                                                       Scriptable<T> callback)

Returns the enumeration value as value of the property by invoking a callback which is typed to a key.

Type Parameters:

T - type of callback which extends a key

Parameters:

context - scriptable context

callback - callback to invoke

Returns:

a value of property related to the enumeration value

getOptionValueAsString

public static <T extends Key> T getOptionValueAsString(ScriptableContext context,
                                                       Scriptable<T> callback,
                                                       T defaultValue)

Returns the enumeration value of the property by invoking a callback which is typed to a key, passing a default value. as argument.

Type Parameters:

T - type of callback which extends a key

Parameters:

context - scriptable context

callback - callback to invoke

defaultValue - default value to return in case of chart, callback or result of callback are not consistent.

Returns:

a value of property related to the enumeration value

getOptionValue

public static <T> T getOptionValue(ScriptableContext context,
                                   Scriptable<T> callback)

Returns the value of the property as result of callback (the same type).

Type Parameters:

T - type of callback result

Parameters:

context - scriptable context

callback - callback to invoke

Returns:

a value of property as result of callback invocation

getOptionValue

public static <T> T getOptionValue(ScriptableContext context,
                                   Scriptable<T> callback,
                                   T defaultValue)

Returns the value of the property as result of callback (the same type), passing a default value.

Type Parameters:

T - type of callback result

Parameters:

context - scriptable context

callback - callback to invoke

defaultValue - default value to return in case of chart, callback or result of callback are not consistent.

Returns:

a value of property as result of callback invocation

getOptionValueAsColor

public static Object getOptionValueAsColor(ScriptableContext context,
                                           Scriptable<?> callback,
                                           String defaultValue)

Returns a color value of property by a callback, checking all different types of object which can be used as value of the property in color ones.
By defaults, is able to manage also Pattern or CanvasPattern.

Parameters:

context - scriptable context

callback - callback to invoke

defaultValue - default value to return in case of chart, callback or result of callback are not consistent.

Returns:

a value of property as color

getOptionValueAsColor

public static Object getOptionValueAsColor(ScriptableContext context,
                                           Scriptable<?> callback,
                                           String defaultValue,
                                           boolean hasPattern)

Returns a color value of property by a callback, checking all different types of object which can be used as value of the property in color ones.

Parameters:

context - scriptable context

callback - callback to invoke

defaultValue - default value to return in case of chart, callback or result of callback are not consistent.

hasPattern - if true is able to manage also Pattern or CanvasPattern, otherwise it skips them.

Returns:

a value of property as color

handleCallbackResultAsColor

public static Object handleCallbackResultAsColor(ScriptableContext context,
                                                 Object result,
                                                 String defaultValue,
                                                 boolean hasPattern)

Returns a color value of property by a callback, checking all different types of object which can be used as value of the property in color ones.

Parameters:

context - scriptable context

result - result of callback invocation

defaultValue - default value to return in case of chart, callback or result of callback are not consistent.

hasPattern - if true is able to manage also Pattern or CanvasPattern, otherwise it skips them.

Returns:

a value of property as color