Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
public interface Scriptable
ScriptableObject
Field Summary | |
static Object |
|
Method Summary | |
void |
|
void |
|
Object |
|
Object |
|
String |
|
Object |
|
Object[] |
|
Scriptable |
|
Scriptable |
|
boolean |
|
boolean |
|
boolean |
|
void |
|
void |
|
void |
|
void |
|
public void delete(String name)
Removes a property from this object. This operation corresponds to the ECMA [[Delete]] except that the no result is returned. The runtime will guarantee that this method is called only if the property exists. After this method is called, the runtime will call Scriptable.has to see if the property has been removed in order to determine the boolean result of the delete operator as defined by ECMA 11.4.1. A property can be made permanent by ignoring calls to remove it. The property is specified by a String name as defined forget
. To delete properties defined in a prototype chain, see deleteProperty in ScriptableObject.
- Parameters:
name
- the identifier for the property
- See Also:
org.mozilla.javascript.Scriptable.get
,org.mozilla.javascript.ScriptableObject.deleteProperty
public void delete(int index)
Removes a property from this object. The property is specified by an integral index as defined forget
. To delete properties defined in a prototype chain, see deleteProperty in ScriptableObject. Identical todelete(String)
except that an integral index is used to select the property.
- Parameters:
index
- the numeric index for the property
- See Also:
org.mozilla.javascript.Scriptable.get
,org.mozilla.javascript.ScriptableObject.deleteProperty
public Object get(String name, Scriptable start)
Get a named property from the object. Looks property up in this object and returns the associated value if found. Returns NOT_FOUND if not found. Note that this method is not expected to traverse the prototype chain. This is different from the ECMA [[Get]] operation. Depending on the property selector, the runtime will call this method or the form ofget
that takes an integer:The values that may be returned are limited to the following:
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)
- java.lang.Boolean objects
- java.lang.String objects
- java.lang.Number objects
- org.mozilla.javascript.Scriptable objects
- null
- The value returned by Context.getUndefinedValue()
- NOT_FOUND
- Parameters:
name
- the name of the propertystart
- the object in which the lookup began
- Returns:
- the value of the property (may be null), or NOT_FOUND
- See Also:
Context.getUndefinedValue()
public Object get(int index, Scriptable start)
Get a property from the object selected by an integral index. Identical toget(String, Scriptable)
except that an integral index is used to select the property.
- Parameters:
index
- the numeric index for the propertystart
- the object in which the lookup began
- Returns:
- the value of the property (may be null), or NOT_FOUND
- See Also:
get(String,Scriptable)
public String getClassName()
Get the name of the set of objects implemented by this Java class. This corresponds to the [[Class]] operation in ECMA and is used by Object.prototype.toString() in ECMA. See ECMA 8.6.2 and 15.2.4.2.
public Object getDefaultValue(Class hint)
Get the default value of the object with a given hint. The hints are String.class for type String, Number.class for type Number, Scriptable.class for type Object, and Boolean.class for type Boolean. Ahint
of null means "no hint". See ECMA 8.6.2.6.
- Parameters:
hint
- the type hint
- Returns:
- the default value
public Object[] getIds()
Get an array of property ids. Not all property ids need be returned. Those properties whose ids are not returned are considered non-enumerable.
- Returns:
- an array of Objects. Each entry in the array is either a java.lang.String or a java.lang.Number
public Scriptable getParentScope()
Get the parent scope of the object.
- Returns:
- the parent scope
public boolean has(String name, Scriptable start)
Indicates whether or not a named property is defined in an object. Does not traverse the prototype chain. The property is specified by a String name as defined for theget
method.
- Parameters:
name
- the name of the propertystart
- the object in which the lookup began
- Returns:
- true if and only if the named property is found in the object
- See Also:
org.mozilla.javascript.Scriptable.get
,org.mozilla.javascript.ScriptableObject.getProperty
public boolean has(int index, Scriptable start)
Indicates whether or not an indexed property is defined in an object. Does not traverse the prototype chain. The property is specified by an integral index as defined for theget
method.
- Parameters:
index
- the numeric index for the propertystart
- the object in which the lookup began
- Returns:
- true if and only if the indexed property is found in the object
- See Also:
org.mozilla.javascript.Scriptable.get
,org.mozilla.javascript.ScriptableObject.getProperty
public boolean hasInstance(Scriptable instance)
The instanceof operator. 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
public void put(String name, Scriptable start, Object value)
Sets a named property in this object. The property is specified by a string name as defined forget
. The possible values that may be passed in are as defined forget
. 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, useputProperty
in ScriptableObject. Note that if a property a is defined in the prototype p of an object o, then evaluatingo.a = 23
will causeset
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
- java.lang.Boolean objects
- java.lang.String objects
- java.lang.Number objects
- org.mozilla.javascript.Scriptable objects
- null
- The value returned by Context.getUndefinedValue()
Context.toObject
. This allows the property of a JavaScript object to contain an arbitrary Java object as a value. Note thathas
will be called by the runtime first beforeset
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 propertystart
- the object whose property is being setvalue
- value to set the property to
- See Also:
org.mozilla.javascript.Scriptable.has
,org.mozilla.javascript.Scriptable.get
,org.mozilla.javascript.ScriptableObject.putProperty
,org.mozilla.javascript.Context.toObject
public void put(int index, Scriptable start, Object value)
Sets an indexed property in this object. The property is specified by an integral index as defined forget
. Identical toput(String, Scriptable, Object)
except that an integral index is used to select the property.
- Parameters:
index
- the numeric index for the propertystart
- the object whose property is being setvalue
- value to set the property to
- See Also:
org.mozilla.javascript.Scriptable.has
,org.mozilla.javascript.Scriptable.get
,put(String,Scriptable,Object)
,org.mozilla.javascript.ScriptableObject.putProperty
public void setParentScope(Scriptable parent)
Set the parent scope of the object.
- Parameters:
parent
- the parent scope to set
public void setPrototype(Scriptable prototype)
Set the prototype of the object.
- Parameters:
prototype
- the prototype to set