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.context.FacesContext;
23  import org.apache.myfaces.tobago.context.Markup;
24  import org.apache.myfaces.tobago.internal.component.AbstractUIPanel;
25  import org.apache.myfaces.tobago.model.CollapseMode;
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.ArrayList;
34  import java.util.List;
35  import javax.el.MethodExpression;
36  import javax.el.ValueExpression;
37  
38  /** 
39   Intended for use in situations when only one UIComponent child can be
40    nested, such as in the case of facets.
41    * UIComponent class, generated from template {@code component.stg} with class
42    * {@link org.apache.myfaces.tobago.internal.taglib.component.PanelTagDeclaration}.
43   */
44  public class UIPanel
45      extends AbstractUIPanel implements Visual {
46  
47    public static final String COMPONENT_TYPE = "org.apache.myfaces.tobago.Panel";
48  
49    public static final String COMPONENT_FAMILY = "javax.faces.Panel";
50  
51  
52    enum PropertyKeys {
53      markup,
54      collapsed,
55      customClass,
56      style,
57      tip,
58      collapsedMode,
59    }
60  
61    public String getFamily() {
62      return COMPONENT_FAMILY;
63    }
64  
65  
66    public org.apache.myfaces.tobago.context.Markup getMarkup() {
67      Object object = getStateHelper().eval(PropertyKeys.markup);
68      if (object != null) {
69        return Markup.valueOf(object);
70      }
71      return null;
72    }
73  
74    public void setMarkup(org.apache.myfaces.tobago.context.Markup markup) {
75      getStateHelper().put(PropertyKeys.markup, markup);
76    }
77  
78    /**
79    Indicating the collapsed state of this component.
80    <br>Default: <code>false</code>
81    */
82    public boolean isCollapsed() {
83      Boolean bool = (Boolean) getStateHelper().eval(PropertyKeys.collapsed);
84      if (bool != null) {
85        return bool;
86      }
87      return false;
88    }
89  
90    public void setCollapsed(boolean collapsed) {
91      getStateHelper().put(PropertyKeys.collapsed, collapsed);
92    }
93  
94    /**
95    Sets a CSS class in its parent, if the parent supports it.
96  
97     Which this feature it is possible to put a CSS class name into a component with the &lt;tc:style&gt; tag. Example:
98  
99     <pre>
100    &lt;tc:in&gt;
101      &lt;tc:style customClass="my-emphasized"/&gt;
102    &lt;/tc:in&gt;
103    </pre>
104 
105    One capability is, to used external CSS libs.
106    <br>
107    This feature should not be used imprudent.
108    Because it might be unstable against changes in the renderered HTML code.
109 
110   */
111   public org.apache.myfaces.tobago.renderkit.css.CustomClass getCustomClass() {
112     return (org.apache.myfaces.tobago.renderkit.css.CustomClass) getStateHelper().eval(PropertyKeys.customClass);
113   }
114 
115   public void setCustomClass(org.apache.myfaces.tobago.renderkit.css.CustomClass customClass) {
116     getStateHelper().put(PropertyKeys.customClass, customClass);
117   }
118 
119   /**
120   For internal use. Used for rendering, if there is a child tag &lt;tc:style&gt;
121 
122   */
123   public org.apache.myfaces.tobago.renderkit.css.Style getStyle() {
124     return (org.apache.myfaces.tobago.renderkit.css.Style) getStateHelper().eval(PropertyKeys.style);
125   }
126 
127   public void setStyle(org.apache.myfaces.tobago.renderkit.css.Style style) {
128     getStateHelper().put(PropertyKeys.style, style);
129   }
130 
131   /**
132   Text value to display as tooltip.
133 
134   */
135   public java.lang.String getTip() {
136     return (java.lang.String) getStateHelper().eval(PropertyKeys.tip);
137   }
138 
139   public void setTip(java.lang.String tip) {
140     getStateHelper().put(PropertyKeys.tip, tip);
141   }
142 
143   /**
144   Enum indicating the mode of the collapsed state of this component.
145   <br>Default: <code>absent</code>
146   */
147   public org.apache.myfaces.tobago.model.CollapseMode getCollapsedMode() {
148     org.apache.myfaces.tobago.model.CollapseMode collapsedMode = (org.apache.myfaces.tobago.model.CollapseMode) getStateHelper().eval(PropertyKeys.collapsedMode);
149     if (collapsedMode != null) {
150       return collapsedMode;
151     }
152     return org.apache.myfaces.tobago.model.CollapseMode.absent;
153   }
154 
155   public void setCollapsedMode(org.apache.myfaces.tobago.model.CollapseMode collapsedMode) {
156     getStateHelper().put(PropertyKeys.collapsedMode, collapsedMode);
157   }
158 
159 
160 }