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.AbstractUITreeSelect;
25  import org.apache.myfaces.tobago.renderkit.css.CustomClass;
26  import org.apache.myfaces.tobago.internal.util.ArrayUtils;
27  import org.apache.myfaces.tobago.internal.util.StringUtils;
28  import org.apache.myfaces.tobago.internal.util.Deprecation;
29  import javax.el.ELException;
30  import javax.faces.FacesException;
31  import java.util.Arrays;
32  import java.util.ArrayList;
33  import java.util.Collection;
34  import java.util.List;
35  import javax.el.MethodExpression;
36  import javax.el.ValueExpression;
37  
38  /** 
39   Makes a tree node selectable.
40    * UIComponent class, generated from template {@code component.stg} with class
41    * {@link org.apache.myfaces.tobago.internal.taglib.component.TreeSelectTagDeclaration}.
42   */
43  public class UITreeSelect
44      extends AbstractUITreeSelect implements Visual {
45  
46    public static final String COMPONENT_TYPE = "org.apache.myfaces.tobago.TreeSelect";
47  
48    public static final String COMPONENT_FAMILY = "javax.faces.SelectBoolean";
49  
50    private static final Collection<String> EVENT_NAMES = Arrays.asList("change", "click", "dblclick", "focus", "blur");
51  
52    @Override
53    public Collection<String> getEventNames() {
54      return EVENT_NAMES;
55    }
56  
57    @Override
58    public String getDefaultEventName() {
59      return "change";
60    }
61  
62  
63    enum PropertyKeys {
64      markup,
65      label,
66      showCheckbox,
67      customClass,
68      tip,
69      disabled,
70    }
71  
72    public String getFamily() {
73      return COMPONENT_FAMILY;
74    }
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    A localized user presentable label for this component.
91  
92    */
93    public java.lang.String getLabel() {
94      return (java.lang.String) getStateHelper().eval(PropertyKeys.label);
95    }
96  
97    public void setLabel(java.lang.String label) {
98      getStateHelper().put(PropertyKeys.label, label);
99    }
100 
101   /**
102   Show a checkbox to visualize the selection state.
103    This is useful to hide the checkbox, e. g. dependent of the type of the node.
104   <br>Default: <code>true</code>
105   */
106   public boolean isShowCheckbox() {
107     Boolean bool = (Boolean) getStateHelper().eval(PropertyKeys.showCheckbox);
108     if (bool != null) {
109       return bool;
110     }
111     return true;
112   }
113 
114   public void setShowCheckbox(boolean showCheckbox) {
115     getStateHelper().put(PropertyKeys.showCheckbox, showCheckbox);
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   Text value to display as tooltip.
145 
146   */
147   public java.lang.String getTip() {
148     return (java.lang.String) getStateHelper().eval(PropertyKeys.tip);
149   }
150 
151   public void setTip(java.lang.String tip) {
152     getStateHelper().put(PropertyKeys.tip, tip);
153   }
154 
155   /**
156   Flag indicating that this element is disabled.
157   <br>Default: <code>false</code>
158   */
159   public boolean isDisabled() {
160     Boolean bool = (Boolean) getStateHelper().eval(PropertyKeys.disabled);
161     if (bool != null) {
162       return bool;
163     }
164     return false;
165   }
166 
167   public void setDisabled(boolean disabled) {
168     getStateHelper().put(PropertyKeys.disabled, disabled);
169   }
170 
171 
172 }