GMapsFX 11.0.7 · com.dlsc.gmapsfx.javascript.JavascriptObject

Modifier and Type	Field and Description
protected JSObject	jsObject References Deprecated `JSObject` is deprecated or references (maybe indirectly) at least one deprecated element.
protected static int	objectCounter
protected static Map<JSObject, JavascriptObject>	peerRegistry
protected IJavascriptRuntime	runtime
protected String	variableName

Constructor Summary

Access	Constructor and Description
protected	JavascriptObject()
protected	JavascriptObject(String The type of underlying Javascript object to create type)
protected	JavascriptObject(String The type of object to build type, String A string representation of the object, which can be executed by the Javascript runtime. stringRepresentation) Builds a new JavascriptObject based on a string representation of the object.
protected	JavascriptObject(String The type of underlying Javascript object to create. type, Object... Any arguments required to create the object. args)
protected	JavascriptObject(String The type of underlying Javascript object to create. type, Object[] The array to be passed in. ary, boolean boolean to indicate the an array is to be used as the parameter rather than breaking up into individual parameters. isArray)
protected	JavascriptObject(String Type of Javascript object to create. type, JSObject Object returned from Javascript. jsObject) References Deprecated `JSObject` is deprecated or references (maybe indirectly) at least one deprecated element. Wraps a Javascript JSObject returned from a function.

Method Summary

Modifier and Type	Method and Description
protected Boolean	Returns: The actual value, or if null, returns false. checkBoolean(Object The value from Javascript to be checked. val, Boolean The default return value, which can be null. def) Checks a returned Javascript value where we expect a boolean but could get null.
protected Integer	checkInteger(Object val, Integer def)
protected Object	Returns: Either null or the value passed in. checkUndefined(Object The value from Javascript to be checked. val) JSObject will return the String "undefined" at certain times, so we need to make sure we're not getting a value that looks valid, but isn't.
public JSObject	Returns: The underlying Javascript object getJSObject() References Deprecated `JSObject` is deprecated or references (maybe indirectly) at least one deprecated element. Get the underlying object used by the Javascript runtime.
protected final String	Returns: The name of the next variable to create getNextVariableName() Gets the name of the next variable which will be the objectname plus a unique number
protected Object	Returns: The value of the property getProperty(String The property name key) Get the specified property for this object.
protected <T> T	Returns: The value of the property getProperty(String The property name key, Class<T> The property type type) Gets the property and casts to the appropriate type
public String	Returns: The name of this variable. getVariableName() Gets the name of this variable within the Javascript runtime
protected Object	Returns: The return value of the function call. invokeJavascript(String The function to invoke function) Invokes a JavaScript function that takes no arguments.
protected Object	Returns: The result of the function. invokeJavascript(String The function to invoke function, Object... Any arguments to pass to the function args) Invoke the specified JavaScript function in the JavaScript runtime.
protected <T> T	Returns: The result of the function. invokeJavascriptReturnValue(String The function to invoke function, Class<T> The type of object to return returnType) Invokes a JavaScript function that takes no arguments.
protected <T> T	Returns: The result of the function. invokeJavascriptReturnValue(String The function to invoke function, Class<T> The type of object to return returnType, Object... Any arguments to pass to the function args) Invoke the specified JavaScript function in the JavaScript runtime.
protected boolean	isMemberDefined(String member)
protected void	setProperty(String The property name propertyName, Object The property value. propertyValue) Sets a property on this Javascript object.
protected void	setProperty(String The name of the property. propertyName, JavascriptObject The value of the property. propertyValue) Sets a property on this Javascript object for which the value is a Javascript object itself.
protected void	setProperty(String The name of the property. propertyName, JavascriptEnum The value of the property. propertyValue) Sets a property on this Javascript object for which the value is a JavascriptEnum The value is set to what is returned by the getEnumValue() method on the JavascriptEnum

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

jsObject	back to summary
protected JSObject jsObject References Deprecated `JSObject` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information.

objectCounter	back to summary
protected static int objectCounter

peerRegistry	back to summary
protected static Map<JSObject, JavascriptObject> peerRegistry

runtime	back to summary
protected IJavascriptRuntime runtime

variableName	back to summary
protected String variableName

Constructor Detail

JavascriptObject	back to summary
protected JavascriptObject()

