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#HTMLFileUploadElement} class.</p>
028  * <p>This class represents a file select control 
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 "file" whose {@link JsHTMLInputElement#value} attribute may be 
032  * used as the initial file name by the web browser.</p>
033  * <p>An input element of this class consists of a text input field for entering the 
034  * name of a file, along with a button that opens a file-selection dialog box for 
035  * graphical selection of a file. The {@link JsHTMLInputElement#value} property holds 
036  * the name of the file the user has specified, but when the {@link JsHTMLInputElement#form} 
037  * containing the file-upload element is submitted, the browser sends the contents of 
038  * the selected file to the server instead of just sending the filename. For this to 
039  * work, the {@link JsHTMLInputElement#form} must use "multipart/form-data" encoding 
040  * and the POST method.</p>
041  * <p>For security, an input element of this type does not allow HTML authors or script 
042  * programmers to specify a default filename. The HTML <tt>value</tt> attribute is 
043  * ignored, and the {@link JsHTMLInputElement#value} property is read-only for this 
044  * type of element, which means that only the user may enter a filename. When the user 
045  * selects or edits a filename, the file-upload element triggers the {@link JsHTMLInputElement#onchange} 
046  * event handler.</p>
047  *  
048  * @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>
049  *
050  * @javascript <b>Opaque</b> types can be resolved but no class objects for them can be
051  * generated into the target codes. Re-compilers must exit with error on the operations of
052  * accessing that kind of class objects.
053  * The <tt>checkcast</tt> operation to the class literal of this interface must be ignored
054  * and <tt>instanceof</tt> to it always <tt>true</tt>.
055  */
056 public class JsHTMLFileUploadElement extends JsClient.HTMLFileUploadElement.Prototype
057 {
058     /**
059      * <p>An <b>opaque</b> class representing members of its enclosing <b>opaque</b> type.</p>
060      * <p>Note that, this class is <b>opaque</b> but its constructors are all <b>internal</b>. 
061      * This class and the subclasses of this class are used to declare either <b>opaque</b> 
062      * <tt>public</tt> instance fields of the opaque type {@link js.Var.Member} or the 
063      * <b>opaque</b> <tt>public</tt> static fields of other <b>opaque</b> types while their 
064      * constructors are used to define the fields inside <b>opaque</b> classes. Under 
065      * either circumstance, the field names must be exactly same as the member names, as 
066      * the <b>opaque</b> fields of <b>opaque</b> types are resolved by re-compilers directly 
067      * based on the field names.</p>
068      *
069      * @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>
070      * 
071      * @javascript <b>Opaque</b> types can be resolved but no class objects for them can be created
072      * in the target codes. Re-compilers must exit with error on operations accessing that kind 
073      * of class objects.
074      * Re-compilers must resolve an <b>opaque</b> instance field declared by this class in
075      * {@link js.Var.Member} or its subclasses to the JavaScript identifier: 
076      * <pre>q.m</pre>
077      * where <tt>m</tt> is the identifier of the field name and <tt>q</tt> is the identifier
078      * resolved from the instance of the enclosing member. Re-compilers must resolve an 
079      * <b>opaque</b> static field declared by this class in <b>opaque</b> types other than 
080      * {@link js.Var.Member} and its subclasses to the JavaScript identifier: 
081      * <pre>m</pre>
082      * where <tt>m</tt> is the identifier of the field name. And re-compilers must report
083      * error on the access to <b>opaque</b> fields declared by this class under any other 
084      * circumstances.
085      */
086     public static class Member extends JsClient.HTMLFileUploadElement.Prototype.Member
087     {
088         /**
089          * <p>Internally constructs a member based on a qualifying member.</p>
090          * <p>This constructor is <b>internal</b> and only called inside of <b>opaque</b>
091          * or <b>internal</b> classes or class members.</p>
092          * <p>Note that, this constructor is <b>internal</b> but its declaring class is
093          * <b>opaque</b>. This constructor is used to define <b>opaque</b> instance fields 
094          * declared in the declaring class of this constructor itself or its subclasses. 
095          * Under this circumstance, the field names must be exactly same as the member 
096          * names, as the <b>opaque</b> instance fields of the <b>opaque</b> type 
097          * {@link js.Var.Member} or its subclasses are resolved by re-compilers directly
098          * to their names appending to the name resolved from the specified qualifying 
099          * member with a dot in between.</p>
100          * @param q A qualifying member
101          * @param mid The ID of the member to construct
102          * @since 1.0
103          * @javascript Re-compilers must report error on the invocation to an <b>internal</b> constructor.
104          */
105         public Member(JsObject.Member q, Mid mid) {
106             super(q, mid);
107         }
108         /**
109          * <p>Internally constructs a member without a qualifying member.</p>
110          * <p>This constructor is <b>internal</b> and only called inside of <b>opaque</b>
111          * or <b>internal</b> classes or class members.</p>
112          * <p>Note that, this constructor is <b>internal</b> but its declaring class is
113          * <b>opaque</b>. This constructor is used to define <b>opaque</b> static fields, 
114          * declared in <b>opaque</b> types other than the declaring class of this constructor 
115          * itself and its subclasses. Under this circumstance, the field names must be
116          * exactly same as the member names, as the <b>opaque</b> static fields of <b>opaque</b>
117          * types are generally resolved by re-compilers directly to identifiers of their names.</p>
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(Mid mid) {
123             super(mid);
124         }
125         @Override
126         /**
127          * <p>Evaluates the property, represented by the current member instance, of the
128          * argument object.</p>
129          * @param o The argument object
130          * @return The value of the current member based on the object argument.
131          * @since 1.0
132          * @javascript Re-compilers must convert the instance invocation of this method into
133          * the JavaScript expression: 
134          * <pre>o.m</pre>
135          * where <tt>m</tt> is the identifier name resolved from the current member
136          * instance of the invocation.
137          */
138         public JsHTMLFileUploadElement with(ObjectLike o) {
139             return new JsHTMLFileUploadElement(super.with(o));
140         }
141     }
142 
143     /**
144      * <p>Casts an <b>opaque</b> object to the current <b>opaque</b> type by wrapping it
145      * with the wrapping constructor.</p>
146      * @param var The argument of an <b>opaque</b> object.
147      * @since 1.0
148      * @javascript Re-compilers must ignore the construction operation of this constructor,
149      * that is, replacing it with its only argument.
150      */
151     public JsHTMLFileUploadElement(JsObject var) {
152         super(var);
153     }
154 
155     @Override
156     /**
157      * <p>Returns the primitive value associated with the current instance, if there is one.
158      * This invocation simply returns the instance itself for the current instance is an 
159      * object and there is no primitive value for it.</p>
160      * @return The current object itself.
161      * @since 1.0
162      * @javascript Re-compilers must convert the instance invocation of this method directly
163      * into a JavaScript invocation on its current object instance without changing the 
164      * method name, but expanding variable arguments, if any, into comma-separated values. 
165      */
166     public JsHTMLFileUploadElement valueOf() {
167         return new JsHTMLFileUploadElement((JsObject)var().valueOf());
168     }
169 }