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.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   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   */
46  public class UITreeMenu
47      extends AbstractUITreeMenu implements ClientBehaviorHolder, Visual {
48  
49    public static final String COMPONENT_TYPE = "org.apache.myfaces.tobago.TreeMenu";
50  
51    public static final String COMPONENT_FAMILY = "javax.faces.Data";
52  
53  
54    enum PropertyKeys {
55      showRoot,
56      markup,
57      customClass,
58      style,
59    }
60  
61    public String getFamily() {
62      return COMPONENT_FAMILY;
63    }
64  
65  
66    /**
67    Only applicable in the case that the data model is a tree.
68     This flag indicates that the root node should be displayed.
69     Often in tree structures the root node is special and should not be displayed.
70    <br>Default: <code>false</code>
71    */
72    public boolean isShowRoot() {
73      Boolean bool = (Boolean) getStateHelper().eval(PropertyKeys.showRoot);
74      if (bool != null) {
75        return bool;
76      }
77      return false;
78    }
79  
80    public void setShowRoot(boolean showRoot) {
81      getStateHelper().put(PropertyKeys.showRoot, showRoot);
82    }
83  
84    public org.apache.myfaces.tobago.context.Markup getMarkup() {
85      Object object = getStateHelper().eval(PropertyKeys.markup);
86      if (object != null) {
87        return Markup.valueOf(object);
88      }
89      return null;
90    }
91  
92    public void setMarkup(org.apache.myfaces.tobago.context.Markup markup) {
93      getStateHelper().put(PropertyKeys.markup, markup);
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 }