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