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.AbstractUIFooter;
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   Defines a footer of its parent (like page, box, ...)
43    * UIComponent class, generated from template {@code component.stg} with class
44    * {@link org.apache.myfaces.tobago.internal.taglib.component.FooterTagDeclaration}.
45   */
46  @Generated("component.stg")
47  public class UIFooter
48      extends AbstractUIFooter implements ClientBehaviorHolder {
49  
50    public static final String COMPONENT_TYPE = Tags.footer.componentType();
51  
52    public static final String COMPONENT_FAMILY = "javax.faces.Panel";
53  
54  
55    enum PropertyKeys {
56      markup,
57      customClass,
58      tip,
59      fixed,
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    Sets a CSS class in its parent, if the parent supports it.
81  
82     Which this feature it is possible to put a CSS class name into a component with the <tc:style> tag. Example:
83  
84     <pre>
85     &lt;tc:in&gt;
86       &lt;tc:style customClass="my-emphasized"/&gt;
87     &lt;/tc:in&gt;
88     </pre>
89  
90     One capability is, to used external CSS libs.
91     <br>
92     This feature should not be used imprudent.
93     Because it might be unstable against changes in the renderered HTML code.
94  
95    */
96    public org.apache.myfaces.tobago.renderkit.css.CustomClass getCustomClass() {
97      return (org.apache.myfaces.tobago.renderkit.css.CustomClass) getStateHelper().eval(PropertyKeys.customClass);
98    }
99  
100   public void setCustomClass(org.apache.myfaces.tobago.renderkit.css.CustomClass customClass) {
101     getStateHelper().put(PropertyKeys.customClass, customClass);
102   }
103 
104   /**
105   Text value to display as tooltip.
106 
107   */
108   public java.lang.String getTip() {
109     return (java.lang.String) getStateHelper().eval(PropertyKeys.tip);
110   }
111 
112   public void setTip(java.lang.String tip) {
113     getStateHelper().put(PropertyKeys.tip, tip);
114   }
115 
116   /**
117   Flag indicating that this element is fixed on its position, e. g. it will not scroll with the
118    neighbour elements.
119   <br>Default: <code>false</code>
120   */
121   public boolean isFixed() {
122     Boolean bool = (Boolean) getStateHelper().eval(PropertyKeys.fixed);
123     if (bool != null) {
124       return bool;
125     }
126     return false;
127   }
128 
129   public void setFixed(boolean fixed) {
130     getStateHelper().put(PropertyKeys.fixed, fixed);
131   }
132 
133 
134   @Override
135   public void restoreState(FacesContext context, Object state) {
136     // FIXME HACK for mojarra SystemEventListener state restoring bug
137     pushComponentToEL(context, this);
138     super.restoreState(context, state);
139     popComponentFromEL(context);
140   }
141 
142 }