JavascriptObject	back to summary
protected JavascriptObject(String type) Parameters type:String The type of underlying Javascript object to create

JavascriptObject	back to summary
protected JavascriptObject(String type, String stringRepresentation) Builds a new JavascriptObject based on a string representation of the object. This is useful when constructing functions as objects Parameters type:String The type of object to build stringRepresentation:String A string representation of the object, which can be executed by the Javascript runtime.

JavascriptObject

back to summary

protected JavascriptObject(String type, String stringRepresentation)

Builds a new JavascriptObject based on a string representation of the object. This is useful when constructing functions as objects

Parameters

type:String: The type of object to build
stringRepresentation:String: A string representation of the object, which can be executed by the Javascript runtime.

JavascriptObject	back to summary
protected JavascriptObject(String type, Object... args) Parameters type:String The type of underlying Javascript object to create. args:Object[] Any arguments required to create the object.

JavascriptObject	back to summary
protected JavascriptObject(String type, Object[] ary, boolean isArray) Parameters type:String The type of underlying Javascript object to create. ary:Object[] The array to be passed in. isArray:boolean boolean to indicate the an array is to be used as the parameter rather than breaking up into individual parameters.

JavascriptObject back to summary

JavascriptObject	back to summary
protected JavascriptObject(String type, JSObject jsObject) References Deprecated `JSObject` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Wraps a Javascript JSObject returned from a function. Parameters type:String Type of Javascript object to create. jsObject:JSObject Object returned from Javascript.

protected JavascriptObject(String type, JSObject jsObject)

References Deprecated

JSObject is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Wraps a Javascript JSObject returned from a function.

Parameters

type:String: Type of Javascript object to create.
jsObject:JSObject: Object returned from Javascript.

Method Detail

checkBoolean	back to summary
protected Boolean checkBoolean(Object val, Boolean def) Checks a returned Javascript value where we expect a boolean but could get null. Parameters val:Object The value from Javascript to be checked. def:Boolean The default return value, which can be null. Returns:Boolean The actual value, or if null, returns false.

checkBoolean

back to summary

protected Boolean checkBoolean(Object val, Boolean def)

Checks a returned Javascript value where we expect a boolean but could get null.

Parameters

val:Object: The value from Javascript to be checked.
def:Boolean: The default return value, which can be null.

Returns:Boolean

The actual value, or if null, returns false.

checkInteger	back to summary
protected Integer checkInteger(Object val, Integer def)

checkUndefined	back to summary
protected Object checkUndefined(Object val) JSObject will return the String "undefined" at certain times, so we need to make sure we're not getting a value that looks valid, but isn't. Parameters val:Object The value from Javascript to be checked. Returns:Object Either null or the value passed in.

checkUndefined

back to summary

protected Object checkUndefined(Object val)

JSObject will return the String "undefined" at certain times, so we need to make sure we're not getting a value that looks valid, but isn't.

Parameters

val:Object: The value from Javascript to be checked.

Returns:Object

Either null or the value passed in.

getJSObject back to summary

getJSObject	back to summary
public JSObject getJSObject() References Deprecated `JSObject` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Get the underlying object used by the Javascript runtime. Returns:JSObject The underlying Javascript object

public JSObject getJSObject()

References Deprecated

JSObject is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Get the underlying object used by the Javascript runtime.

Returns:JSObject: The underlying Javascript object

getNextVariableName	back to summary
protected final String getNextVariableName() Gets the name of the next variable which will be the objectname plus a unique number Returns:String The name of the next variable to create

getNextVariableName

back to summary

protected final String getNextVariableName()

Gets the name of the next variable which will be the objectname plus a unique number

Returns:String: The name of the next variable to create

getProperty	back to summary
protected Object getProperty(String key) Get the specified property for this object. Parameters key:String The property name Returns:Object The value of the property

getProperty

back to summary

protected Object getProperty(String key)

Get the specified property for this object.

Parameters

key:String: The property name

Returns:Object

The value of the property

getProperty	back to summary
protected <T> T getProperty(String key, Class<T> type) Gets the property and casts to the appropriate type Parameters key:String The property name type:Class<T> The property type Returns:T The value of the property

getProperty

back to summary

protected <T> T getProperty(String key, Class<T> type)

