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.el.ELException;
31  import javax.faces.FacesException;
32  import java.util.Arrays;
33  import java.util.ArrayList;
34  import java.util.Collection;
35  import java.util.List;
36  import javax.el.MethodExpression;
37  import javax.el.ValueExpression;
38  
39  /** 
40   A tree which will be displayed like a flat menu.
41    This menu is often used for navigation on the left side of an application.
42    * UIComponent class, generated from template {@code component.stg} with class
43    * {@link org.apache.myfaces.tobago.internal.taglib.component.TreeMenuTagDeclaration}.
44   */
45  public class UITreeMenu
46      extends AbstractUITreeMenu implements ClientBehaviorHolder, Visual {
47  
48    public static final String COMPONENT_TYPE = "org.apache.myfaces.tobago.TreeMenu";
49  
50    public static final String COMPONENT_FAMILY = "javax.faces.Data";
51  
52  
53    enum PropertyKeys {
54      showRoot,
55      markup,
56      customClass,
57    }
58  
59    public String getFamily() {
60      return COMPONENT_FAMILY;
61    }
62  
63  
64    /**
65    Only applicable in the case that the data model is a tree.
66     This flag indicates that the root node should be displayed.
67     Often in tree structures the root node is special and should not be displayed.
68    <br>Default: <code>false</code>
69    */
70    public boolean isShowRoot() {
71      Boolean bool = (Boolean) getStateHelper().eval(PropertyKeys.showRoot);
72      if (bool != null) {
73        return bool;
74      }
75      return false;
76    }
77  
78    public void setShowRoot(boolean showRoot) {
79      getStateHelper().put(PropertyKeys.showRoot, showRoot);
80    }
81  
82    public org.apache.myfaces.tobago.context.Markup getMarkup() {
83      Object object = getStateHelper().eval(PropertyKeys.markup);
84      if (object != null) {
85        return Markup.valueOf(object);
86      }
87      return null;
88    }
89  
90    public void setMarkup(org.apache.myfaces.tobago.context.Markup markup) {
91      getStateHelper().put(PropertyKeys.markup, markup);
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 }