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.ArrayList;
33  import java.util.List;
34  import javax.el.MethodExpression;
35  import javax.el.ValueExpression;
36  
37  /** 
38   A tree which will be displayed like a flat menu.
39    This menu is often used for navigation on the left side of an application.
40    * UIComponent class, generated from template {@code component.stg} with class
41    * {@link org.apache.myfaces.tobago.internal.taglib.component.TreeMenuTagDeclaration}.
42   */
43  public class UITreeMenu
44      extends AbstractUITreeMenu implements Visual {
45  
46    public static final String COMPONENT_TYPE = "org.apache.myfaces.tobago.TreeMenu";
47  
48    public static final String COMPONENT_FAMILY = "javax.faces.Data";
49  
50  
51    enum PropertyKeys {
52      showRoot,
53      markup,
54      customClass,
55      style,
56    }
57  
58    public String getFamily() {
59      return COMPONENT_FAMILY;
60    }
61  
62  
63    /**
64    Only applicable in the case that the data model is a tree.
65     This flag indicates that the root node should be displayed.
66     Often in tree structures the root node is special and should not be displayed.
67    <br>Default: <code>false</code>
68    */
69    public boolean isShowRoot() {
70      Boolean bool = (Boolean) getStateHelper().eval(PropertyKeys.showRoot);
71      if (bool != null) {
72        return bool;
73      }
74      return false;
75    }
76  
77    public void setShowRoot(boolean showRoot) {
78      getStateHelper().put(PropertyKeys.showRoot, showRoot);
79    }
80  
81    public org.apache.myfaces.tobago.context.Markup getMarkup() {
82      Object object = getStateHelper().eval(PropertyKeys.markup);
83      if (object != null) {
84        return Markup.valueOf(object);
85      }
86      return null;
87    }
88  
89    public void setMarkup(org.apache.myfaces.tobago.context.Markup markup) {
90      getStateHelper().put(PropertyKeys.markup, markup);
91    }
92  
93    /**
94    Sets a CSS class in its parent, if the parent supports it.
95  
96     Which this feature it is possible to put a CSS class name into a component with the &lt;tc:style&gt; tag. Example:
97  
98     <pre>
99     &lt;tc:in&gt;
100      &lt;tc:style customClass="my-emphasized"/&gt;
101    &lt;/tc:in&gt;
102    </pre>
103 
104    One capability is, to used external CSS libs.
105    <br>
106    This feature should not be used imprudent.
107    Because it might be unstable against changes in the renderered HTML code.
108 
109   */
110   public org.apache.myfaces.tobago.renderkit.css.CustomClass getCustomClass() {
111     return (org.apache.myfaces.tobago.renderkit.css.CustomClass) getStateHelper().eval(PropertyKeys.customClass);
112   }
113 
114   public void setCustomClass(org.apache.myfaces.tobago.renderkit.css.CustomClass customClass) {
115     getStateHelper().put(PropertyKeys.customClass, customClass);
116   }
117 
118   /**
119   For internal use. Used for rendering, if there is a child tag &lt;tc:style&gt;
120 
121   */
122   public org.apache.myfaces.tobago.renderkit.css.Style getStyle() {
123     return (org.apache.myfaces.tobago.renderkit.css.Style) getStateHelper().eval(PropertyKeys.style);
124   }
125 
126   public void setStyle(org.apache.myfaces.tobago.renderkit.css.Style style) {
127     getStateHelper().put(PropertyKeys.style, style);
128   }
129 
130 
131 }