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.internal.util.ArrayUtils;
28  import org.apache.myfaces.tobago.internal.util.StringUtils;
29  import org.apache.myfaces.tobago.internal.util.Deprecation;
30  import javax.annotation.Generated;
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   Intended for use in situations when only one UIComponent child can be
42    nested, such as in the case of facets.
43    * UIComponent class, generated from template {@code component.stg} with class
44    * {@link org.apache.myfaces.tobago.internal.taglib.component.PanelTagDeclaration}.
45   */
46  @Generated("component.stg")
47  public class UIPanel
48      extends AbstractUIPanel implements Visual {
49  
50    public static final String COMPONENT_TYPE = "org.apache.myfaces.tobago.Panel";
51  
52    public static final String COMPONENT_FAMILY = "javax.faces.Panel";
53  
54    private static final Collection<String> EVENT_NAMES = Arrays.asList("click", "dblclick", "mouseover", "mouseout");
55  
56    @Override
57    public Collection<String> getEventNames() {
58      return EVENT_NAMES;
59    }
60  
61    @Override
62    public String getDefaultEventName() {
63      return "click";
64    }
65  
66  
67    enum PropertyKeys {
68      markup,
69      collapsed,
70      customClass,
71      tip,
72      collapsedMode,
73    }
74  
75    public String getFamily() {
76      return COMPONENT_FAMILY;
77    }
78  
79  
80    public org.apache.myfaces.tobago.context.Markup getMarkup() {
81      Object object = getStateHelper().eval(PropertyKeys.markup);
82      if (object != null) {
83        return Markup.valueOf(object);
84      }
85      return null;
86    }
87  
88    public void setMarkup(org.apache.myfaces.tobago.context.Markup markup) {
89      getStateHelper().put(PropertyKeys.markup, markup);
90    }
91  
92    /**
93    Indicating the collapsed state of this component.
94    <br>Default: <code>false</code>
95    */
96    public boolean isCollapsed() {
97      Boolean bool = (Boolean) getStateHelper().eval(PropertyKeys.collapsed);
98      if (bool != null) {
99        return bool;
100     }
101     return false;
102   }
103 
104   public void setCollapsed(boolean collapsed) {
105     getStateHelper().put(PropertyKeys.collapsed, collapsed);
106   }
107 
108   /**
109   Sets a CSS class in its parent, if the parent supports it.
110 
111    Which this feature it is possible to put a CSS class name into a component with the &lt;tc:style&gt; tag. Example:
112 
113    <pre>
114    &lt;tc:in&gt;
115      &lt;tc:style customClass="my-emphasized"/&gt;
116    &lt;/tc:in&gt;
117    </pre>
118 
119    One capability is, to used external CSS libs.
120    <br>
121    This feature should not be used imprudent.
122    Because it might be unstable against changes in the renderered HTML code.
123 
124   */
125   public org.apache.myfaces.tobago.renderkit.css.CustomClass getCustomClass() {
126     return (org.apache.myfaces.tobago.renderkit.css.CustomClass) getStateHelper().eval(PropertyKeys.customClass);
127   }
128 
129   public void setCustomClass(org.apache.myfaces.tobago.renderkit.css.CustomClass customClass) {
130     getStateHelper().put(PropertyKeys.customClass, customClass);
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   Enum indicating the mode of the collapsed state of this component.
147   <br>Default: <code>none</code>
148   */
149   public org.apache.myfaces.tobago.model.CollapseMode getCollapsedMode() {
150     org.apache.myfaces.tobago.model.CollapseMode collapsedMode = (org.apache.myfaces.tobago.model.CollapseMode) getStateHelper().eval(PropertyKeys.collapsedMode);
151     if (collapsedMode != null) {
152       return collapsedMode;
153     }
154     return org.apache.myfaces.tobago.model.CollapseMode.none;
155   }
156 
157   public void setCollapsedMode(org.apache.myfaces.tobago.model.CollapseMode collapsedMode) {
158     getStateHelper().put(PropertyKeys.collapsedMode, collapsedMode);
159   }
160 
161 
162   @Override
163   public void restoreState(FacesContext context, Object state) {
164     // FIXME HACK for mojarra SystemEventListener state restoring bug
165     pushComponentToEL(context, this);
166     super.restoreState(context, state);
167     popComponentFromEL(context);
168   }
169 
170 }