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.AbstractUIMenu;
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   Container component to hold submenus and items.
39    * UIComponent class, generated from template {@code component.stg} with class
40    * {@link org.apache.myfaces.tobago.internal.taglib.component.MenuTagDeclaration}.
41   */
42  public class UIMenu
43      extends AbstractUIMenu implements SupportsAccessKey, Visual {
44  
45    public static final String COMPONENT_TYPE = "org.apache.myfaces.tobago.Menu";
46  
47    public static final String COMPONENT_FAMILY = "javax.faces.Panel";
48  
49  
50    enum PropertyKeys {
51      image,
52      markup,
53      accessKey,
54      customClass,
55      disabled,
56      style,
57      label,
58    }
59  
60    public String getFamily() {
61      return COMPONENT_FAMILY;
62    }
63  
64  
65    /**
66    Url to an image to display.
67  
68    */
69    public java.lang.String getImage() {
70      return (java.lang.String) getStateHelper().eval(PropertyKeys.image);
71    }
72  
73    public void setImage(java.lang.String image) {
74      getStateHelper().put(PropertyKeys.image, image);
75    }
76  
77    public org.apache.myfaces.tobago.context.Markup getMarkup() {
78      Object object = getStateHelper().eval(PropertyKeys.markup);
79      if (object != null) {
80        return Markup.valueOf(object);
81      }
82      return null;
83    }
84  
85    public void setMarkup(org.apache.myfaces.tobago.context.Markup markup) {
86      getStateHelper().put(PropertyKeys.markup, markup);
87    }
88  
89    /**
90    The access key of this control.
91  
92    */
93    public java.lang.Character getAccessKey() {
94      return (java.lang.Character) getStateHelper().eval(PropertyKeys.accessKey);
95    }
96  
97    public void setAccessKey(java.lang.Character accessKey) {
98      getStateHelper().put(PropertyKeys.accessKey, accessKey);
99    }
100 
101   /**
102   Sets a CSS class in its parent, if the parent supports it.
103 
104    Which this feature it is possible to put a CSS class name into a component with the <tc:style> tag. Example:
105 
106    <pre>
107    &lt;tc:in&gt;
108      &lt;tc:style customClass="my-emphasized"/&gt;
109    &lt;/tc:in&gt;
110    </pre>
111 
112    One capability is, to used external CSS libs.
113    <br>
114    This feature should not be used imprudent.
115    Because it might be unstable against changes in the renderered HTML code.
116 
117   */
118   public org.apache.myfaces.tobago.renderkit.css.CustomClass getCustomClass() {
119     return (org.apache.myfaces.tobago.renderkit.css.CustomClass) getStateHelper().eval(PropertyKeys.customClass);
120   }
121 
122   public void setCustomClass(org.apache.myfaces.tobago.renderkit.css.CustomClass customClass) {
123     getStateHelper().put(PropertyKeys.customClass, customClass);
124   }
125 
126   /**
127   Flag indicating that this element is disabled.
128   <br>Default: <code>false</code>
129   */
130   public boolean isDisabled() {
131     Boolean bool = (Boolean) getStateHelper().eval(PropertyKeys.disabled);
132     if (bool != null) {
133       return bool;
134     }
135     return false;
136   }
137 
138   public void setDisabled(boolean disabled) {
139     getStateHelper().put(PropertyKeys.disabled, disabled);
140   }
141 
142   /**
143   For internal use. Used for rendering, if there is a child tag &lt;tc:style&gt;
144 
145   */
146   public org.apache.myfaces.tobago.renderkit.css.Style getStyle() {
147     return (org.apache.myfaces.tobago.renderkit.css.Style) getStateHelper().eval(PropertyKeys.style);
148   }
149 
150   public void setStyle(org.apache.myfaces.tobago.renderkit.css.Style style) {
151     getStateHelper().put(PropertyKeys.style, style);
152   }
153 
154   /**
155   Text value to display as label.
156    If text contains an underscore the next character is used as accesskey (if configured so and possible).
157 
158   */
159   public java.lang.String getLabel() {
160     return (java.lang.String) getStateHelper().eval(PropertyKeys.label);
161   }
162 
163   public void setLabel(java.lang.String label) {
164     getStateHelper().put(PropertyKeys.label, label);
165   }
166 
167 
168 }