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.AbstractUITreeMenu;
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   A tree which will be displayed like a flat menu.
42    This menu is often used for navigation on the left side of an application.
43    * UIComponent class, generated from template {@code component.stg} with class
44    * {@link org.apache.myfaces.tobago.internal.taglib.component.TreeMenuTagDeclaration}.
45     @deprecated
46   */
47  @Deprecated
48  @Generated("component.stg")
49  public class UITreeMenu
50      extends AbstractUITreeMenu implements ClientBehaviorHolder, Visual {
51  
52    public static final String COMPONENT_TYPE = "org.apache.myfaces.tobago.TreeMenu";
53  
54    public static final String COMPONENT_FAMILY = "javax.faces.Data";
55  
56  
57    enum PropertyKeys {
58      showRoot,
59      markup,
60      customClass,
61    }
62  
63    public String getFamily() {
64      return COMPONENT_FAMILY;
65    }
66  
67  
68    /**
69    Only applicable in the case that the data model is a tree.
70     This flag indicates that the root node should be displayed.
71     Often in tree structures the root node is special and should not be displayed.
72    <br>Default: <code>false</code>
73    */
74    public boolean isShowRoot() {
75      Boolean bool = (Boolean) getStateHelper().eval(PropertyKeys.showRoot);
76      if (bool != null) {
77        return bool;
78      }
79      return false;
80    }
81  
82    public void setShowRoot(boolean showRoot) {
83      getStateHelper().put(PropertyKeys.showRoot, showRoot);
84    }
85  
86    public org.apache.myfaces.tobago.context.Markup getMarkup() {
87      Object object = getStateHelper().eval(PropertyKeys.markup);
88      if (object != null) {
89        return Markup.valueOf(object);
90      }
91      return null;
92    }
93  
94    public void setMarkup(org.apache.myfaces.tobago.context.Markup markup) {
95      getStateHelper().put(PropertyKeys.markup, markup);
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   @Override
125   public void restoreState(FacesContext context, Object state) {
126     // FIXME HACK for mojarra SystemEventListener state restoring bug
127     pushComponentToEL(context, this);
128     super.restoreState(context, state);
129     popComponentFromEL(context);
130   }
131 
132 }