com.github.gwtd3.api.core

Class Value

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

com.github.gwtd3.api.core.Value

Direct Known Subclasses:

Chord.ChordItem

public class Value
extends com.google.gwt.core.client.JavaScriptObject

A Value is an object wrapping a primitive or a complex value.

A Value is returned from many gwt-d3 functions.

The wrapped value can be retrieved from the numerous as*() methods.

Author:

Anthony Schiochet

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Value()

Method Summary

Methods

Modifier and Type	Method and Description
<T> T	as() Cast and return the wrapped value, if possible.
<T> T	as(Class<T> clazz) Cast and return the wrapped value.
boolean	asBoolean() Cast and return the wrapped value.
byte	asByte() Cast and return the wrapped value.
char	asChar() Cast and return the wrapped value.
Coords	asCoords() Return the value casted to a Coords object.
double	asDouble() Cast and return the wrapped value.
float	asFloat() Cast and return the wrapped value.
int	asInt() Cast and return the wrapped value.
com.google.gwt.core.client.JsDate	asJsDate()
long	asLong() Cast and return the value.
short	asShort() Cast and return the wrapped value.
String	asString() Return the value casted to a String.
static Value	create(com.google.gwt.core.client.JavaScriptObject object, String propertyName) Create a Value instance from the value of the named property of the given object.
static Value	create(Object o) Wraps the given object into a Value.
Value	getProperty(String propertyName) Return the property of this object as a Value.
boolean	isBoolean()
boolean	isDefined()
boolean	isFunction()
boolean	isNull()
boolean	isString()
boolean	isUndefined()
String	typeof() The result of the typeof operator.

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Value

protected Value()

Method Detail

create

public static final Value create(Object o)

Wraps the given object into a Value.

Parameters:

o - the object to be wrapped as a Value

Returns:

the value

create

public static final Value create(com.google.gwt.core.client.JavaScriptObject object,
           String propertyName)

Create a Value instance from the value of the named property of the given object.

Parameters:

object -

propertyName -

Returns:

asBoolean

public final boolean asBoolean()

Cast and return the wrapped value.

Returns:

the value

asByte

public final byte asByte()

Cast and return the wrapped value.

Returns:

the value

asChar

public final char asChar()

Cast and return the wrapped value.

Returns:

the value

asJsDate

public final com.google.gwt.core.client.JsDate asJsDate()

asDouble

public final double asDouble()

Cast and return the wrapped value.

Returns:

the value

asFloat

public final float asFloat()

Cast and return the wrapped value.

Returns:

the value

asInt

public final int asInt()

Cast and return the wrapped value.

Returns:

the value

asLong

public final long asLong()

Cast and return the value.

Returns:

the value

asShort

public final short asShort()

Cast and return the wrapped value.

Returns:

the value

asString

public final String asString()

Return the value casted to a String.

Returns:

the value

asCoords

public final Coords asCoords()

Return the value casted to a Coords object.

Returns:

the coords

as

public final <T> T as()

Cast and return the wrapped value, if possible.

Returns:

the value

Throws:

ClassCastException - if the value cannot be converted in T

as

public final <T> T as(Class<T> clazz)

Cast and return the wrapped value.

Parameters:

clazz - the clazz to cast to

Returns:

the casted instance

isDefined

public final boolean isDefined()

Returns:

true if the value is not undefined in the Javascript sense

isUndefined

public final boolean isUndefined()

Returns:

true if the value is undefined in the Javascript sense

isNull

public final boolean isNull()

isString

public final boolean isString()

isFunction

public final boolean isFunction()

isBoolean

public final boolean isBoolean()

getProperty

public final Value getProperty(String propertyName)

Return the property of this object as a Value.

This method result is never non-null. The returned value may then be tested for nullity (with isNull()) or for undefinition (with isUndefined()).

Parameters:

propertyName - the name of the property to get

Returns:

the property value as a value.

typeof

public final String typeof()

The result of the typeof operator.

Returns:

the String returned by a call to typeof