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  
20  package org.apache.myfaces.tobago.internal.taglib.component;
21  
22  import org.apache.myfaces.tobago.apt.annotation.BodyContent;
23  import org.apache.myfaces.tobago.apt.annotation.Tag;
24  import org.apache.myfaces.tobago.apt.annotation.TagAttribute;
25  import org.apache.myfaces.tobago.apt.annotation.UIComponentTag;
26  import org.apache.myfaces.tobago.apt.annotation.UIComponentTagAttribute;
27  import org.apache.myfaces.tobago.component.RendererTypes;
28  import org.apache.myfaces.tobago.internal.taglib.declaration.HasBorder;
29  import org.apache.myfaces.tobago.internal.taglib.declaration.HasCurrentMarkup;
30  import org.apache.myfaces.tobago.internal.taglib.declaration.HasIdBindingAndRendered;
31  import org.apache.myfaces.tobago.internal.taglib.declaration.HasMarkup;
32  import org.apache.myfaces.tobago.internal.taglib.declaration.HasTip;
33  import org.apache.myfaces.tobago.internal.taglib.declaration.IsDisabled;
34  import org.apache.myfaces.tobago.internal.taglib.declaration.IsGridLayoutComponentWithDimension;
35  import org.apache.myfaces.tobago.internal.taglib.declaration.IsGridLayoutContainer;
36  
37  import javax.faces.component.UIGraphic;
38  
39  /**
40   * Renders an image.
41   */
42  @Tag(name = "image", bodyContent = BodyContent.JSP)
43  @UIComponentTag(
44      uiComponent = "org.apache.myfaces.tobago.component.UIImage",
45      uiComponentBaseClass = "org.apache.myfaces.tobago.internal.component.AbstractUIImage",
46      uiComponentFacesClass = "javax.faces.component.UIGraphic",
47      componentFamily = UIGraphic.COMPONENT_FAMILY,
48      rendererType = RendererTypes.IMAGE,
49      allowedChildComponenents = "NONE")
50  public interface ImageTagDeclaration
51      extends HasIdBindingAndRendered, HasBorder, HasTip, IsDisabled, HasMarkup, HasCurrentMarkup,
52      IsGridLayoutComponentWithDimension, IsGridLayoutContainer {
53  
54    /**
55     * Absolute url to an image or image name to lookup in tobago resource path.
56     * In the second case, there is no need to set the extension (like .gif or .png).
57     * If you leave it out, you can use different extension in different themes.
58     */
59    @TagAttribute(required = true)
60    @UIComponentTagAttribute()
61    void setValue(String value);
62  
63    /**
64     * Alternate textual description of the image rendered by this component.
65     */
66    @TagAttribute
67    @UIComponentTagAttribute()
68    void setAlt(String alt);
69  
70  }