org.pepstock.charba.client.commons

Class JsHelper

java.lang.Object

org.pepstock.charba.client.commons.JsHelper

public final class JsHelper
extends Object

This is a singleton wrapper for Java native object which is wrapping a CHARBA java script object implementation with some utilities to act on java script objects.

Author:

Andrea "Stock" Stocchero

Method Summary

Modifier and Type	Method and Description
List<String>	elementAttributes(Element element) Returns a list of strings with element attributes.
static JsHelper	get() Singleton object to get the helper instance
ChartNativeEvent	nativeEvent(NativeObject event, String key) Returns a chart native event from CHART.JS event.
<T> CallbackProxy<T>	newCallbackProxy() Creates new proxy for callback which will pass this environment of java script as first argument of callback method.
double	propertyAsDouble(Object object, String key) Returns a property of java script object as double.
int	propertyAsInt(Object object, String key) Returns a property of java script object as integer.
String	propertyAsString(Object object, String key) Returns a property of java script object as string.
void	setLineDash(Context2d context, ArrayInteger object) Sets the line dash pattern used when stroking lines.
ObjectType	typeOf(Object object) Returns the java script object type of object.
ObjectType	typeOf(Object object, String key) Returns the java script object type of a property.
Object	undefined() Returns an undefined reference

Methods inherited from class java.lang.Object

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

Method Detail

get

public static JsHelper get()

Singleton object to get the helper instance

Returns:

jsHelper instance.

undefined

public Object undefined()

Returns an undefined reference

Returns:

undefined reference

elementAttributes

public List<String> elementAttributes(Element element)

Returns a list of strings with element attributes.

Parameters:

element - DOM element to scan

Returns:

a list of strings with element attributes

typeOf

public ObjectType typeOf(Object object)

Returns the java script object type of object.

Parameters:

object - the object to get type.

Returns:

the object type

typeOf

public ObjectType typeOf(Object object,
                         String key)

Returns the java script object type of a property.

Parameters:

object - the object on which to search the property.

key - the string name of the property to test.

Returns:

the object type

newCallbackProxy

public <T> CallbackProxy<T> newCallbackProxy()

Creates new proxy for callback which will pass this environment of java script as first argument of callback method.

Type Parameters:

T - type of callback wrapped by proxy

Returns:

new proxy for callback.

propertyAsInt

public int propertyAsInt(Object object,
                         String key)

Returns a property of java script object as integer.

Parameters:

object - the object on which to define the property.

key - the string name of the property to be defined or modified..

Returns:

integer value or UndefinedValues.INTEGER if arguments are not consistent

propertyAsDouble

public double propertyAsDouble(Object object,
                               String key)

Returns a property of java script object as double.

Parameters:

object - the object on which to define the property.

key - the string name of the property to be defined or modified..

Returns:

double value or UndefinedValues.DOUBLE if arguments are not consistent

propertyAsString

public String propertyAsString(Object object,
                               String key)

Returns a property of java script object as string.

Parameters:

object - the object on which to define the property.

key - the string name of the property to be defined or modified..

Returns:

string value or UndefinedValues.STRING if arguments are not consistent

setLineDash

public void setLineDash(Context2d context,
                        ArrayInteger object)

Sets the line dash pattern used when stroking lines. It uses an array of values that specify alternating lengths of lines and gaps which describe the pattern.

Parameters:

context - context of canvas

object - array of values that specify alternating lengths of lines and gaps which describe the pattern

nativeEvent

public ChartNativeEvent nativeEvent(NativeObject event,
                                    String key)

Returns a chart native event from CHART.JS event.

Parameters:

event - CHART.JS event

key - key of java script object

Returns:

a chart native event