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.AbstractUIBox;
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.Arrays;
34  import java.util.ArrayList;
35  import java.util.Collection;
36  import java.util.List;
37  import javax.el.MethodExpression;
38  import javax.el.ValueExpression;
39  
40  /** 
41   Renders a panel with border and title.
42    * UIComponent class, generated from template {@code component.stg} with class
43    * {@link org.apache.myfaces.tobago.internal.taglib.component.BoxTagDeclaration}.
44   */
45  public class UIBox
46      extends AbstractUIBox implements Visual {
47  
48    public static final String COMPONENT_TYPE = "org.apache.myfaces.tobago.Box";
49  
50    public static final String COMPONENT_FAMILY = "javax.faces.Panel";
51  
52  
53    enum PropertyKeys {
54      markup,
55      collapsed,
56      customClass,
57      style,
58      tip,
59      label,
60      collapsedMode,
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    Indicating the collapsed state of this component.
82    <br>Default: <code>false</code>
83    */
84    public boolean isCollapsed() {
85      Boolean bool = (Boolean) getStateHelper().eval(PropertyKeys.collapsed);
86      if (bool != null) {
87        return bool;
88      }
89      return false;
90    }
91  
92    public void setCollapsed(boolean collapsed) {
93      getStateHelper().put(PropertyKeys.collapsed, collapsed);
94    }
95  
96    /**
97    Sets a CSS class in its parent, if the parent supports it.
98  
99     Which this feature it is possible to put a CSS class name into a component with the &lt;tc:style&gt; tag. Example:
100 
101    <pre>
102    &lt;tc:in&gt;
103      &lt;tc:style customClass="my-emphasized"/&gt;
104    &lt;/tc:in&gt;
105    </pre>
106 
107    One capability is, to used external CSS libs.
108    <br>
109    This feature should not be used imprudent.
110    Because it might be unstable against changes in the renderered HTML code.
111 
112   */
113   public org.apache.myfaces.tobago.renderkit.css.CustomClass getCustomClass() {
114     return (org.apache.myfaces.tobago.renderkit.css.CustomClass) getStateHelper().eval(PropertyKeys.customClass);
115   }
116 
117   public void setCustomClass(org.apache.myfaces.tobago.renderkit.css.CustomClass customClass) {
118     getStateHelper().put(PropertyKeys.customClass, customClass);
119   }
120 
121   /**
122   For internal use. Used for rendering, if there is a child tag &lt;tc:style&gt;
123 
124   */
125   public org.apache.myfaces.tobago.renderkit.css.Style getStyle() {
126     return (org.apache.myfaces.tobago.renderkit.css.Style) getStateHelper().eval(PropertyKeys.style);
127   }
128 
129   public void setStyle(org.apache.myfaces.tobago.renderkit.css.Style style) {
130     getStateHelper().put(PropertyKeys.style, style);
131   }
132 
133   /**
134   Text value to display as tooltip.
135 
136   */
137   public java.lang.String getTip() {
138     return (java.lang.String) getStateHelper().eval(PropertyKeys.tip);
139   }
140 
141   public void setTip(java.lang.String tip) {
142     getStateHelper().put(PropertyKeys.tip, tip);
143   }
144 
145   /**
146   A localized user presentable label for this component.
147 
148   */
149   public java.lang.String getLabel() {
150     return (java.lang.String) getStateHelper().eval(PropertyKeys.label);
151   }
152 
153   public void setLabel(java.lang.String label) {
154     getStateHelper().put(PropertyKeys.label, label);
155   }
156 
157   /**
158   Enum indicating the mode of the collapsed state of this component.
159   <br>Default: <code>none</code>
160   */
161   public org.apache.myfaces.tobago.model.CollapseMode getCollapsedMode() {
162     org.apache.myfaces.tobago.model.CollapseMode collapsedMode = (org.apache.myfaces.tobago.model.CollapseMode) getStateHelper().eval(PropertyKeys.collapsedMode);
163     if (collapsedMode != null) {
164       return collapsedMode;
165     }
166     return org.apache.myfaces.tobago.model.CollapseMode.none;
167   }
168 
169   public void setCollapsedMode(org.apache.myfaces.tobago.model.CollapseMode collapsedMode) {
170     getStateHelper().put(PropertyKeys.collapsedMode, collapsedMode);
171   }
172 
173 
174 }