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#HTMLFrameSetElement} class.</p>
028  * <p>This class represents a form set 
029  * in an HTML page, or a {@link JsHTMLElement} object created with the HTML 
030  * <tt>&lt;frameset&gt;</tt> tag.</p> 
031  *
032  * @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>
033  *
034  * @javascript <b>Opaque</b> types can be resolved but no class objects for them can be
035  * generated into the target codes. Re-compilers must exit with error on the operations of
036  * accessing that kind of class objects.
037  * The <tt>checkcast</tt> operation to the class literal of this interface must be ignored
038  * and <tt>instanceof</tt> to it always <tt>true</tt>.
039  */
040 public class JsHTMLFrameSetElement extends JsClient.HTMLFrameSetElement.Prototype
041 {
042     /**
043      * <p>An <b>internal</b> class containing membership data for its enclosing
044      * opaque class.</p>
045      * <p>This class is only used inside of <b>opaque</b> or <b>internal</b> classes or
046      * class members.</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 Re-compilers must report error on resolving an <b>internal</b> class.
051      */
052     protected static abstract class Members extends JsClient.HTMLFrameSetElement.Prototype.Members
053     {
054         /**
055          * <p>An <b>internal</b> static field defining a member ID of the field name and
056          * used internally to define a member of the same name.</p>
057          * @since 1.0
058          * @see JsHTMLFrameSetElement#cols
059          * @see JsHTMLFrameSetElement.Member#cols
060          * @javascript Re-compilers must report error on accessing an <b>internal</b> field.
061          */
062         public final static Mid cols = id("cols");
063         /**
064          * <p>An <b>internal</b> static field defining a member ID of the field name and
065          * used internally to define a member of the same name.</p>
066          * @since 1.0
067          * @see JsHTMLFrameSetElement#rows
068          * @see JsHTMLFrameSetElement.Member#rows
069          * @javascript Re-compilers must report error on accessing an <b>internal</b> field.
070          */
071         public final static Mid rows = id("rows");
072         /**
073          * <p>An <b>internal</b> static field defining a member ID of the field name and
074          * used internally to define a member of the same name.</p>
075          * @since 1.0
076          * @see JsHTMLFrameSetElement#onload
077          * @see JsHTMLFrameSetElement.Member#onload
078          * @javascript Re-compilers must report error on accessing an <b>internal</b> field.
079          */
080         public final static Mid onload = id("onload");
081         /**
082          * <p>An <b>internal</b> static field defining a member ID of the field name and
083          * used internally to define a member of the same name.</p>
084          * @since 1.0
085          * @see JsHTMLFrameSetElement#onunload
086          * @see JsHTMLFrameSetElement.Member#onunload
087          * @javascript Re-compilers must report error on accessing an <b>internal</b> field.
088          */
089         public final static Mid onunload = id("onunload");
090     }
091     /**
092      * <p>An <b>opaque</b> class representing members of its enclosing <b>opaque</b> type.</p>
093      * <p>Note that, this class is <b>opaque</b> but its constructors are all <b>internal</b>. 
094      * This class and the subclasses of this class are used to declare either <b>opaque</b> 
095      * <tt>public</tt> instance fields of the opaque type {@link js.Var.Member} or the 
096      * <b>opaque</b> <tt>public</tt> static fields of other <b>opaque</b> types while their 
097      * constructors are used to define the fields inside <b>opaque</b> classes. Under 
098      * either circumstance, the field names must be exactly same as the member names, as 
099      * the <b>opaque</b> fields of <b>opaque</b> types are resolved by re-compilers directly 
100      * based on the field names.</p>
101      *
102      * @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>
103      * 
104      * @javascript <b>Opaque</b> types can be resolved but no class objects for them can be created
105      * in the target codes. Re-compilers must exit with error on operations accessing that kind 
106      * of class objects.
107      * Re-compilers must resolve an <b>opaque</b> instance field declared by this class in
108      * {@link js.Var.Member} or its subclasses to the JavaScript identifier: 
109      * <pre>q.m</pre>
110      * where <tt>m</tt> is the identifier of the field name and <tt>q</tt> is the identifier
111      * resolved from the instance of the enclosing member. Re-compilers must resolve an 
112      * <b>opaque</b> static field declared by this class in <b>opaque</b> types other than 
113      * {@link js.Var.Member} and its subclasses to the JavaScript identifier: 
114      * <pre>m</pre>
115      * where <tt>m</tt> is the identifier of the field name. And re-compilers must report
116      * error on the access to <b>opaque</b> fields declared by this class under any other 
117      * circumstances.
118      */
119     public static class Member extends JsClient.HTMLFrameSetElement.Prototype.Member
120     {
121         /**
122          * <p>Internally constructs a member based on a qualifying member.</p>
123          * <p>This constructor is <b>internal</b> and only called inside of <b>opaque</b>
124          * or <b>internal</b> classes or class members.</p>
125          * <p>Note that, this constructor is <b>internal</b> but its declaring class is
126          * <b>opaque</b>. This constructor is used to define <b>opaque</b> instance fields 
127          * declared in the declaring class of this constructor itself or its subclasses. 
128          * Under this circumstance, the field names must be exactly same as the member 
129          * names, as the <b>opaque</b> instance fields of the <b>opaque</b> type 
130          * {@link js.Var.Member} or its subclasses are resolved by re-compilers directly
131          * to their names appending to the name resolved from the specified qualifying 
132          * member with a dot in between.</p>
133          * @param q A qualifying member
134          * @param mid The ID of the member to construct
135          * @since 1.0
136          * @javascript Re-compilers must report error on the invocation to an <b>internal</b> constructor.
137          */
138         public Member(JsObject.Member q, Mid mid) {
139             super(q, mid);
140         }
141         /**
142          * <p>Internally constructs a member without a qualifying member.</p>
143          * <p>This constructor is <b>internal</b> and only called inside of <b>opaque</b>
144          * or <b>internal</b> classes or class members.</p>
145          * <p>Note that, this constructor is <b>internal</b> but its declaring class is
146          * <b>opaque</b>. This constructor is used to define <b>opaque</b> static fields, 
147          * declared in <b>opaque</b> types other than the declaring class of this constructor 
148          * itself and its subclasses. Under this circumstance, the field names must be
149          * exactly same as the member names, as the <b>opaque</b> static fields of <b>opaque</b>
150          * types are generally resolved by re-compilers directly to identifiers of their names.</p>
151          * @param mid The ID of the member to construct
152          * @since 1.0
153          * @javascript Re-compilers must report error on the invocation to an <b>internal</b> constructor.
154          */
155         public Member(Mid mid) {
156             super(mid);
157         }
158         @Override
159         /**
160          * <p>Evaluates the property, represented by the current member instance, of the
161          * argument object.</p>
162          * @param o The argument object
163          * @return The value of the current member based on the object argument.
164          * @since 1.0
165          * @javascript Re-compilers must convert the instance invocation of this method into
166          * the JavaScript expression: 
167          * <pre>o.m</pre>
168          * where <tt>m</tt> is the identifier name resolved from the current member
169          * instance of the invocation.
170          */
171         public JsHTMLFrameSetElement with(ObjectLike o) {
172             return new JsHTMLFrameSetElement(super.with(o));
173         }
174 
175         /**
176          * <p>An <b>opaque</b> instance field defining a sub-member that is named by the
177          * name of this field, qualified by the current member instance of the field, and 
178          * to access the property of the name on an object.</p>
179          * <p>The property, identified by this member, of a {@link JsHTMLFrameSetElement} 
180          * object refers to a string specifying the layout of vertical frames with a 
181          * comma-separated list of pixels, percentages, and relative lengths. The 
182          * default value is 100%, meaning one column.</p> 
183          * @since 1.0
184          * @javascript Re-compilers must resolve the member of this instance field to the
185          * identifier of the field name appending to the identifier resolved from its 
186          * qualifying member with a dot in between.
187          */
188         public final Value.String.Member cols = new Value.String.Member(this, Members.cols);
189         /**
190          * <p>An <b>opaque</b> instance field defining a sub-member that is named by the
191          * name of this field, qualified by the current member instance of the field, and 
192          * to access the property of the name on an object.</p>
193          * <p>The property, identified by this member, of a {@link JsHTMLFrameSetElement} 
194          * object refers to a string specifying the layout of horizontal frames with a 
195          * comma-separated list of pixels, percentages, and relative lengths. The 
196          * default value is 100%, meaning one row.</p> 
197          * @since 1.0
198          * @javascript Re-compilers must resolve the member of this instance field to the
199          * identifier of the field name appending to the identifier resolved from its 
200          * qualifying member with a dot in between.
201          */
202         public final Value.String.Member rows = new Value.String.Member(this, Members.rows);
203         /**
204          * <p>An <b>opaque</b> instance field defining a sub-member that is named by the
205          * name of this field, qualified by the current member instance of the field, and 
206          * to access the property of the name on an object.</p>
207          * <p>The property, identified by this member, of a {@link JsHTMLFrameSetElement} object is a 
208          * reference to an event handler function invoked when the web browser finishes 
209          * loading all frames within the frame-set.</p> 
210          * @since 1.0
211          * @see JsElement#addEventListener(String, JsFunction, Boolean)
212          * @see JsElement#attachEvent(String, JsFunction)
213          * @javascript Re-compilers must resolve the member of this instance field to the
214          * identifier of the field name appending to the identifier resolved from its 
215          * qualifying member with a dot in between.
216          */
217         public final JsFunction.Member<?> onload = new JsFunction.Member<Object>(this, Members.onload);
218         /**
219          * <p>An <b>opaque</b> instance field defining a sub-member that is named by the
220          * name of this field, qualified by the current member instance of the field, and 
221          * to access the property of the name on an object.</p>
222          * <p>The property, identified by this member, of a {@link JsHTMLFrameSetElement} object is a 
223          * reference to an event handler function invoked when the web browser removes 
224          * a document from the frame-set.</p> 
225          * @since 1.0
226          * @see JsElement#addEventListener(String, JsFunction, Boolean)
227          * @see JsElement#attachEvent(String, JsFunction)
228          * @javascript Re-compilers must resolve the member of this instance field to the
229          * identifier of the field name appending to the identifier resolved from its 
230          * qualifying member with a dot in between.
231          */
232         public final JsFunction.Member<?> onunload = new JsFunction.Member<Object>(this, Members.onunload);
233     }
234 
235     /**
236      * <p>Casts an <b>opaque</b> object to the current <b>opaque</b> type by wrapping it
237      * with the wrapping constructor.</p>
238      * @param var The argument of an <b>opaque</b> object.
239      * @since 1.0
240      * @javascript Re-compilers must ignore the construction operation of this constructor,
241      * that is, replacing it with its only argument.
242      */
243     public JsHTMLFrameSetElement(JsObject var) {
244         super(var);
245     }
246 
247     /**
248      * <p>An <b>opaque</b> static field defining a member that is named by the field name
249      * without a qualifying member and to access the property of the name on an object.</p>
250      * <p>The property, identified by this member, of a {@link JsHTMLFrameSetElement} 
251      * object refers to a string specifying the layout of vertical frames with a 
252      * comma-separated list of pixels, percentages, and relative lengths. The 
253      * default value is 100%, meaning one column.</p> 
254      * @since 1.0
255      * @javascript Re-compilers must resolve the member of this static field to the
256      * identifier of the field name.
257      */
258     public static final Value.String.Member cols = new Value.String.Member(Members.cols);
259     /**
260      * <p>An <b>opaque</b> static field defining a member that is named by the field name
261      * without a qualifying member and to access the property of the name on an object.</p>
262      * <p>The property, identified by this member, of a {@link JsHTMLFrameSetElement} 
263      * object refers to a string specifying the layout of horizontal frames with a 
264      * comma-separated list of pixels, percentages, and relative lengths. The 
265      * default value is 100%, meaning one row.</p> 
266      * @since 1.0
267      * @javascript Re-compilers must resolve the member of this static field to the
268      * identifier of the field name.
269      */
270     public static final Value.String.Member rows = new Value.String.Member(Members.rows);
271     /**
272      * <p>An <b>opaque</b> static field defining a member that is named by the field name
273      * without a qualifying member and to access the property of the name on an object.</p>
274      * <p>The property, identified by this member, of a {@link JsHTMLFrameSetElement} object is a 
275      * reference to an event handler function invoked when the web browser finishes 
276      * loading all frames within the frame-set.</p> 
277      * @since 1.0
278      * @see JsElement#addEventListener(String, JsFunction, Boolean)
279      * @see JsElement#attachEvent(String, JsFunction)
280      * @javascript Re-compilers must resolve the member of this static field to the
281      * identifier of the field name.
282      */
283     public static final JsFunction.Member<?> onload = new JsFunction.Member<Object>(Members.onload);
284     /**
285      * <p>An <b>opaque</b> static field defining a member that is named by the field name
286      * without a qualifying member and to access the property of the name on an object.</p>
287      * <p>The property, identified by this member, of a {@link JsHTMLFrameSetElement} object is a 
288      * reference to an event handler function invoked when the web browser removes 
289      * a document from the frame-set.</p> 
290      * @since 1.0
291      * @see JsElement#addEventListener(String, JsFunction, Boolean)
292      * @see JsElement#attachEvent(String, JsFunction)
293      * @javascript Re-compilers must resolve the member of this static field to the
294      * identifier of the field name.
295      */
296     public static final JsFunction.Member<?> onunload = new JsFunction.Member<Object>(Members.onunload);
297 
298     @Override
299     /**
300      * <p>Returns the primitive value associated with the current instance, if there is one.
301      * This invocation simply returns the instance itself for the current instance is an 
302      * object and there is no primitive value for it.</p>
303      * @return The current object itself.
304      * @since 1.0
305      * @javascript Re-compilers must convert the instance invocation of this method directly
306      * into a JavaScript invocation on its current object instance without changing the 
307      * method name, but expanding variable arguments, if any, into comma-separated values. 
308      */
309     public final JsHTMLFrameSetElement valueOf() {
310         return new JsHTMLFrameSetElement((JsObject)var().valueOf());
311     }
312 }