com.google.gwt.dev.shell

Class JsValueOOPHM

java.lang.Object

com.google.gwt.dev.shell.JsValue

com.google.gwt.dev.shell.JsValueOOPHM

public class JsValueOOPHM
extends JsValue

Represents a JavaScript value in OOPHM.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.dev.shell.JsValue

JsValue.DispatchMethod, JsValue.DispatchObject

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSE_CLASS

Constructor Summary

Constructors

Constructor and Description
JsValueOOPHM() Create a JsValueMoz object representing the undefined value.
JsValueOOPHM(int jsRefId) Create a JsValueOOPHM object wrapping a JS object given the object reference id.
JsValueOOPHM(JsValueOOPHM other) Copy constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	getBoolean() Get the value of the object as a boolean.
int	getInt() Get the value of the object as an integer.
JsValue.DispatchObject	getJavaObjectWrapper() Get the wrapper object for a wrapped Java object.
BrowserChannel.JsObjectRef	getJavascriptObject()
int	getJavaScriptObjectPointer() Returns a unique value corresponding to the underlying JavaScript object.
double	getNumber() Get the value of the object as a double.
String	getString() Get the value of the object as a string.
String	getTypeString() Returns a human-readable string describing the type of the JS object.
JsValue.DispatchMethod	getWrappedJavaFunction() Returns a wrapped Java method.
Object	getWrappedJavaObject() Unwrap a wrapped Java object.
boolean	isBoolean() Returns true if the JS value is a boolean.
boolean	isInt() Returns true if getInt() can be used on this value.
boolean	isJavaScriptObject() Returns true if the JS value is a native JS object.
boolean	isNull() Returns true if the JS value is null.
boolean	isNumber() Returns true if the JS value is a numeric type.
boolean	isString() Returns true if the JS value is a string.
boolean	isUndefined() Returns true if the JS value is undefined (void).
boolean	isWrappedJavaFunction() Returns true if the JS value contains a wrapped Java method.
boolean	isWrappedJavaObject() Returns true if the JS value is a wrapped Java object.
void	setBoolean(boolean val) Sets the JS object to be a boolean value.
void	setByte(byte val) Sets the JS object to be a number, passed as an byte.
void	setChar(char val) Sets the JS object to be a number, passed as a char.
void	setDouble(double val) Sets the JS object to be a number, passed as a double.
void	setInt(int val) Sets the JS object to be a number, passed as an int.
void	setJavascriptObject(BrowserChannel.JsObjectRef jsObject)
void	setNull() Set the JS object to be null.
void	setShort(short val) Sets the JS object to be a number, passed as a short.
void	setString(String val) Set the JS object to the supplied string.
void	setUndefined() Set the JS object to be undefined (void).
void	setValue(JsValue other) Make this JsValue refer to the same underlying object as another JsValue.
void	setWrappedFunction(String methodName, JsValue.DispatchMethod dispatchMethod) Wrap a function call to a Java method in this JavaScript value.
<T> void	setWrappedJavaObject(CompilingClassLoader cl, T val) Set the JS object to the supplied object, which will be wrapped in a platform-dependent JavaScript class.

Methods inherited from class com.google.gwt.dev.shell.JsValue

toString

Methods inherited from class java.lang.Object

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

Field Detail

JSE_CLASS

public static final String JSE_CLASS

See Also:

Constant Field Values

Constructor Detail

JsValueOOPHM

public JsValueOOPHM()

Create a JsValueMoz object representing the undefined value.

JsValueOOPHM

public JsValueOOPHM(int jsRefId)

Create a JsValueOOPHM object wrapping a JS object given the object reference id.

Parameters:

jsRefId - pointer to underlying JsRootedValue as an integer.

JsValueOOPHM

public JsValueOOPHM(JsValueOOPHM other)

Copy constructor.

Parameters:

other - JsValueMoz instance to copy

Method Detail

getBoolean

public boolean getBoolean()

Description copied from class: JsValue

Get the value of the object as a boolean. May attempt to convert the value to a boolean if it is not a boolean.

Specified by:

getBoolean in class JsValue

Returns:

the value of the underlying object as a boolean

getInt

public int getInt()

Description copied from class: JsValue

Get the value of the object as an integer. May attempt to convert the value to an integer if it is not an integer.

Specified by:

getInt in class JsValue

Returns:

the value of the underlying object as an int

getJavaObjectWrapper

public JsValue.DispatchObject getJavaObjectWrapper()

Description copied from class: JsValue

Get the wrapper object for a wrapped Java object. Only valid if isWrappedJavaObject() is true.

Specified by:

getJavaObjectWrapper in class JsValue

Returns:

the Java object wrapper

getJavascriptObject

public BrowserChannel.JsObjectRef getJavascriptObject()

Returns:

the value as a JsObjectRef. Fails if isJavascriptObject() is false.

getJavaScriptObjectPointer

public int getJavaScriptObjectPointer()

Description copied from class: JsValue

Returns a unique value corresponding to the underlying JavaScript object. In general, two different JsValues will return the same value IFF the underlying JavaScript objects are identical (===).

Specified by:

getJavaScriptObjectPointer in class JsValue

Returns:

a unique number corresponding to the underlying object, or 0 if JsValue.isJavaScriptObject() is false

getNumber

