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.component.behavior.ClientBehaviorHolder;
23  import javax.faces.context.FacesContext;
24  import org.apache.myfaces.tobago.context.Markup;
25  import org.apache.myfaces.tobago.internal.component.AbstractUITreeListbox;
26  import org.apache.myfaces.tobago.model.Selectable;
27  import org.apache.myfaces.tobago.renderkit.css.CustomClass;
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 ClientBehaviorHolder, 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      required,
59    }
60  
61    public String getFamily() {
62      return COMPONENT_FAMILY;
63    }
64  
65  
66    public org.apache.myfaces.tobago.context.Markup getMarkup() {
67      Object object = getStateHelper().eval(PropertyKeys.markup);
68      if (object != null) {
69        return Markup.valueOf(object);
70      }
71      return null;
72    }
73  
74    public void setMarkup(org.apache.myfaces.tobago.context.Markup markup) {
75      getStateHelper().put(PropertyKeys.markup, markup);
76    }
77  
78    /**
79    The number of the shown rows in the element. E. g. the size attribute of the select element in HTML.
80  
81    */
82    public java.lang.Integer getSize() {
83      Number value  = (Number) getStateHelper().eval(PropertyKeys.size);
84      if (value != null) {
85        return value.intValue();
86      }
87      return null;
88    }
89  
90    public void setSize(java.lang.Integer size) {
91      getStateHelper().put(PropertyKeys.size, size);
92    }
93  
94    /**
95    Flag indicating whether or not this component should be render selectable items.
96     Possible values are:
97     <ul>
98     <li><strong>single</strong> : a single section tree is rendered</li>
99     <li><strong>multiLeafOnly</strong> : a multi section tree is rendered,
100    only Leaf's are selectable</li>
101    <li><strong>singleLeafOnly</strong> : a single section tree is rendered,
102    only Leaf's are selectable</li>
103    </ul>
104   <br>Default: <code>single</code><br>Allowed Values: <code>single,multiLeafOnly,singleLeafOnly</code>
105   */
106   public org.apache.myfaces.tobago.model.Selectable getSelectable() {
107     org.apache.myfaces.tobago.model.Selectable selectable = (org.apache.myfaces.tobago.model.Selectable) getStateHelper().eval(PropertyKeys.selectable);
108     if (selectable != null) {
109       return selectable;
110     }
111     return org.apache.myfaces.tobago.model.Selectable.single;
112   }
113 
114   public void setSelectable(org.apache.myfaces.tobago.model.Selectable selectable) {
115     getStateHelper().put(PropertyKeys.selectable, selectable);
116   }
117 
118   /**
119   Sets a CSS class in its parent, if the parent supports it.
120 
121    Which this feature it is possible to put a CSS class name into a component with the &lt;tc:style&gt; tag. Example:
122 
123    <pre>
124    &lt;tc:in&gt;
125      &lt;tc:style customClass="my-emphasized"/&gt;
126    &lt;/tc:in&gt;
127    </pre>
128 
129    One capability is, to used external CSS libs.
130    <br>
131    This feature should not be used imprudent.
132    Because it might be unstable against changes in the renderered HTML code.
133 
134   */
135   public org.apache.myfaces.tobago.renderkit.css.CustomClass getCustomClass() {
136     return (org.apache.myfaces.tobago.renderkit.css.CustomClass) getStateHelper().eval(PropertyKeys.customClass);
137   }
138 
139   public void setCustomClass(org.apache.myfaces.tobago.renderkit.css.CustomClass customClass) {
140     getStateHelper().put(PropertyKeys.customClass, customClass);
141   }
142 
143   /**
144   Flag indicating that a value is required.
145    If the value is an empty string a
146    ValidationError occurs and a Error Message is rendered.
147   <br>Default: <code>false</code>
148   */
149   public boolean isRequired() {
150     Boolean bool = (Boolean) getStateHelper().eval(PropertyKeys.required);
151     if (bool != null) {
152       return bool;
153     }
154     return false;
155   }
156 
157   public void setRequired(boolean required) {
158     getStateHelper().put(PropertyKeys.required, required);
159   }
160 
161 
162 }