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