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