View Javadoc
1   // ---------- Attention: Generated code, please do not modify! -----------  
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one or more
5    * contributor license agreements.  See the NOTICE file distributed with
6    * this work for additional information regarding copyright ownership.
7    * The ASF licenses this file to You under the Apache License, Version 2.0
8    * (the "License"); you may not use this file except in compliance with
9    * the License.  You may obtain a copy of the License at
10   *
11   *      http://www.apache.org/licenses/LICENSE-2.0
12   *
13   * Unless required by applicable law or agreed to in writing, software
14   * distributed under the License is distributed on an "AS IS" BASIS,
15   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16   * See the License for the specific language governing permissions and
17   * limitations under the License.
18   */
19  
20  package org.apache.myfaces.tobago.component;
21  
22  import javax.faces.context.FacesContext;
23  import org.apache.myfaces.tobago.context.Markup;
24  import org.apache.myfaces.tobago.internal.component.AbstractUILabel;
25  import org.apache.myfaces.tobago.renderkit.css.CustomClass;
26  import org.apache.myfaces.tobago.renderkit.css.Style;
27  import org.apache.myfaces.tobago.internal.util.ArrayUtils;
28  import org.apache.myfaces.tobago.internal.util.StringUtils;
29  import org.apache.myfaces.tobago.internal.util.Deprecation;
30  import javax.el.ELException;
31  import javax.faces.FacesException;
32  import java.util.Arrays;
33  import java.util.ArrayList;
34  import java.util.Collection;
35  import java.util.List;
36  import javax.el.MethodExpression;
37  import javax.el.ValueExpression;
38  
39  /** 
40   Renders a label component.
41    * UIComponent class, generated from template {@code component.stg} with class
42    * {@link org.apache.myfaces.tobago.internal.taglib.component.LabelTagDeclaration}.
43   */
44  public class UILabel
45      extends AbstractUILabel implements SupportsAccessKey, Visual {
46  
47    public static final String COMPONENT_TYPE = "org.apache.myfaces.tobago.Label";
48  
49    public static final String COMPONENT_FAMILY = "javax.faces.Output";
50  
51  
52    enum PropertyKeys {
53      markup,
54      accessKey,
55      forComponent,
56      customClass,
57      tip,
58      style,
59    }
60  
61    public String getFamily() {
62      return COMPONENT_FAMILY;
63    }
64  
65  
66    public org.apache.myfaces.tobago.context.Markup getMarkup() {
67      Object object = getStateHelper().eval(PropertyKeys.markup);
68      if (object != null) {
69        return Markup.valueOf(object);
70      }
71      return null;
72    }
73  
74    public void setMarkup(org.apache.myfaces.tobago.context.Markup markup) {
75      getStateHelper().put(PropertyKeys.markup, markup);
76    }
77  
78    /**
79    The access key of this control.
80  
81    */
82    public java.lang.Character getAccessKey() {
83      return (java.lang.Character) getStateHelper().eval(PropertyKeys.accessKey);
84    }
85  
86    public void setAccessKey(java.lang.Character accessKey) {
87      getStateHelper().put(PropertyKeys.accessKey, accessKey);
88    }
89  
90    /**
91    Id of the component, this is related to.
92  
93    */
94    public java.lang.String getFor() {
95      return (java.lang.String) getStateHelper().eval(PropertyKeys.forComponent);
96    }
97  
98    public void setFor(java.lang.String forComponent) {
99      getStateHelper().put(PropertyKeys.forComponent, forComponent);
100   }
101 
102   /**
103   Sets a CSS class in its parent, if the parent supports it.
104 
105    Which this feature it is possible to put a CSS class name into a component with the <tc:style> tag. Example:
106 
107    <pre>
108    &lt;tc:in&gt;
109      &lt;tc:style customClass="my-emphasized"/&gt;
110    &lt;/tc:in&gt;
111    </pre>
112 
113    One capability is, to used external CSS libs.
114    <br>
115    This feature should not be used imprudent.
116    Because it might be unstable against changes in the renderered HTML code.
117 
118   */
119   public org.apache.myfaces.tobago.renderkit.css.CustomClass getCustomClass() {
120     return (org.apache.myfaces.tobago.renderkit.css.CustomClass) getStateHelper().eval(PropertyKeys.customClass);
121   }
122 
123   public void setCustomClass(org.apache.myfaces.tobago.renderkit.css.CustomClass customClass) {
124     getStateHelper().put(PropertyKeys.customClass, customClass);
125   }
126 
127   /**
128   Text value to display as tooltip.
129 
130   */
131   public java.lang.String getTip() {
132     return (java.lang.String) getStateHelper().eval(PropertyKeys.tip);
133   }
134 
135   public void setTip(java.lang.String tip) {
136     getStateHelper().put(PropertyKeys.tip, tip);
137   }
138 
139   /**
140   For internal use. Used for rendering, if there is a child tag &lt;tc:style&gt;
141 
142   */
143   public org.apache.myfaces.tobago.renderkit.css.Style getStyle() {
144     return (org.apache.myfaces.tobago.renderkit.css.Style) getStateHelper().eval(PropertyKeys.style);
145   }
146 
147   public void setStyle(org.apache.myfaces.tobago.renderkit.css.Style style) {
148     getStateHelper().put(PropertyKeys.style, style);
149   }
150 
151 
152 }