diff options
Diffstat (limited to 'trunk/infrastructure/rhino1_7R1/javadoc/org/mozilla/javascript/Scriptable.html')
| -rw-r--r-- | trunk/infrastructure/rhino1_7R1/javadoc/org/mozilla/javascript/Scriptable.html | 756 |
1 files changed, 756 insertions, 0 deletions
diff --git a/trunk/infrastructure/rhino1_7R1/javadoc/org/mozilla/javascript/Scriptable.html b/trunk/infrastructure/rhino1_7R1/javadoc/org/mozilla/javascript/Scriptable.html new file mode 100644 index 0000000..14ab7aa --- /dev/null +++ b/trunk/infrastructure/rhino1_7R1/javadoc/org/mozilla/javascript/Scriptable.html @@ -0,0 +1,756 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!--NewPage--> +<HTML> +<HEAD> +<!-- Generated by javadoc (build 1.6.0) on Thu Mar 06 17:19:15 EST 2008 --> +<TITLE> +Scriptable (Rhino) +</TITLE> + +<META NAME="date" CONTENT="2008-03-06"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="Scriptable (Rhino)"; + } +} +</SCRIPT> +<NOSCRIPT> +</NOSCRIPT> + +</HEAD> + +<BODY BGCOLOR="white" onload="windowTitle();"> +<HR> + + +<!-- ========= START OF TOP NAVBAR ======= --> +<A NAME="navbar_top"><!-- --></A> +<A HREF="#skip-navbar_top" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_top_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../org/mozilla/javascript/Script.html" title="interface in org.mozilla.javascript"><B>PREV CLASS</B></A> + <A HREF="../../../org/mozilla/javascript/ScriptableObject.html" title="class in org.mozilla.javascript"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../index.html?org/mozilla/javascript/Scriptable.html" target="_top"><B>FRAMES</B></A> + <A HREF="Scriptable.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- + if(window==top) { + document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_top"></A> +<!-- ========= END OF TOP NAVBAR ========= --> + +<HR> +<!-- ======== START OF CLASS DATA ======== --> +<H2> +<FONT SIZE="-1"> +org.mozilla.javascript</FONT> +<BR> +Interface Scriptable</H2> +<DL> +<DT><B>All Known Subinterfaces:</B> <DD><A HREF="../../../org/mozilla/javascript/Function.html" title="interface in org.mozilla.javascript">Function</A></DD> +</DL> +<DL> +<DT><B>All Known Implementing Classes:</B> <DD>org.mozilla.javascript.BaseFunction, org.mozilla.javascript.Delegator, <A HREF="../../../org/mozilla/javascript/FunctionObject.html" title="class in org.mozilla.javascript">FunctionObject</A>, org.mozilla.javascript.IdScriptableObject, <A HREF="../../../org/mozilla/javascript/ImporterTopLevel.html" title="class in org.mozilla.javascript">ImporterTopLevel</A>, <A HREF="../../../org/mozilla/javascript/ScriptableObject.html" title="class in org.mozilla.javascript">ScriptableObject</A>, <A HREF="../../../org/mozilla/javascript/Synchronizer.html" title="class in org.mozilla.javascript">Synchronizer</A></DD> +</DL> +<HR> +<DL> +<DT><PRE>public interface <B>Scriptable</B></DL> +</PRE> + +<P> +This is interface that all objects in JavaScript must implement. + The interface provides for the management of properties and for + performing conversions. + <p> + Host system implementors may find it easier to extend the ScriptableObject + class rather than implementing Scriptable when writing host objects. + <p> + 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. + <p> +<P> + +<P> +<DL> +<DT><B>Author:</B></DT> + <DD>Norris Boyd, Nick Thompson, Brendan Eich</DD> +<DT><B>See Also:</B><DD><A HREF="../../../org/mozilla/javascript/ScriptableObject.html" title="class in org.mozilla.javascript"><CODE>ScriptableObject</CODE></A></DL> +<HR> + +<P> +<!-- =========== FIELD SUMMARY =========== --> + +<A NAME="field_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Field Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static java.lang.Object</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/mozilla/javascript/Scriptable.html#NOT_FOUND">NOT_FOUND</A></B></CODE> + +<BR> + Value returned from <code>get</code> if the property is not + found.</TD> +</TR> +</TABLE> + +<!-- ========== METHOD SUMMARY =========== --> + +<A NAME="method_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Method Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/mozilla/javascript/Scriptable.html#delete(int)">delete</A></B>(int index)</CODE> + +<BR> + Removes a property from this object.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/mozilla/javascript/Scriptable.html#delete(java.lang.String)">delete</A></B>(java.lang.String name)</CODE> + +<BR> + Removes a property from this object.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.Object</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/mozilla/javascript/Scriptable.html#get(int, org.mozilla.javascript.Scriptable)">get</A></B>(int index, + <A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> start)</CODE> + +<BR> + Get a property from the object selected by an integral index.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.Object</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/mozilla/javascript/Scriptable.html#get(java.lang.String, org.mozilla.javascript.Scriptable)">get</A></B>(java.lang.String name, + <A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> start)</CODE> + +<BR> + Get a named property from the object.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/mozilla/javascript/Scriptable.html#getClassName()">getClassName</A></B>()</CODE> + +<BR> + Get the name of the set of objects implemented by this Java class.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.Object</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/mozilla/javascript/Scriptable.html#getDefaultValue(java.lang.Class)">getDefaultValue</A></B>(java.lang.Class hint)</CODE> + +<BR> + Get the default value of the object with a given hint.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.Object[]</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/mozilla/javascript/Scriptable.html#getIds()">getIds</A></B>()</CODE> + +<BR> + Get an array of property ids.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/mozilla/javascript/Scriptable.html#getParentScope()">getParentScope</A></B>()</CODE> + +<BR> + Get the parent scope of the object.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/mozilla/javascript/Scriptable.html#getPrototype()">getPrototype</A></B>()</CODE> + +<BR> + Get the prototype of the object.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/mozilla/javascript/Scriptable.html#has(int, org.mozilla.javascript.Scriptable)">has</A></B>(int index, + <A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> start)</CODE> + +<BR> + Indicates whether or not an indexed property is defined in an object.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/mozilla/javascript/Scriptable.html#has(java.lang.String, org.mozilla.javascript.Scriptable)">has</A></B>(java.lang.String name, + <A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> start)</CODE> + +<BR> + Indicates whether or not a named property is defined in an object.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/mozilla/javascript/Scriptable.html#hasInstance(org.mozilla.javascript.Scriptable)">hasInstance</A></B>(<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> instance)</CODE> + +<BR> + The instanceof operator.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/mozilla/javascript/Scriptable.html#put(int, org.mozilla.javascript.Scriptable, java.lang.Object)">put</A></B>(int index, + <A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> start, + java.lang.Object value)</CODE> + +<BR> + Sets an indexed property in this object.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/mozilla/javascript/Scriptable.html#put(java.lang.String, org.mozilla.javascript.Scriptable, java.lang.Object)">put</A></B>(java.lang.String name, + <A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> start, + java.lang.Object value)</CODE> + +<BR> + Sets a named property in this object.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/mozilla/javascript/Scriptable.html#setParentScope(org.mozilla.javascript.Scriptable)">setParentScope</A></B>(<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> parent)</CODE> + +<BR> + Set the parent scope of the object.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../org/mozilla/javascript/Scriptable.html#setPrototype(org.mozilla.javascript.Scriptable)">setPrototype</A></B>(<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> prototype)</CODE> + +<BR> + Set the prototype of the object.</TD> +</TR> +</TABLE> + +<P> + +<!-- ============ FIELD DETAIL =========== --> + +<A NAME="field_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> +<B>Field Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="NOT_FOUND"><!-- --></A><H3> +NOT_FOUND</H3> +<PRE> +static final java.lang.Object <B>NOT_FOUND</B></PRE> +<DL> +<DD>Value returned from <code>get</code> if the property is not + found. +<P> +<DL> +</DL> +</DL> + +<!-- ============ METHOD DETAIL ========== --> + +<A NAME="method_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> +<B>Method Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="getClassName()"><!-- --></A><H3> +getClassName</H3> +<PRE> +java.lang.String <B>getClassName</B>()</PRE> +<DL> +<DD>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.<p> + See ECMA 8.6.2 and 15.2.4.2. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="get(java.lang.String, org.mozilla.javascript.Scriptable)"><!-- --></A><H3> +get</H3> +<PRE> +java.lang.Object <B>get</B>(java.lang.String name, + <A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> start)</PRE> +<DL> +<DD>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 of <code>get</code> that takes an + integer: + <table> + <tr><th>JavaScript code</th><th>Java code</th></tr> + <tr><td>a.b </td><td>a.get("b", a)</td></tr> + <tr><td>a["foo"] </td><td>a.get("foo", a)</td></tr> + <tr><td>a[3] </td><td>a.get(3, a)</td></tr> + <tr><td>a["3"] </td><td>a.get(3, a)</td></tr> + <tr><td>a[3.0] </td><td>a.get(3, a)</td></tr> + <tr><td>a["3.0"] </td><td>a.get("3.0", a)</td></tr> + <tr><td>a[1.1] </td><td>a.get("1.1", a)</td></tr> + <tr><td>a[-4] </td><td>a.get(-4, a)</td></tr> + </table> + <p> + The values that may be returned are limited to the following: + <UL> + <LI>java.lang.Boolean objects</LI> + <LI>java.lang.String objects</LI> + <LI>java.lang.Number objects</LI> + <LI>org.mozilla.javascript.Scriptable objects</LI> + <LI>null</LI> + <LI>The value returned by Context.getUndefinedValue()</LI> + <LI>NOT_FOUND</LI> + </UL> +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the property<DD><CODE>start</CODE> - the object in which the lookup began +<DT><B>Returns:</B><DD>the value of the property (may be null), or NOT_FOUND<DT><B>See Also:</B><DD><A HREF="../../../org/mozilla/javascript/Context.html#getUndefinedValue()"><CODE>Context.getUndefinedValue()</CODE></A></DL> +</DD> +</DL> +<HR> + +<A NAME="get(int, org.mozilla.javascript.Scriptable)"><!-- --></A><H3> +get</H3> +<PRE> +java.lang.Object <B>get</B>(int index, + <A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> start)</PRE> +<DL> +<DD>Get a property from the object selected by an integral index. + + Identical to <code>get(String, Scriptable)</code> except that + an integral index is used to select the property. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>index</CODE> - the numeric index for the property<DD><CODE>start</CODE> - the object in which the lookup began +<DT><B>Returns:</B><DD>the value of the property (may be null), or NOT_FOUND<DT><B>See Also:</B><DD><A HREF="../../../org/mozilla/javascript/Scriptable.html#get(java.lang.String, org.mozilla.javascript.Scriptable)"><CODE>get(String,Scriptable)</CODE></A></DL> +</DD> +</DL> +<HR> + +<A NAME="has(java.lang.String, org.mozilla.javascript.Scriptable)"><!-- --></A><H3> +has</H3> +<PRE> +boolean <B>has</B>(java.lang.String name, + <A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> start)</PRE> +<DL> +<DD>Indicates whether or not a named property is defined in an object. + + Does not traverse the prototype chain.<p> + + The property is specified by a String name + as defined for the <code>get</code> method.<p> +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the property<DD><CODE>start</CODE> - the object in which the lookup began +<DT><B>Returns:</B><DD>true if and only if the named property is found in the object<DT><B>See Also:</B><DD><A HREF="../../../org/mozilla/javascript/Scriptable.html#get(java.lang.String, org.mozilla.javascript.Scriptable)"><CODE>get(String, Scriptable)</CODE></A>, +<A HREF="../../../org/mozilla/javascript/ScriptableObject.html#getProperty(org.mozilla.javascript.Scriptable, java.lang.String)"><CODE>ScriptableObject.getProperty(Scriptable, String)</CODE></A></DL> +</DD> +</DL> +<HR> + +<A NAME="has(int, org.mozilla.javascript.Scriptable)"><!-- --></A><H3> +has</H3> +<PRE> +boolean <B>has</B>(int index, + <A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> start)</PRE> +<DL> +<DD>Indicates whether or not an indexed property is defined in an object. + + Does not traverse the prototype chain.<p> + + The property is specified by an integral index + as defined for the <code>get</code> method.<p> +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>index</CODE> - the numeric index for the property<DD><CODE>start</CODE> - the object in which the lookup began +<DT><B>Returns:</B><DD>true if and only if the indexed property is found in the object<DT><B>See Also:</B><DD><A HREF="../../../org/mozilla/javascript/Scriptable.html#get(int, org.mozilla.javascript.Scriptable)"><CODE>get(int, Scriptable)</CODE></A>, +<A HREF="../../../org/mozilla/javascript/ScriptableObject.html#getProperty(org.mozilla.javascript.Scriptable, int)"><CODE>ScriptableObject.getProperty(Scriptable, int)</CODE></A></DL> +</DD> +</DL> +<HR> + +<A NAME="put(java.lang.String, org.mozilla.javascript.Scriptable, java.lang.Object)"><!-- --></A><H3> +put</H3> +<PRE> +void <B>put</B>(java.lang.String name, + <A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> start, + java.lang.Object value)</PRE> +<DL> +<DD>Sets a named property in this object. + <p> + The property is specified by a string name + as defined for <code>get</code>. + <p> + The possible values that may be passed in are as defined for + <code>get</code>. A class that implements this method may choose + to ignore calls to set certain properties, in which case those + properties are effectively read-only.<p> + For properties defined in a prototype chain, + use <code>putProperty</code> in ScriptableObject. <p> + Note that if a property <i>a</i> is defined in the prototype <i>p</i> + of an object <i>o</i>, then evaluating <code>o.a = 23</code> will cause + <code>set</code> to be called on the prototype <i>p</i> with + <i>o</i> as the <i>start</i> parameter. + To preserve JavaScript semantics, it is the Scriptable + object's responsibility to modify <i>o</i>. <p> + 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.<p> + <p> + The values that may be set are limited to the following: + <UL> + <LI>java.lang.Boolean objects</LI> + <LI>java.lang.String objects</LI> + <LI>java.lang.Number objects</LI> + <LI>org.mozilla.javascript.Scriptable objects</LI> + <LI>null</LI> + <LI>The value returned by Context.getUndefinedValue()</LI> + </UL><p> + Arbitrary Java objects may be wrapped in a Scriptable by first calling + <code>Context.toObject</code>. This allows the property of a JavaScript + object to contain an arbitrary Java object as a value.<p> + Note that <code>has</code> will be called by the runtime first before + <code>set</code> 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. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the property<DD><CODE>start</CODE> - the object whose property is being set<DD><CODE>value</CODE> - value to set the property to<DT><B>See Also:</B><DD><A HREF="../../../org/mozilla/javascript/Scriptable.html#has(java.lang.String, org.mozilla.javascript.Scriptable)"><CODE>has(String, Scriptable)</CODE></A>, +<A HREF="../../../org/mozilla/javascript/Scriptable.html#get(java.lang.String, org.mozilla.javascript.Scriptable)"><CODE>get(String, Scriptable)</CODE></A>, +<A HREF="../../../org/mozilla/javascript/ScriptableObject.html#putProperty(org.mozilla.javascript.Scriptable, java.lang.String, java.lang.Object)"><CODE>ScriptableObject.putProperty(Scriptable, String, Object)</CODE></A>, +<A HREF="../../../org/mozilla/javascript/Context.html#toObject(java.lang.Object, org.mozilla.javascript.Scriptable)"><CODE>Context.toObject(Object, Scriptable)</CODE></A></DL> +</DD> +</DL> +<HR> + +<A NAME="put(int, org.mozilla.javascript.Scriptable, java.lang.Object)"><!-- --></A><H3> +put</H3> +<PRE> +void <B>put</B>(int index, + <A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> start, + java.lang.Object value)</PRE> +<DL> +<DD>Sets an indexed property in this object. + <p> + The property is specified by an integral index + as defined for <code>get</code>.<p> + + Identical to <code>put(String, Scriptable, Object)</code> except that + an integral index is used to select the property. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>index</CODE> - the numeric index for the property<DD><CODE>start</CODE> - the object whose property is being set<DD><CODE>value</CODE> - value to set the property to<DT><B>See Also:</B><DD><A HREF="../../../org/mozilla/javascript/Scriptable.html#has(int, org.mozilla.javascript.Scriptable)"><CODE>has(int, Scriptable)</CODE></A>, +<A HREF="../../../org/mozilla/javascript/Scriptable.html#get(int, org.mozilla.javascript.Scriptable)"><CODE>get(int, Scriptable)</CODE></A>, +<A HREF="../../../org/mozilla/javascript/ScriptableObject.html#putProperty(org.mozilla.javascript.Scriptable, int, java.lang.Object)"><CODE>ScriptableObject.putProperty(Scriptable, int, Object)</CODE></A>, +<A HREF="../../../org/mozilla/javascript/Context.html#toObject(java.lang.Object, org.mozilla.javascript.Scriptable)"><CODE>Context.toObject(Object, Scriptable)</CODE></A></DL> +</DD> +</DL> +<HR> + +<A NAME="delete(java.lang.String)"><!-- --></A><H3> +delete</H3> +<PRE> +void <B>delete</B>(java.lang.String name)</PRE> +<DL> +<DD>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. + <p> + A property can be made permanent by ignoring calls to remove + it.<p> + The property is specified by a String name + as defined for <code>get</code>. + <p> + To delete properties defined in a prototype chain, + see deleteProperty in ScriptableObject. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>name</CODE> - the identifier for the property<DT><B>See Also:</B><DD><A HREF="../../../org/mozilla/javascript/Scriptable.html#get(java.lang.String, org.mozilla.javascript.Scriptable)"><CODE>get(String, Scriptable)</CODE></A>, +<A HREF="../../../org/mozilla/javascript/ScriptableObject.html#deleteProperty(org.mozilla.javascript.Scriptable, java.lang.String)"><CODE>ScriptableObject.deleteProperty(Scriptable, String)</CODE></A></DL> +</DD> +</DL> +<HR> + +<A NAME="delete(int)"><!-- --></A><H3> +delete</H3> +<PRE> +void <B>delete</B>(int index)</PRE> +<DL> +<DD>Removes a property from this object. + + The property is specified by an integral index + as defined for <code>get</code>. + <p> + To delete properties defined in a prototype chain, + see deleteProperty in ScriptableObject. + + Identical to <code>delete(String)</code> except that + an integral index is used to select the property. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>index</CODE> - the numeric index for the property<DT><B>See Also:</B><DD><A HREF="../../../org/mozilla/javascript/Scriptable.html#get(int, org.mozilla.javascript.Scriptable)"><CODE>get(int, Scriptable)</CODE></A>, +<A HREF="../../../org/mozilla/javascript/ScriptableObject.html#deleteProperty(org.mozilla.javascript.Scriptable, int)"><CODE>ScriptableObject.deleteProperty(Scriptable, int)</CODE></A></DL> +</DD> +</DL> +<HR> + +<A NAME="getPrototype()"><!-- --></A><H3> +getPrototype</H3> +<PRE> +<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> <B>getPrototype</B>()</PRE> +<DL> +<DD>Get the prototype of the object. +<P> +<DD><DL> + +<DT><B>Returns:</B><DD>the prototype</DL> +</DD> +</DL> +<HR> + +<A NAME="setPrototype(org.mozilla.javascript.Scriptable)"><!-- --></A><H3> +setPrototype</H3> +<PRE> +void <B>setPrototype</B>(<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> prototype)</PRE> +<DL> +<DD>Set the prototype of the object. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>prototype</CODE> - the prototype to set</DL> +</DD> +</DL> +<HR> + +<A NAME="getParentScope()"><!-- --></A><H3> +getParentScope</H3> +<PRE> +<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> <B>getParentScope</B>()</PRE> +<DL> +<DD>Get the parent scope of the object. +<P> +<DD><DL> + +<DT><B>Returns:</B><DD>the parent scope</DL> +</DD> +</DL> +<HR> + +<A NAME="setParentScope(org.mozilla.javascript.Scriptable)"><!-- --></A><H3> +setParentScope</H3> +<PRE> +void <B>setParentScope</B>(<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> parent)</PRE> +<DL> +<DD>Set the parent scope of the object. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>parent</CODE> - the parent scope to set</DL> +</DD> +</DL> +<HR> + +<A NAME="getIds()"><!-- --></A><H3> +getIds</H3> +<PRE> +java.lang.Object[] <B>getIds</B>()</PRE> +<DL> +<DD>Get an array of property ids. + + Not all property ids need be returned. Those properties + whose ids are not returned are considered non-enumerable. +<P> +<DD><DL> + +<DT><B>Returns:</B><DD>an array of Objects. Each entry in the array is either + a java.lang.String or a java.lang.Number</DL> +</DD> +</DL> +<HR> + +<A NAME="getDefaultValue(java.lang.Class)"><!-- --></A><H3> +getDefaultValue</H3> +<PRE> +java.lang.Object <B>getDefaultValue</B>(java.lang.Class hint)</PRE> +<DL> +<DD>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. <p> + + A <code>hint</code> of null means "no hint". + + See ECMA 8.6.2.6. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>hint</CODE> - the type hint +<DT><B>Returns:</B><DD>the default value</DL> +</DD> +</DL> +<HR> + +<A NAME="hasInstance(org.mozilla.javascript.Scriptable)"><!-- --></A><H3> +hasInstance</H3> +<PRE> +boolean <B>hasInstance</B>(<A HREF="../../../org/mozilla/javascript/Scriptable.html" title="interface in org.mozilla.javascript">Scriptable</A> instance)</PRE> +<DL> +<DD>The instanceof operator. + + <p> + The JavaScript code "lhs instanceof rhs" causes rhs.hasInstance(lhs) to + be called. + + <p> + 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. + + <p>This operator corresponds to the proposed EMCA [[HasInstance]] operator. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>instance</CODE> - The value that appeared on the LHS of the instanceof + operator +<DT><B>Returns:</B><DD>an implementation dependent value</DL> +</DD> +</DL> +<!-- ========= END OF CLASS DATA ========= --> +<HR> + + +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<A NAME="navbar_bottom"><!-- --></A> +<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_bottom_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../org/mozilla/javascript/Script.html" title="interface in org.mozilla.javascript"><B>PREV CLASS</B></A> + <A HREF="../../../org/mozilla/javascript/ScriptableObject.html" title="class in org.mozilla.javascript"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../index.html?org/mozilla/javascript/Scriptable.html" target="_top"><B>FRAMES</B></A> + <A HREF="Scriptable.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- + if(window==top) { + document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_bottom"></A> +<!-- ======== END OF BOTTOM NAVBAR ======= --> + +<HR> + +</BODY> +</HTML> |