View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package javax.faces.component.html;
20  
21  import javax.faces.component.UIGraphic;
22  
23  import org.apache.myfaces.buildtools.maven2.plugin.builder.annotation.JSFComponent;
24  import org.apache.myfaces.buildtools.maven2.plugin.builder.annotation.JSFExclude;
25  import org.apache.myfaces.buildtools.maven2.plugin.builder.annotation.JSFProperty;
26  
27  /**
28   * Renders an HTML img element.
29   * <p>
30   * The value attribute specifies the url of the image to be displayed;
31   * see the documentation for attribute "url" for more details.
32   * </p>
33   */
34  @JSFComponent
35  (name = "h:graphicImage",
36  clazz = "javax.faces.component.html.HtmlGraphicImage",template=true,
37  tagClass = "org.apache.myfaces.taglib.html.HtmlGraphicImageTag",
38  defaultRendererType = "javax.faces.Image",
39  implementz = "javax.faces.component.behavior.ClientBehaviorHolder"
40  )
41  abstract class _HtmlGraphicImage extends UIGraphic 
42      implements _EventProperties,
43      _StyleProperties, _UniversalProperties, _AltProperty, _RoleProperty
44  {
45  
46    static public final String COMPONENT_FAMILY =
47      "javax.faces.Graphic";
48    static public final String COMPONENT_TYPE =
49      "javax.faces.HtmlGraphicImage";
50  
51    /**
52     * HTML: Overrides the natural height of this image, by specifying height in pixels.
53     * 
54     */
55    @JSFProperty
56    public abstract String getHeight();
57  
58    /**
59     * HTML: Specifies server-side image map handling for this image.
60     * 
61     */
62    @JSFProperty(defaultValue="false")
63    public abstract boolean isIsmap();
64    
65    /**
66     * HTML: A link to a long description of the image.
67     * 
68     */
69    @JSFProperty
70    public abstract String getLongdesc();
71    
72    /**
73     * HTML: Specifies an image map to use with this image.
74     * 
75     */
76    @JSFProperty
77    public abstract String getUsemap();
78    
79    /**
80     * HTML: Overrides the natural width of this image, by specifying width in pixels.
81     * 
82     */
83    @JSFProperty
84    public abstract String getWidth();
85  
86    /**
87     * 
88     * @return
89     */
90    @JSFProperty
91    @JSFExclude
92    public String getLibrary()
93    {
94        return null;
95    }
96    
97    /**
98     * 
99     * @return
100    */
101   @JSFProperty
102   @JSFExclude
103   public String getName()
104   {
105       return null;
106   }
107 }