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