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.JSFProperty;
25  
26  /**
27   * Renders an HTML img element.
28   * <p>
29   * The value attribute specifies the url of the image to be displayed;
30   * see the documentation for attribute "url" for more details.
31   * </p>
32   */
33  @JSFComponent
34  (name = "h:graphicImage",
35  clazz = "javax.faces.component.html.HtmlGraphicImage",template=true,
36  tagClass = "org.apache.myfaces.taglib.html.HtmlGraphicImageTag",
37  defaultRendererType = "javax.faces.Image"
38  )
39  abstract class _HtmlGraphicImage extends UIGraphic 
40      implements _EventProperties,
41      _StyleProperties, _UniversalProperties, _AltProperty
42  {
43  
44    static public final String COMPONENT_FAMILY =
45      "javax.faces.Graphic";
46    static public final String COMPONENT_TYPE =
47      "javax.faces.HtmlGraphicImage";
48  
49    /**
50     * HTML: Overrides the natural height of this image, by specifying height in pixels.
51     * 
52     */
53    @JSFProperty
54    public abstract String getHeight();
55  
56    /**
57     * HTML: Specifies server-side image map handling for this image.
58     * 
59     */
60    @JSFProperty(defaultValue="false")
61    public abstract boolean isIsmap();
62    
63    /**
64     * HTML: A link to a long description of the image.
65     * 
66     */
67    @JSFProperty
68    public abstract String getLongdesc();
69    
70    /**
71     * HTML: Specifies an image map to use with this image.
72     * 
73     */
74    @JSFProperty
75    public abstract String getUsemap();
76    
77    /**
78     * HTML: Overrides the natural width of this image, by specifying width in pixels.
79     * 
80     */
81    @JSFProperty
82    public abstract String getWidth();
83  
84  }