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.AbstractUIBox;
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 panel with border and title.
44    * UIComponent class, generated from template {@code component.stg} with class
45    * {@link org.apache.myfaces.tobago.internal.taglib.component.BoxTagDeclaration}.
46   */
47  @Generated("component.stg")
48  public class UIBox
49      extends AbstractUIBox implements ClientBehaviorHolder {
50  
51    public static final String COMPONENT_TYPE = Tags.box.componentType();
52  
53    public static final String COMPONENT_FAMILY = "javax.faces.Panel";
54  
55  
56    enum PropertyKeys {
57      markup,
58      collapsed,
59      customClass,
60      tip,
61      label,
62      collapsedMode,
63    }
64  
65    public String getFamily() {
66      return COMPONENT_FAMILY;
67    }
68  
69  
70    public org.apache.myfaces.tobago.context.Markup getMarkup() {
71      Object object = getStateHelper().eval(PropertyKeys.markup);
72      if (object != null) {
73        return Markup.valueOf(object);
74      }
75      return null;
76    }
77  
78    public void setMarkup(org.apache.myfaces.tobago.context.Markup markup) {
79      getStateHelper().put(PropertyKeys.markup, markup);
80    }
81  
82    /**
83    Indicating the collapsed state of this component.
84    <br>Default: <code>false</code>
85    */
86    public boolean isCollapsed() {
87      Boolean bool = (Boolean) getStateHelper().eval(PropertyKeys.collapsed);
88      if (bool != null) {
89        return bool;
90      }
91      return false;
92    }
93  
94    public void setCollapsed(boolean collapsed) {
95      getStateHelper().put(PropertyKeys.collapsed, collapsed);
96    }
97  
98    /**
99    Sets a CSS class in its parent, if the parent supports it.
100 
101    Which this feature it is possible to put a CSS class name into a component with the &lt;tc:style&gt; tag. Example:
102 
103    <pre>
104    &lt;tc:in&gt;
105      &lt;tc:style customClass="my-emphasized"/&gt;
106    &lt;/tc:in&gt;
107    </pre>
108 
109    One capability is, to used external CSS libs.
110    <br>
111    This feature should not be used imprudent.
112    Because it might be unstable against changes in the renderered HTML code.
113 
114   */
115   public org.apache.myfaces.tobago.renderkit.css.CustomClass getCustomClass() {
116     return (org.apache.myfaces.tobago.renderkit.css.CustomClass) getStateHelper().eval(PropertyKeys.customClass);
117   }
118 
119   public void setCustomClass(org.apache.myfaces.tobago.renderkit.css.CustomClass customClass) {
120     getStateHelper().put(PropertyKeys.customClass, customClass);
121   }
122 
123   /**
124   Text value to display as tooltip.
125 
126   */
127   public java.lang.String getTip() {
128     return (java.lang.String) getStateHelper().eval(PropertyKeys.tip);
129   }
130 
131   public void setTip(java.lang.String tip) {
132     getStateHelper().put(PropertyKeys.tip, tip);
133   }
134 
135   /**
136   A localized user presentable label for this component.
137 
138   */
139   public java.lang.String getLabel() {
140     return (java.lang.String) getStateHelper().eval(PropertyKeys.label);
141   }
142 
143   public void setLabel(java.lang.String label) {
144     getStateHelper().put(PropertyKeys.label, label);
145   }
146 
147   /**
148   Enum indicating the mode of the collapsed state of this component.
149   <br>Default: <code>none</code>
150   */
151   public org.apache.myfaces.tobago.model.CollapseMode getCollapsedMode() {
152     org.apache.myfaces.tobago.model.CollapseMode collapsedMode = (org.apache.myfaces.tobago.model.CollapseMode) getStateHelper().eval(PropertyKeys.collapsedMode);
153     if (collapsedMode != null) {
154       return collapsedMode;
155     }
156     return org.apache.myfaces.tobago.model.CollapseMode.none;
157   }
158 
159   public void setCollapsedMode(org.apache.myfaces.tobago.model.CollapseMode collapsedMode) {
160     getStateHelper().put(PropertyKeys.collapsedMode, collapsedMode);
161   }
162 
163 
164   @Override
165   public void restoreState(FacesContext context, Object state) {
166     // FIXME HACK for mojarra SystemEventListener state restoring bug
167     pushComponentToEL(context, this);
168     super.restoreState(context, state);
169     popComponentFromEL(context);
170   }
171 
172 }