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.ArrayList;
33  import java.util.List;
34  import javax.el.MethodExpression;
35  import javax.el.ValueExpression;
36  
37  /** 
38   Renders a label component.
39    * UIComponent class, generated from template {@code component.stg} with class
40    * {@link org.apache.myfaces.tobago.internal.taglib.component.LabelTagDeclaration}.
41   */
42  public class UILabel
43      extends AbstractUILabel implements SupportsAccessKey, Visual {
44  
45    public static final String COMPONENT_TYPE = "org.apache.myfaces.tobago.Label";
46  
47    public static final String COMPONENT_FAMILY = "javax.faces.Output";
48  
49  
50    enum PropertyKeys {
51      markup,
52      accessKey,
53      forComponent,
54      customClass,
55      tip,
56      style,
57    }
58  
59    public String getFamily() {
60      return COMPONENT_FAMILY;
61    }
62  
63  
64    public org.apache.myfaces.tobago.context.Markup getMarkup() {
65      Object object = getStateHelper().eval(PropertyKeys.markup);
66      if (object != null) {
67        return Markup.valueOf(object);
68      }
69      return null;
70    }
71  
72    public void setMarkup(org.apache.myfaces.tobago.context.Markup markup) {
73      getStateHelper().put(PropertyKeys.markup, markup);
74    }
75  
76    /**
77    The access key of this control.
78  
79    */
80    public java.lang.Character getAccessKey() {
81      return (java.lang.Character) getStateHelper().eval(PropertyKeys.accessKey);
82    }
83  
84    public void setAccessKey(java.lang.Character accessKey) {
85      getStateHelper().put(PropertyKeys.accessKey, accessKey);
86    }
87  
88    /**
89    Id of the component, this is related to.
90  
91    */
92    public java.lang.String getFor() {
93      return (java.lang.String) getStateHelper().eval(PropertyKeys.forComponent);
94    }
95  
96    public void setFor(java.lang.String forComponent) {
97      getStateHelper().put(PropertyKeys.forComponent, forComponent);
98    }
99  
100   /**
101   Sets a CSS class in its parent, if the parent supports it.
102 
103    Which this feature it is possible to put a CSS class name into a component with the <tc:style> tag. Example:
104 
105    <pre>
106    &lt;tc:in&gt;
107      &lt;tc:style customClass="my-emphasized"/&gt;
108    &lt;/tc:in&gt;
109    </pre>
110 
111    One capability is, to used external CSS libs.
112    <br>
113    This feature should not be used imprudent.
114    Because it might be unstable against changes in the renderered HTML code.
115 
116   */
117   public org.apache.myfaces.tobago.renderkit.css.CustomClass getCustomClass() {
118     return (org.apache.myfaces.tobago.renderkit.css.CustomClass) getStateHelper().eval(PropertyKeys.customClass);
119   }
120 
121   public void setCustomClass(org.apache.myfaces.tobago.renderkit.css.CustomClass customClass) {
122     getStateHelper().put(PropertyKeys.customClass, customClass);
123   }
124 
125   /**
126   Text value to display as tooltip.
127 
128   */
129   public java.lang.String getTip() {
130     return (java.lang.String) getStateHelper().eval(PropertyKeys.tip);
131   }
132 
133   public void setTip(java.lang.String tip) {
134     getStateHelper().put(PropertyKeys.tip, tip);
135   }
136 
137   /**
138   For internal use. Used for rendering, if there is a child tag &lt;tc:style&gt;
139 
140   */
141   public org.apache.myfaces.tobago.renderkit.css.Style getStyle() {
142     return (org.apache.myfaces.tobago.renderkit.css.Style) getStateHelper().eval(PropertyKeys.style);
143   }
144 
145   public void setStyle(org.apache.myfaces.tobago.renderkit.css.Style style) {
146     getStateHelper().put(PropertyKeys.style, style);
147   }
148 
149 
150 }