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