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#HTMLHiddenElement} class.</p>
028  * <p>This class represents a push button 
029  * in an HTML page, or a {@link JsHTMLInputElement} object created with the HTML 
030  * <tt>&lt;input&gt;</tt> tag with its <tt>type</tt> 
031  * attribute of the value "hidden".</p>
032  * <p>An input element of this type is, in fact, hidden. The {@link JsHTMLInputElement#value} 
033  * property of this invisible form element holds an arbitrary string to be submitted to 
034  * the web server. Use an element of this type if you want to submit data that the user 
035  * did not input directly.</p>
036  *  
037  * @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>
038  *
039  * @javascript <b>Opaque</b> types can be resolved but no class objects for them can be
040  * generated into the target codes. Re-compilers must exit with error on the operations of
041  * accessing that kind of class objects.
042  * The <tt>checkcast</tt> operation to the class literal of this interface must be ignored
043  * and <tt>instanceof</tt> to it always <tt>true</tt>.
044  */
045 public class JsHTMLHiddenElement extends JsClient.HTMLHiddenElement.Prototype
046 {
047     /**
048      * <p>An <b>opaque</b> class representing members of its enclosing <b>opaque</b> type.</p>
049      * <p>Note that, this class is <b>opaque</b> but its constructors are all <b>internal</b>. 
050      * This class and the subclasses of this class are used to declare either <b>opaque</b> 
051      * <tt>public</tt> instance fields of the opaque type {@link js.Var.Member} or the 
052      * <b>opaque</b> <tt>public</tt> static fields of other <b>opaque</b> types while their 
053      * constructors are used to define the fields inside <b>opaque</b> classes. Under 
054      * either circumstance, the field names must be exactly same as the member names, as 
055      * the <b>opaque</b> fields of <b>opaque</b> types are resolved by re-compilers directly 
056      * based on the field names.</p>
057      *
058      * @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>
059      * 
060      * @javascript <b>Opaque</b> types can be resolved but no class objects for them can be created
061      * in the target codes. Re-compilers must exit with error on operations accessing that kind 
062      * of class objects.
063      * Re-compilers must resolve an <b>opaque</b> instance field declared by this class in
064      * {@link js.Var.Member} or its subclasses to the JavaScript identifier: 
065      * <pre>q.m</pre>
066      * where <tt>m</tt> is the identifier of the field name and <tt>q</tt> is the identifier
067      * resolved from the instance of the enclosing member. Re-compilers must resolve an 
068      * <b>opaque</b> static field declared by this class in <b>opaque</b> types other than 
069      * {@link js.Var.Member} and its subclasses to the JavaScript identifier: 
070      * <pre>m</pre>
071      * where <tt>m</tt> is the identifier of the field name. And re-compilers must report
072      * error on the access to <b>opaque</b> fields declared by this class under any other 
073      * circumstances.
074      */
075     public static class Member extends JsClient.HTMLHiddenElement.Prototype.Member
076     {
077         /**
078          * <p>Internally constructs a member based on a qualifying member.</p>
079          * <p>This constructor is <b>internal</b> and only called inside of <b>opaque</b>
080          * or <b>internal</b> classes or class members.</p>
081          * <p>Note that, this constructor is <b>internal</b> but its declaring class is
082          * <b>opaque</b>. This constructor is used to define <b>opaque</b> instance fields 
083          * declared in the declaring class of this constructor itself or its subclasses. 
084          * Under this circumstance, the field names must be exactly same as the member 
085          * names, as the <b>opaque</b> instance fields of the <b>opaque</b> type 
086          * {@link js.Var.Member} or its subclasses are resolved by re-compilers directly
087          * to their names appending to the name resolved from the specified qualifying 
088          * member with a dot in between.</p>
089          * @param q A qualifying member
090          * @param mid The ID of the member to construct
091          * @since 1.0
092          * @javascript Re-compilers must report error on the invocation to an <b>internal</b> constructor.
093          */
094         public Member(JsObject.Member q, Mid mid) {
095             super(q, mid);
096         }
097         /**
098          * <p>Internally constructs a member without a qualifying member.</p>
099          * <p>This constructor is <b>internal</b> and only called inside of <b>opaque</b>
100          * or <b>internal</b> classes or class members.</p>
101          * <p>Note that, this constructor is <b>internal</b> but its declaring class is
102          * <b>opaque</b>. This constructor is used to define <b>opaque</b> static fields, 
103          * declared in <b>opaque</b> types other than the declaring class of this constructor 
104          * itself and its subclasses. Under this circumstance, the field names must be
105          * exactly same as the member names, as the <b>opaque</b> static fields of <b>opaque</b>
106          * types are generally resolved by re-compilers directly to identifiers of their names.</p>
107          * @param mid The ID of the member to construct
108          * @since 1.0
109          * @javascript Re-compilers must report error on the invocation to an <b>internal</b> constructor.
110          */
111         public Member(Mid mid) {
112             super(mid);
113         }
114         @Override
115         /**
116          * <p>Evaluates the property, represented by the current member instance, of the
117          * argument object.</p>
118          * @param o The argument object
119          * @return The value of the current member based on the object argument.
120          * @since 1.0
121          * @javascript Re-compilers must convert the instance invocation of this method into
122          * the JavaScript expression: 
123          * <pre>o.m</pre>
124          * where <tt>m</tt> is the identifier name resolved from the current member
125          * instance of the invocation.
126          */
127         public JsHTMLHiddenElement with(ObjectLike o) {
128             return new JsHTMLHiddenElement(super.with(o));
129         }
130     }
131 
132     /**
133      * <p>Casts an <b>opaque</b> object to the current <b>opaque</b> type by wrapping it
134      * with the wrapping constructor.</p>
135      * @param var The argument of an <b>opaque</b> object.
136      * @since 1.0
137      * @javascript Re-compilers must ignore the construction operation of this constructor,
138      * that is, replacing it with its only argument.
139      */
140     public JsHTMLHiddenElement(JsObject var) {
141         super(var);
142     }
143 
144     @Override
145     /**
146      * <p>Returns the primitive value associated with the current instance, if there is one.
147      * This invocation simply returns the instance itself for the current instance is an 
148      * object and there is no primitive value for it.</p>
149      * @return The current object itself.
150      * @since 1.0
151      * @javascript Re-compilers must convert the instance invocation of this method directly
152      * into a JavaScript invocation on its current object instance without changing the 
153      * method name, but expanding variable arguments, if any, into comma-separated values. 
154      */
155     public JsHTMLHiddenElement valueOf() {
156         return new JsHTMLHiddenElement((JsObject)var().valueOf());
157     }
158 }