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
static JsHelper	get() Singleton object to get the helper instance
boolean	isCanvasGradient(Object object) Returns true if the object is a CanvasGradientItem.
boolean	isCanvasPattern(Object object) Returns true if the object is a CanvasPatternItem.
<T> CallbackProxy<T>	newCallbackProxy() Creates new proxy for callback which will pass this environment of java script as first argument of callback method.
int	propertyAsInt(NativeObject object, String key) Returns a property of java script object as integer.
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.

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:

helper instance.

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.

isCanvasPattern

public boolean isCanvasPattern(Object object)

Returns true if the object is a CanvasPatternItem.

Parameters:

object - the object instance on which to check

Returns:

true if the object is a CanvasPatternItem

isCanvasGradient

public boolean isCanvasGradient(Object object)

Returns true if the object is a CanvasGradientItem.

Parameters:

object - the object instance on which to check

Returns:

true if the object is a CanvasGradientItem

propertyAsInt

public int propertyAsInt(NativeObject 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