001 
002 /*
003  *  JScripter Standard 1.0 - To Script In Java
004  *  Copyright (C) 2008-2011  J.J.Liu<jianjunliu@126.com> <http://www.jscripter.org>
005  *  
006  *  This program is free software: you can redistribute it and/or modify
007  *  it under the terms of the GNU Affero General Public License as published by
008  *  the Free Software Foundation, either version 3 of the License, or
009  *  (at your option) any later version.
010  *  
011  *  This program is distributed in the hope that it will be useful,
012  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
013  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
014  *  GNU Affero General Public License for more details.
015  *  
016  *  You should have received a copy of the GNU Affero General Public License
017  *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
018  */
019 
020 package js.user;
021 
022 import js.*;
023 import js.core.*;
024 
025 /**
026  * <p>An <b>opaque</b> class representing JavaScript client-side objects of the global 
027  * {@link JsClient#HTMLIsIndexElement} class.</p>
028  * <p>This class represents a single-line text input element 
029  * in an HTML page, or a {@link JsHTMLElement} object created with the HTML 
030  * tag <tt>&lt;isindex&gt;</tt> which is deprecated by HTML 4.01 and should be handled 
031  * by a {@link JsHTMLTextFieldElement} object created by the HTML <tt>&lt;input&gt;</tt> 
032  * tag with its <tt>type</tt> attribute of the value "text".</p> 
033  *
034  * @author <a href="mailto:jianjunliu@126.com">J.J.Liu (Jianjun Liu)</a> at <a href="http://www.jscripter.org" target="_blank">http://www.jscripter.org</a>
035  *
036  * @javascript <b>Opaque</b> types can be resolved but no class objects for them can be
037  * generated into the target codes. Re-compilers must exit with error on the operations of
038  * accessing that kind of class objects.
039  * The <tt>checkcast</tt> operation to the class literal of this interface must be ignored
040  * and <tt>instanceof</tt> to it always <tt>true</tt>.
041  */
042 public class JsHTMLIsIndexElement extends JsClient.HTMLIsIndexElement.Prototype
043 {
044     /**
045      * <p>An <b>internal</b> class containing membership data for its enclosing
046      * opaque class.</p>
047      * <p>This class is only used inside of <b>opaque</b> or <b>internal</b> classes or
048      * class members.</p>
049      *
050      * @author <a href="mailto:jianjunliu@126.com">J.J.Liu (Jianjun Liu)</a> at <a href="http://www.jscripter.org" target="_blank">http://www.jscripter.org</a>
051      * 
052      * @javascript Re-compilers must report error on resolving an <b>internal</b> class.
053      */
054     protected static abstract class Members extends JsClient.HTMLIsIndexElement.Prototype.Members
055     {
056         /**
057          * <p>An <b>internal</b> static field defining a member ID of the field name and
058          * used internally to define a member of the same name.</p>
059          * @since 1.0
060          * @see JsHTMLIsIndexElement#form
061          * @see JsHTMLIsIndexElement.Member#form
062          * @javascript Re-compilers must report error on accessing an <b>internal</b> field.
063          */
064         public final static Mid form   = id("form"  );
065         /**
066          * <p>An <b>internal</b> static field defining a member ID of the field name and
067          * used internally to define a member of the same name.</p>
068          * @since 1.0
069          * @see JsHTMLIsIndexElement#prompt
070          * @see JsHTMLIsIndexElement.Member#prompt
071          * @javascript Re-compilers must report error on accessing an <b>internal</b> field.
072          */
073         public final static Mid prompt = id("prompt");
074     }
075     /**
076      * <p>An <b>opaque</b> class representing members of its enclosing <b>opaque</b> type.</p>
077      * <p>Note that, this class is <b>opaque</b> but its constructors are all <b>internal</b>. 
078      * This class and the subclasses of this class are used to declare either <b>opaque</b> 
079      * <tt>public</tt> instance fields of the opaque type {@link js.Var.Member} or the 
080      * <b>opaque</b> <tt>public</tt> static fields of other <b>opaque</b> types while their 
081      * constructors are used to define the fields inside <b>opaque</b> classes. Under 
082      * either circumstance, the field names must be exactly same as the member names, as 
083      * the <b>opaque</b> fields of <b>opaque</b> types are resolved by re-compilers directly 
084      * based on the field names.</p>
085      *
086      * @author <a href="mailto:jianjunliu@126.com">J.J.Liu (Jianjun Liu)</a> at <a href="http://www.jscripter.org" target="_blank">http://www.jscripter.org</a>
087      * 
088      * @javascript <b>Opaque</b> types can be resolved but no class objects for them can be created
089      * in the target codes. Re-compilers must exit with error on operations accessing that kind 
090      * of class objects.
091      * Re-compilers must resolve an <b>opaque</b> instance field declared by this class in
092      * {@link js.Var.Member} or its subclasses to the JavaScript identifier: 
093      * <pre>q.m</pre>
094      * where <tt>m</tt> is the identifier of the field name and <tt>q</tt> is the identifier
095      * resolved from the instance of the enclosing member. Re-compilers must resolve an 
096      * <b>opaque</b> static field declared by this class in <b>opaque</b> types other than 
097      * {@link js.Var.Member} and its subclasses to the JavaScript identifier: 
098      * <pre>m</pre>
099      * where <tt>m</tt> is the identifier of the field name. And re-compilers must report
100      * error on the access to <b>opaque</b> fields declared by this class under any other 
101      * circumstances.
102      */
103     public static class Member extends JsClient.HTMLIsIndexElement.Prototype.Member
104     {
105         /**
106          * <p>Internally constructs a member based on a qualifying member.</p>
107          * <p>This constructor is <b>internal</b> and only called inside of <b>opaque</b>
108          * or <b>internal</b> classes or class members.</p>
109          * <p>Note that, this constructor is <b>internal</b> but its declaring class is
110          * <b>opaque</b>. This constructor is used to define <b>opaque</b> instance fields 
111          * declared in the declaring class of this constructor itself or its subclasses. 
112          * Under this circumstance, the field names must be exactly same as the member 
113          * names, as the <b>opaque</b> instance fields of the <b>opaque</b> type 
114          * {@link js.Var.Member} or its subclasses are resolved by re-compilers directly
115          * to their names appending to the name resolved from the specified qualifying 
116          * member with a dot in between.</p>
117          * @param q A qualifying member
118          * @param mid The ID of the member to construct
119          * @since 1.0
120          * @javascript Re-compilers must report error on the invocation to an <b>internal</b> constructor.
121          */
122         public Member(JsObject.Member q, Mid mid) {
123             super(q, mid);
124         }
125         /**
126          * <p>Internally constructs a member without a qualifying member.</p>
127          * <p>This constructor is <b>internal</b> and only called inside of <b>opaque</b>
128          * or <b>internal</b> classes or class members.</p>
129          * <p>Note that, this constructor is <b>internal</b> but its declaring class is
130          * <b>opaque</b>. This constructor is used to define <b>opaque</b> static fields, 
131          * declared in <b>opaque</b> types other than the declaring class of this constructor 
132          * itself and its subclasses. Under this circumstance, the field names must be
133          * exactly same as the member names, as the <b>opaque</b> static fields of <b>opaque</b>
134          * types are generally resolved by re-compilers directly to identifiers of their names.</p>
135          * @param mid The ID of the member to construct
136          * @since 1.0
137          * @javascript Re-compilers must report error on the invocation to an <b>internal</b> constructor.
138          */
139         public Member(Mid mid) {
140             super(mid);
141         }
142         @Override
143         /**
144          * <p>Evaluates the property, represented by the current member instance, of the
145          * argument object.</p>
146          * @param o The argument object
147          * @return The value of the current member based on the object argument.
148          * @since 1.0
149          * @javascript Re-compilers must convert the instance invocation of this method into
150          * the JavaScript expression: 
151          * <pre>o.m</pre>
152          * where <tt>m</tt> is the identifier name resolved from the current member
153          * instance of the invocation.
154          */
155         public JsHTMLIsIndexElement with(ObjectLike o) {
156             return new JsHTMLIsIndexElement(super.with(o));
157         }
158 
159         /**
160          * <p>An <b>opaque</b> instance field defining a sub-member that is named by the
161          * name of this field, qualified by the current member instance of the field, and 
162          * to access the property of the name on an object.</p>
163          * <p>The property, identified by this member, of a {@link JsHTMLIsIndexElement} 
164          * object is a read-only reference to the {@link JsHTMLFormElement} object 
165          * containing the control. It is <tt>null</tt> if the control is not within the 
166          * context of a form.</p>
167          * @since 1.0
168          * @javascript Re-compilers must resolve the member of this instance field to the
169          * identifier of the field name appending to the identifier resolved from its 
170          * qualifying member with a dot in between.
171          */
172         public final JsHTMLFormElement.Member form = new JsHTMLFormElement.Member(this, Members.form);
173         /**
174          * <p>An <b>opaque</b> instance field defining a sub-member that is named by the
175          * name of this field, qualified by the current member instance of the field, and 
176          * to access the property of the name on an object.</p>
177          * <p>The property, identified by this member, of a {@link JsHTMLIsIndexElement} 
178          * object refers a string specifying the prompt message for the input field.</p>
179          * <p>This attribute is deprecated by HTML 4.01 and should be handled by style sheets.</p> 
180          * @since 1.0
181          * @javascript Re-compilers must resolve the member of this instance field to the
182          * identifier of the field name appending to the identifier resolved from its 
183          * qualifying member with a dot in between.
184          */
185         public final Value.String.Member prompt = new Value.String.Member(this, Members.prompt);
186     }
187 
188     /**
189      * <p>Casts an <b>opaque</b> object to the current <b>opaque</b> type by wrapping it
190      * with the wrapping constructor.</p>
191      * @param var The argument of an <b>opaque</b> object.
192      * @since 1.0
193      * @javascript Re-compilers must ignore the construction operation of this constructor,
194      * that is, replacing it with its only argument.
195      */
196     public JsHTMLIsIndexElement(JsObject var) {
197         super(var);
198     }
199 
200     /**
201      * <p>An <b>opaque</b> static field defining a member that is named by the field name
202      * without a qualifying member and to access the property of the name on an object.</p>
203      * <p>The property, identified by this member, of a {@link JsHTMLIsIndexElement} 
204      * object is a read-only reference to the {@link JsHTMLFormElement} object 
205      * containing the control. It is <tt>null</tt> if the control is not within the 
206      * context of a form.</p>
207      * @since 1.0
208      * @javascript Re-compilers must resolve the member of this static field to the
209      * identifier of the field name.
210      */
211     public static final JsHTMLFormElement.Member form = new JsHTMLFormElement.Member(Members.form);
212     /**
213      * <p>An <b>opaque</b> static field defining a member that is named by the field name
214      * without a qualifying member and to access the property of the name on an object.</p>
215      * <p>The property, identified by this member, of a {@link JsHTMLIsIndexElement} 
216      * object refers a string specifying the prompt message for the input field.</p>
217      * <p>This attribute is deprecated by HTML 4.01 and should be handled by style sheets.</p> 
218      * @since 1.0
219      * @javascript Re-compilers must resolve the member of this static field to the
220      * identifier of the field name.
221      */
222     public static final Value.String.Member prompt = new Value.String.Member(Members.prompt);
223 
224     @Override
225     /**
226      * <p>Returns the primitive value associated with the current instance, if there is one.
227      * This invocation simply returns the instance itself for the current instance is an 
228      * object and there is no primitive value for it.</p>
229      * @return The current object itself.
230      * @since 1.0
231      * @javascript Re-compilers must convert the instance invocation of this method directly
232      * into a JavaScript invocation on its current object instance without changing the 
233      * method name, but expanding variable arguments, if any, into comma-separated values. 
234      */
235     public final JsHTMLIsIndexElement valueOf() {
236         return new JsHTMLIsIndexElement((JsObject)var().valueOf());
237     }
238 }