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