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.BodyContentDescription;
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.HasConverter;
29  import org.apache.myfaces.tobago.internal.taglib.declaration.HasIdBindingAndRendered;
30  import org.apache.myfaces.tobago.internal.taglib.declaration.HasLabel;
31  import org.apache.myfaces.tobago.internal.taglib.declaration.HasLabelLayout;
32  import org.apache.myfaces.tobago.internal.taglib.declaration.HasSanitize;
33  import org.apache.myfaces.tobago.internal.taglib.declaration.HasTip;
34  import org.apache.myfaces.tobago.internal.taglib.declaration.HasValue;
35  import org.apache.myfaces.tobago.internal.taglib.declaration.IsVisual;
36  
37  import javax.faces.component.UIOutput;
38  
39  /**
40   * Renders a text
41   */
42  @Tag(name = "out")
43  @BodyContentDescription(anyTagOf = "f:converter|f:convertNumber|f:convertDateTime|...")
44  @UIComponentTag(
45      uiComponent = "org.apache.myfaces.tobago.component.UIOut",
46      uiComponentBaseClass = "org.apache.myfaces.tobago.internal.component.AbstractUIOut",
47      uiComponentFacesClass = "javax.faces.component.UIOutput",
48      componentFamily = UIOutput.COMPONENT_FAMILY,
49      rendererType = RendererTypes.OUT,
50      interfaces = {
51          // As long as no behavior event names are defined, ClientBehaviorHolder must be implemented for Majorra.
52          "javax.faces.component.behavior.ClientBehaviorHolder"
53      },
54      allowedChildComponenents = "NONE")
55  
56  public interface OutTagDeclaration
57      extends HasIdBindingAndRendered, HasConverter, HasTip, HasValue, IsVisual,
58      HasSanitize, HasLabel, HasLabelLayout {
59  
60    /**
61     * Flag indicating that characters that are
62     * sensitive in HTML and XML markup must be escaped.
63     */
64    @TagAttribute
65    @UIComponentTagAttribute(type = "boolean", defaultValue = "true")
66    void setEscape(String escape);
67  
68    /**
69     * Indicates that the renderer should create an element in the output language
70     * (e. g. an span or div tag around the output text).
71     * Use true, if you enable the possibility to apply styles to the output.
72     * Use false, if you want to keep the code small (especially inside of sheets).
73     */
74    @UIComponentTagAttribute(type = "boolean", defaultValue = "true")
75    void setCreateSpan(String createSpan);
76  
77    /**
78     * Use true, if you enable the possibility to apply styles to the output.
79     * Use false, if you want to keep the code small (especially inside of sheets).
80     */
81    @TagAttribute
82    @UIComponentTagAttribute(type = "boolean", defaultValue = "false")
83    void setCompact(String compact);
84  }