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.AbstractUITreeMenu;
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.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 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      style,
58    }
59  
60    public String getFamily() {
61      return COMPONENT_FAMILY;
62    }
63  
64  
65    /**
66    Only applicable in the case that the data model is a tree.
67     This flag indicates that the root node should be displayed.
68     Often in tree structures the root node is special and should not be displayed.
69    <br>Default: <code>false</code>
70    */
71    public boolean isShowRoot() {
72      Boolean bool = (Boolean) getStateHelper().eval(PropertyKeys.showRoot);
73      if (bool != null) {
74        return bool;
75      }
76      return false;
77    }
78  
79    public void setShowRoot(boolean showRoot) {
80      getStateHelper().put(PropertyKeys.showRoot, showRoot);
81    }
82  
83    public org.apache.myfaces.tobago.context.Markup getMarkup() {
84      Object object = getStateHelper().eval(PropertyKeys.markup);
85      if (object != null) {
86        return Markup.valueOf(object);
87      }
88      return null;
89    }
90  
91    public void setMarkup(org.apache.myfaces.tobago.context.Markup markup) {
92      getStateHelper().put(PropertyKeys.markup, markup);
93    }
94  
95    /**
96    Sets a CSS class in its parent, if the parent supports it.
97  
98     Which this feature it is possible to put a CSS class name into a component with the &lt;tc:style&gt; tag. Example:
99  
100    <pre>
101    &lt;tc:in&gt;
102      &lt;tc:style customClass="my-emphasized"/&gt;
103    &lt;/tc:in&gt;
104    </pre>
105 
106    One capability is, to used external CSS libs.
107    <br>
108    This feature should not be used imprudent.
109    Because it might be unstable against changes in the renderered HTML code.
110 
111   */
112   public org.apache.myfaces.tobago.renderkit.css.CustomClass getCustomClass() {
113     return (org.apache.myfaces.tobago.renderkit.css.CustomClass) getStateHelper().eval(PropertyKeys.customClass);
114   }
115 
116   public void setCustomClass(org.apache.myfaces.tobago.renderkit.css.CustomClass customClass) {
117     getStateHelper().put(PropertyKeys.customClass, customClass);
118   }
119 
120   /**
121   For internal use. Used for rendering, if there is a child tag &lt;tc:style&gt;
122 
123   */
124   public org.apache.myfaces.tobago.renderkit.css.Style getStyle() {
125     return (org.apache.myfaces.tobago.renderkit.css.Style) getStateHelper().eval(PropertyKeys.style);
126   }
127 
128   public void setStyle(org.apache.myfaces.tobago.renderkit.css.Style style) {
129     getStateHelper().put(PropertyKeys.style, style);
130   }
131 
132 
133 }