org.mozilla.javascript
public interface Scriptable
Host system implementors may find it easier to extend the ScriptableObject class rather than implementing Scriptable when writing host objects.
There are many static methods defined in ScriptableObject that perform the multiple calls to the Scriptable interface needed in order to manipulate properties in prototype chains.
See Also: ScriptableObject
Field Summary | |
---|---|
static Object | NOT_FOUND
Value returned from get if the property is not
found. |
Method Summary | |
---|---|
void | delete(String name)
Removes a property from this object.
|
void | delete(int index)
Removes a property from this object.
|
Object | get(String name, Scriptable start)
Get a named property from the object.
|
Object | get(int index, Scriptable start)
Get a property from the object selected by an integral index.
|
String | getClassName()
Get the name of the set of objects implemented by this Java class.
|
Object | getDefaultValue(Class hint)
Get the default value of the object with a given hint.
|
Object[] | getIds()
Get an array of property ids.
|
Scriptable | getParentScope()
Get the parent scope of the object. |
Scriptable | getPrototype()
Get the prototype of the object. |
boolean | has(String name, Scriptable start)
Indicates whether or not a named property is defined in an object.
|
boolean | has(int index, Scriptable start)
Indicates whether or not an indexed property is defined in an object.
|
boolean | hasInstance(Scriptable instance)
The instanceof operator.
|
void | put(String name, Scriptable start, Object value)
Sets a named property in this object.
|
void | put(int index, Scriptable start, Object value)
Sets an indexed property in this object.
|
void | setParentScope(Scriptable parent)
Set the parent scope of the object. |
void | setPrototype(Scriptable prototype)
Set the prototype of the object. |
get
if the property is not
found.A property can be made permanent by ignoring calls to remove it.
The property is specified by a String name
as defined for get
.
To delete properties defined in a prototype chain, see deleteProperty in ScriptableObject.
Parameters: name the identifier for the property
See Also: Scriptable ScriptableObject
get
.
To delete properties defined in a prototype chain,
see deleteProperty in ScriptableObject.
Identical to delete(String)
except that
an integral index is used to select the property.
Parameters: index the numeric index for the property
See Also: Scriptable ScriptableObject
get
that takes an
integer:
JavaScript code | Java code |
---|---|
a.b | a.get("b", a) |
a["foo"] | a.get("foo", a) |
a[3] | a.get(3, a) |
a["3"] | a.get(3, a) |
a[3.0] | a.get(3, a) |
a["3.0"] | a.get("3.0", a) |
a[1.1] | a.get("1.1", a) |
a[-4] | a.get(-4, a) |
The values that may be returned are limited to the following:
Parameters: name the name of the property start the object in which the lookup began
Returns: the value of the property (may be null), or NOT_FOUND
See Also: Context
get(String, Scriptable)
except that
an integral index is used to select the property.
Parameters: index the numeric index for the property start the object in which the lookup began
Returns: the value of the property (may be null), or NOT_FOUND
See Also: get
See ECMA 8.6.2 and 15.2.4.2.
A hint
of null means "no hint".
See ECMA 8.6.2.6.
Parameters: hint the type hint
Returns: the default value
Returns: an array of Objects. Each entry in the array is either a java.lang.String or a java.lang.Number
Returns: the parent scope
Returns: the prototype
The property is specified by a String name
as defined for the get
method.
Parameters: name the name of the property start the object in which the lookup began
Returns: true if and only if the named property is found in the object
See Also: Scriptable ScriptableObject
The property is specified by an integral index
as defined for the get
method.
Parameters: index the numeric index for the property start the object in which the lookup began
Returns: true if and only if the indexed property is found in the object
See Also: Scriptable ScriptableObject
The JavaScript code "lhs instanceof rhs" causes rhs.hasInstance(lhs) to be called.
The return value is implementation dependent so that embedded host objects can return an appropriate value. See the JS 1.3 language documentation for more detail.
This operator corresponds to the proposed EMCA [[HasInstance]] operator.
Parameters: instance The value that appeared on the LHS of the instanceof operator
Returns: an implementation dependent value
The property is specified by a string name
as defined for get
.
The possible values that may be passed in are as defined for
get
. A class that implements this method may choose
to ignore calls to set certain properties, in which case those
properties are effectively read-only.
For properties defined in a prototype chain,
use putProperty
in ScriptableObject.
Note that if a property a is defined in the prototype p
of an object o, then evaluating o.a = 23
will cause
set
to be called on the prototype p with
o as the start parameter.
To preserve JavaScript semantics, it is the Scriptable
object's responsibility to modify o.
This design allows properties to be defined in prototypes and implemented in terms of getters and setters of Java values without consuming slots in each instance.
The values that may be set are limited to the following:
Arbitrary Java objects may be wrapped in a Scriptable by first calling
Context.toObject
. This allows the property of a JavaScript
object to contain an arbitrary Java object as a value.
Note that has
will be called by the runtime first before
set
is called to determine in which object the
property is defined.
Note that this method is not expected to traverse the prototype chain,
which is different from the ECMA [[Put]] operation.
Parameters: name the name of the property start the object whose property is being set value value to set the property to
See Also: Scriptable Scriptable ScriptableObject Context
The property is specified by an integral index
as defined for get
.
Identical to put(String, Scriptable, Object)
except that
an integral index is used to select the property.
Parameters: index the numeric index for the property start the object whose property is being set value value to set the property to
See Also: Scriptable Scriptable put ScriptableObject
Parameters: parent the parent scope to set
Parameters: prototype the prototype to set