public double getNumber()

Description copied from class: JsValue

Get the value of the object as a double. May attempt to convert the value to a double if it is not a double.

Specified by:

getNumber in class JsValue

Returns:

the value of the underlying object as a double

getString

public String getString()

Description copied from class: JsValue

Get the value of the object as a string. Will coerce the underlying type to a string, but stable cross-platform behavior is only guaranteed when JsValue.isString() is true.

Specified by:

getString in class JsValue

Returns:

the value of the underlying object as a string

getTypeString

public String getTypeString()

Description copied from class: JsValue

Returns a human-readable string describing the type of the JS object. This is intended only for human consumption and may vary across platforms.

Specified by:

getTypeString in class JsValue

getWrappedJavaFunction

public JsValue.DispatchMethod getWrappedJavaFunction()

Description copied from class: JsValue

Returns a wrapped Java method.

Specified by:

getWrappedJavaFunction in class JsValue

getWrappedJavaObject

public Object getWrappedJavaObject()

Description copied from class: JsValue

Unwrap a wrapped Java object.

Specified by:

getWrappedJavaObject in class JsValue

Returns:

the original Java object wrapped in this JS object

isBoolean

public boolean isBoolean()

Description copied from class: JsValue

Returns true if the JS value is a boolean.

Specified by:

isBoolean in class JsValue

isInt

public boolean isInt()

Description copied from class: JsValue

Returns true if getInt() can be used on this value.

Specified by:

isInt in class JsValue

isJavaScriptObject

public boolean isJavaScriptObject()

Description copied from class: JsValue

Returns true if the JS value is a native JS object.

Specified by:

isJavaScriptObject in class JsValue

isNull

public boolean isNull()

Description copied from class: JsValue

Returns true if the JS value is null.

Specified by:

isNull in class JsValue

isNumber

public boolean isNumber()

Description copied from class: JsValue

Returns true if the JS value is a numeric type.

Specified by:

isNumber in class JsValue

isString

public boolean isString()

Description copied from class: JsValue

Returns true if the JS value is a string.

Specified by:

isString in class JsValue

isUndefined

public boolean isUndefined()

Description copied from class: JsValue

Returns true if the JS value is undefined (void).

Specified by:

isUndefined in class JsValue

isWrappedJavaFunction

public boolean isWrappedJavaFunction()

Description copied from class: JsValue

Returns true if the JS value contains a wrapped Java method.

Specified by:

isWrappedJavaFunction in class JsValue

isWrappedJavaObject

public boolean isWrappedJavaObject()

Description copied from class: JsValue

Returns true if the JS value is a wrapped Java object.

Specified by:

isWrappedJavaObject in class JsValue

setBoolean

public void setBoolean(boolean val)

Description copied from class: JsValue

Sets the JS object to be a boolean value.

Specified by:

setBoolean in class JsValue

Parameters:

val - the boolean value to set

setByte

public void setByte(byte val)

Description copied from class: JsValue

Sets the JS object to be a number, passed as an byte.

Specified by:

setByte in class JsValue

Parameters:

val - the value to store

setChar

public void setChar(char val)

Description copied from class: JsValue

Sets the JS object to be a number, passed as a char.

Specified by:

setChar in class JsValue

Parameters:

val - the value to store

setDouble

public void setDouble(double val)

Description copied from class: JsValue

Sets the JS object to be a number, passed as a double.

Specified by:

setDouble in class JsValue

Parameters:

val - the value to store

setInt

public void setInt(int val)

Description copied from class: JsValue

Sets the JS object to be a number, passed as an int.

Specified by:

setInt in class JsValue

Parameters:

val - the value to store

setJavascriptObject

public void setJavascriptObject(BrowserChannel.JsObjectRef jsObject)

setNull

public void setNull()

Description copied from class: JsValue

Set the JS object to be null.

Specified by:

setNull in class JsValue

setShort

public void setShort(short val)

Description copied from class: JsValue

Sets the JS object to be a number, passed as a short.

Specified by:

setShort in class JsValue

Parameters:

val - the value to store

setString

public void setString(String val)

Description copied from class: JsValue

Set the JS object to the supplied string.

Specified by:

setString in class JsValue

Parameters:

val - the string to put in the JS object

setUndefined

public void setUndefined()

Description copied from class: JsValue

Set the JS object to be undefined (void).

Specified by:

setUndefined in class JsValue

setValue

public void setValue(JsValue other)

Description copied from class: JsValue

Make this JsValue refer to the same underlying object as another JsValue.

Specified by:

setValue in class JsValue

Parameters:

other - JsValue to copy JS object from

setWrappedFunction

public void setWrappedFunction(String methodName,
                      JsValue.DispatchMethod dispatchMethod)

Wrap a function call to a Java method in this JavaScript value.

Parameters:

methodName - the name of the method to invoke

dispatchMethod - the wrapper object

setWrappedJavaObject

public <T> void setWrappedJavaObject(CompilingClassLoader cl,
                            T val)

Description copied from class: JsValue

Set the JS object to the supplied object, which will be wrapped in a platform-dependent JavaScript class.

Specified by:

setWrappedJavaObject in class JsValue

Type Parameters:

T - the type of the Java object to wrap

Parameters:

cl - the classloader to create the wrapper object with

val - the Java object to wrap