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.AbstractUITreeListbox;
25  import org.apache.myfaces.tobago.model.Selectable;
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.ArrayList;
34  import java.util.List;
35  import javax.el.MethodExpression;
36  import javax.el.ValueExpression;
37  
38  /** 
39   A tree data structure displayed as a set of list boxes.
40    * UIComponent class, generated from template {@code component.stg} with class
41    * {@link org.apache.myfaces.tobago.internal.taglib.component.TreeListboxTagDeclaration}.
42   */
43  public class UITreeListbox
44      extends AbstractUITreeListbox implements Visual {
45  
46    public static final String COMPONENT_TYPE = "org.apache.myfaces.tobago.TreeListbox";
47  
48    public static final String COMPONENT_FAMILY = "javax.faces.Data";
49  
50  
51    enum PropertyKeys {
52      markup,
53      size,
54      selectable,
55      customClass,
56      style,
57      required,
58    }
59  
60    public String getFamily() {
61      return COMPONENT_FAMILY;
62    }
63  
64  
65    public org.apache.myfaces.tobago.context.Markup getMarkup() {
66      Object object = getStateHelper().eval(PropertyKeys.markup);
67      if (object != null) {
68        return Markup.valueOf(object);
69      }
70      return null;
71    }
72  
73    public void setMarkup(org.apache.myfaces.tobago.context.Markup markup) {
74      getStateHelper().put(PropertyKeys.markup, markup);
75    }
76  
77    /**
78    The number of the shown rows in the element. E. g. the size attribute of the select element in HTML.
79  
80    */
81    public java.lang.Integer getSize() {
82      Number value  = (Number) getStateHelper().eval(PropertyKeys.size);
83      if (value != null) {
84        return value.intValue();
85      }
86      return null;
87    }
88  
89    public void setSize(java.lang.Integer size) {
90      getStateHelper().put(PropertyKeys.size, size);
91    }
92  
93    /**
94    Flag indicating whether or not this component should be render selectable items.
95     Possible values are:
96     <ul>
97     <li><strong>single</strong> : a single section tree is rendered</li>
98     <li><strong>multiLeafOnly</strong> : a multi section tree is rendered,
99     only Leaf's are selectable</li>
100    <li><strong>singleLeafOnly</strong> : a single section tree is rendered,
101    only Leaf's are selectable</li>
102    </ul>
103   <br>Default: <code>single</code><br>Allowed Values: <code>single,multiLeafOnly,singleLeafOnly</code>
104   */
105   public org.apache.myfaces.tobago.model.Selectable getSelectable() {
106     org.apache.myfaces.tobago.model.Selectable selectable = (org.apache.myfaces.tobago.model.Selectable) getStateHelper().eval(PropertyKeys.selectable);
107     if (selectable != null) {
108       return selectable;
109     }
110     return org.apache.myfaces.tobago.model.Selectable.single;
111   }
112 
113   public void setSelectable(org.apache.myfaces.tobago.model.Selectable selectable) {
114     getStateHelper().put(PropertyKeys.selectable, selectable);
115   }
116 
117   /**
118   Sets a CSS class in its parent, if the parent supports it.
119 
120    Which this feature it is possible to put a CSS class name into a component with the &lt;tc:style&gt; tag. Example:
121 
122    <pre>
123    &lt;tc:in&gt;
124      &lt;tc:style customClass="my-emphasized"/&gt;
125    &lt;/tc:in&gt;
126    </pre>
127 
128    One capability is, to used external CSS libs.
129    <br>
130    This feature should not be used imprudent.
131    Because it might be unstable against changes in the renderered HTML code.
132 
133   */
134   public org.apache.myfaces.tobago.renderkit.css.CustomClass getCustomClass() {
135     return (org.apache.myfaces.tobago.renderkit.css.CustomClass) getStateHelper().eval(PropertyKeys.customClass);
136   }
137 
138   public void setCustomClass(org.apache.myfaces.tobago.renderkit.css.CustomClass customClass) {
139     getStateHelper().put(PropertyKeys.customClass, customClass);
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   Flag indicating that a value is required.
156    If the value is an empty string a
157    ValidationError occurs and a Error Message is rendered.
158   <br>Default: <code>false</code>
159   */
160   public boolean isRequired() {
161     Boolean bool = (Boolean) getStateHelper().eval(PropertyKeys.required);
162     if (bool != null) {
163       return bool;
164     }
165     return false;
166   }
167 
168   public void setRequired(boolean required) {
169     getStateHelper().put(PropertyKeys.required, required);
170   }
171 
172 
173 }