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.AbstractUISection;
26  import org.apache.myfaces.tobago.model.CollapseMode;
27  import org.apache.myfaces.tobago.renderkit.css.CustomClass;
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 org.apache.myfaces.tobago.component.Tags;
32  import javax.annotation.Generated;
33  import javax.el.ELException;
34  import javax.faces.FacesException;
35  import java.util.Arrays;
36  import java.util.ArrayList;
37  import java.util.Collection;
38  import java.util.List;
39  import javax.el.MethodExpression;
40  import javax.el.ValueExpression;
41  
42  /**
43   Renders a section or subsection.
44    * UIComponent class, generated from template {@code component.stg} with class
45    * {@link org.apache.myfaces.tobago.internal.taglib.component.SectionTagDeclaration}.
46   */
47  @Generated("component.stg")
48  public class UISection
49      extends AbstractUISection implements ClientBehaviorHolder {
50  
51    public static final String COMPONENT_TYPE = Tags.section.componentType();
52  
53    public static final String COMPONENT_FAMILY = "org.apache.myfaces.tobago.Section";
54  
55  
56    enum PropertyKeys {
57      image,
58      markup,
59      level,
60      collapsed,
61      customClass,
62      tip,
63      label,
64      collapsedMode,
65    }
66  
67    public String getFamily() {
68      return COMPONENT_FAMILY;
69    }
70  
71  
72    /**
73    Url to an image to display.
74  
75    */
76    public java.lang.String getImage() {
77      return (java.lang.String) getStateHelper().eval(PropertyKeys.image);
78    }
79  
80    public void setImage(java.lang.String image) {
81      getStateHelper().put(PropertyKeys.image, image);
82    }
83  
84    public org.apache.myfaces.tobago.context.Markup getMarkup() {
85      Object object = getStateHelper().eval(PropertyKeys.markup);
86      if (object != null) {
87        return Markup.valueOf(object);
88      }
89      return null;
90    }
91  
92    public void setMarkup(org.apache.myfaces.tobago.context.Markup markup) {
93      getStateHelper().put(PropertyKeys.markup, markup);
94    }
95  
96    /**
97    Level of the title. Lower value means bigger title, greater value means smaller title.
98     Value goes from 1 to 6.
99  
100   */
101   public java.lang.Integer getLevel() {
102     Number value  = (Number) getStateHelper().eval(PropertyKeys.level);
103     if (value != null) {
104       return value.intValue();
105     }
106     return null;
107   }
108 
109   public void setLevel(java.lang.Integer level) {
110     getStateHelper().put(PropertyKeys.level, level);
111   }
112 
113   /**
114   Indicating the collapsed state of this component.
115   <br>Default: <code>false</code>
116   */
117   public boolean isCollapsed() {
118     Boolean bool = (Boolean) getStateHelper().eval(PropertyKeys.collapsed);
119     if (bool != null) {
120       return bool;
121     }
122     return false;
123   }
124 
125   public void setCollapsed(boolean collapsed) {
126     getStateHelper().put(PropertyKeys.collapsed, collapsed);
127   }
128 
129   /**
130   Sets a CSS class in its parent, if the parent supports it.
131 
132    Which this feature it is possible to put a CSS class name into a component with the &lt;tc:style&gt; tag. Example:
133 
134    <pre>
135    &lt;tc:in&gt;
136      &lt;tc:style customClass="my-emphasized"/&gt;
137    &lt;/tc:in&gt;
138    </pre>
139 
140    One capability is, to used external CSS libs.
141    <br>
142    This feature should not be used imprudent.
143    Because it might be unstable against changes in the renderered HTML code.
144 
145   */
146   public org.apache.myfaces.tobago.renderkit.css.CustomClass getCustomClass() {
147     return (org.apache.myfaces.tobago.renderkit.css.CustomClass) getStateHelper().eval(PropertyKeys.customClass);
148   }
149 
150   public void setCustomClass(org.apache.myfaces.tobago.renderkit.css.CustomClass customClass) {
151     getStateHelper().put(PropertyKeys.customClass, customClass);
152   }
153 
154   /**
155   Text value to display as tooltip.
156 
157   */
158   public java.lang.String getTip() {
159     return (java.lang.String) getStateHelper().eval(PropertyKeys.tip);
160   }
161 
162   public void setTip(java.lang.String tip) {
163     getStateHelper().put(PropertyKeys.tip, tip);
164   }
165 
166   /**
167   A localized user presentable label for this component.
168 
169   */
170   public java.lang.String getLabel() {
171     return (java.lang.String) getStateHelper().eval(PropertyKeys.label);
172   }
173 
174   public void setLabel(java.lang.String label) {
175     getStateHelper().put(PropertyKeys.label, label);
176   }
177 
178   /**
179   Enum indicating the mode of the collapsed state of this component.
180   <br>Default: <code>none</code>
181   */
182   public org.apache.myfaces.tobago.model.CollapseMode getCollapsedMode() {
183     org.apache.myfaces.tobago.model.CollapseMode collapsedMode = (org.apache.myfaces.tobago.model.CollapseMode) getStateHelper().eval(PropertyKeys.collapsedMode);
184     if (collapsedMode != null) {
185       return collapsedMode;
186     }
187     return org.apache.myfaces.tobago.model.CollapseMode.none;
188   }
189 
190   public void setCollapsedMode(org.apache.myfaces.tobago.model.CollapseMode collapsedMode) {
191     getStateHelper().put(PropertyKeys.collapsedMode, collapsedMode);
192   }
193 
194 
195   @Override
196   public void restoreState(FacesContext context, Object state) {
197     // FIXME HACK for mojarra SystemEventListener state restoring bug
198     pushComponentToEL(context, this);
199     super.restoreState(context, state);
200     popComponentFromEL(context);
201   }
202 
203 }