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