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