Gets the property and casts to the appropriate type

Parameters

key:String: The property name
type:Class<T>: The property type

Returns:T

The value of the property

getVariableName	back to summary
public String getVariableName() Gets the name of this variable within the Javascript runtime Returns:String The name of this variable.

getVariableName

back to summary

public String getVariableName()

Gets the name of this variable within the Javascript runtime

Returns:String: The name of this variable.

invokeJavascript	back to summary
protected Object invokeJavascript(String function) Invokes a JavaScript function that takes no arguments. Parameters function:String The function to invoke Returns:Object The return value of the function call.

invokeJavascript

back to summary

protected Object invokeJavascript(String function)

Invokes a JavaScript function that takes no arguments.

Parameters

function:String: The function to invoke

Returns:Object

The return value of the function call.

invokeJavascript	back to summary
protected Object invokeJavascript(String function, Object... args) Invoke the specified JavaScript function in the JavaScript runtime. Parameters function:String The function to invoke args:Object[] Any arguments to pass to the function Returns:Object The result of the function.

invokeJavascript

back to summary

protected Object invokeJavascript(String function, Object... args)

Invoke the specified JavaScript function in the JavaScript runtime.

Parameters

function:String: The function to invoke
args:Object[]: Any arguments to pass to the function

Returns:Object

The result of the function.

invokeJavascriptReturnValue	back to summary
protected <T> T invokeJavascriptReturnValue(String function, Class<T> returnType) Invokes a JavaScript function that takes no arguments. Parameters function:String The function to invoke returnType:Class<T> The type of object to return Returns:T The result of the function.

invokeJavascriptReturnValue

back to summary

protected <T> T invokeJavascriptReturnValue(String function, Class<T> returnType)

Invokes a JavaScript function that takes no arguments.

Parameters

function:String: The function to invoke
returnType:Class<T>: The type of object to return

Returns:T

The result of the function.

invokeJavascriptReturnValue	back to summary
protected <T> T invokeJavascriptReturnValue(String function, Class<T> returnType, Object... args) Invoke the specified JavaScript function in the JavaScript runtime. Parameters function:String The function to invoke returnType:Class<T> The type of object to return args:Object[] Any arguments to pass to the function Returns:T The result of the function.

invokeJavascriptReturnValue

back to summary

protected <T> T invokeJavascriptReturnValue(String function, Class<T> returnType, Object... args)

Invoke the specified JavaScript function in the JavaScript runtime.

Parameters

function:String: The function to invoke
returnType:Class<T>: The type of object to return
args:Object[]: Any arguments to pass to the function

Returns:T

The result of the function.

isMemberDefined	back to summary
protected boolean isMemberDefined(String member)

setProperty	back to summary
protected void setProperty(String propertyName, Object propertyValue) Sets a property on this Javascript object. Parameters propertyName:String The property name propertyValue:Object The property value.

setProperty

back to summary

protected void setProperty(String propertyName, Object propertyValue)

Sets a property on this Javascript object.

Parameters

propertyName:String: The property name
propertyValue:Object: The property value.

setProperty	back to summary
protected void setProperty(String propertyName, JavascriptObject propertyValue) Sets a property on this Javascript object for which the value is a Javascript object itself. Parameters propertyName:String The name of the property. propertyValue:JavascriptObject The value of the property.

setProperty

back to summary

protected void setProperty(String propertyName, JavascriptObject propertyValue)

Sets a property on this Javascript object for which the value is a Javascript object itself.

Parameters

propertyName:String: The name of the property.
propertyValue:JavascriptObject: The value of the property.

setProperty	back to summary
protected void setProperty(String propertyName, JavascriptEnum propertyValue) Sets a property on this Javascript object for which the value is a JavascriptEnum The value is set to what is returned by the getEnumValue() method on the JavascriptEnum Parameters propertyName:String The name of the property. propertyValue:JavascriptEnum The value of the property.

setProperty

back to summary

protected void setProperty(String propertyName, JavascriptEnum propertyValue)

Sets a property on this Javascript object for which the value is a JavascriptEnum The value is set to what is returned by the getEnumValue() method on the JavascriptEnum

Parameters

propertyName:String: The name of the property.
propertyValue:JavascriptEnum: The value of the property.

public Class JavascriptObject

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail