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.AbstractUISelectManyCheckbox;
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   Render a group of checkboxes.
40    * UIComponent class, generated from template {@code component.stg} with class
41    * {@link org.apache.myfaces.tobago.internal.taglib.component.SelectManyCheckboxTagDeclaration}.
42   */
43  public class UISelectManyCheckbox
44      extends AbstractUISelectManyCheckbox implements Visual {
45  
46    public static final String COMPONENT_TYPE = "org.apache.myfaces.tobago.SelectManyCheckbox";
47  
48    public static final String COMPONENT_FAMILY = "javax.faces.SelectMany";
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      labelLayout,
66      focus,
67      tabIndex,
68      label,
69      inline,
70      readonly,
71      customClass,
72      disabled,
73      tip,
74      renderRange,
75    }
76  
77    public String getFamily() {
78      return COMPONENT_FAMILY;
79    }
80  
81  
82    public org.apache.myfaces.tobago.context.Markup getMarkup() {
83      Object object = getStateHelper().eval(PropertyKeys.markup);
84      if (object != null) {
85        return Markup.valueOf(object);
86      }
87      return null;
88    }
89  
90    public void setMarkup(org.apache.myfaces.tobago.context.Markup markup) {
91      getStateHelper().put(PropertyKeys.markup, markup);
92    }
93  
94    /**
95    Defines the position of the label relative to the field.
96     The default is flexLeft, if the label is set, or none, if the label isn't set.
97     Set to 'skip' to avoid surrounding label container.
98     Hint for tc:out: set also compact=true to render only text (without html tags).
99  
100   */
101   public org.apache.myfaces.tobago.component.LabelLayout getLabelLayout() {
102     org.apache.myfaces.tobago.component.LabelLayout labelLayout = (org.apache.myfaces.tobago.component.LabelLayout) getStateHelper().eval(PropertyKeys.labelLayout);
103     if (labelLayout != null) {
104       return labelLayout;
105     }
106     return getLabel() != null ? org.apache.myfaces.tobago.component.LabelLayout.flexLeft : org.apache.myfaces.tobago.component.LabelLayout.none;
107   }
108 
109   public void setLabelLayout(org.apache.myfaces.tobago.component.LabelLayout labelLayout) {
110     getStateHelper().put(PropertyKeys.labelLayout, labelLayout);
111   }
112 
113   /**
114   Flag indicating this component should receive the focus.
115   <br>Default: <code>false</code>
116   */
117   public boolean isFocus() {
118     Boolean bool = (Boolean) getStateHelper().eval(PropertyKeys.focus);
119     if (bool != null) {
120       return bool;
121     }
122     return false;
123   }
124 
125   public void setFocus(boolean focus) {
126     getStateHelper().put(PropertyKeys.focus, focus);
127   }
128 
129   /**
130   Controls the navigation of the focus through the
131    input controls on a page with the Tab-Key.
132    The navigation starts from the element with
133    the lowest tabIndex value to the element with the highest value.
134    Elements that have identical tabIndex values should be navigated
135    in the order they appear in the character stream
136    Elements that are disabled or with a negative tabIndex
137    do not participate in the tabbing order.
138 
139   */
140   public java.lang.Integer getTabIndex() {
141     Number value  = (Number) getStateHelper().eval(PropertyKeys.tabIndex);
142     if (value != null) {
143       return value.intValue();
144     }
145     return null;
146   }
147 
148   public void setTabIndex(java.lang.Integer tabIndex) {
149     getStateHelper().put(PropertyKeys.tabIndex, tabIndex);
150   }
151 
152   /**
153   A localized user presentable label for this component.
154 
155   */
156   public java.lang.String getLabel() {
157     return (java.lang.String) getStateHelper().eval(PropertyKeys.label);
158   }
159 
160   public void setLabel(java.lang.String label) {
161     getStateHelper().put(PropertyKeys.label, label);
162   }
163 
164   /**
165   Flag indicating this component should rendered as an inline element.
166   <br>Default: <code>false</code>
167   */
168   public boolean isInline() {
169     Boolean bool = (Boolean) getStateHelper().eval(PropertyKeys.inline);
170     if (bool != null) {
171       return bool;
172     }
173     return false;
174   }
175 
176   public void setInline(boolean inline) {
177     getStateHelper().put(PropertyKeys.inline, inline);
178   }
179 
180   /**
181   Flag indicating that this component will prohibit changes by the user.
182   <br>Default: <code>false</code>
183   */
184   public boolean isReadonly() {
185     Boolean bool = (Boolean) getStateHelper().eval(PropertyKeys.readonly);
186     if (bool != null) {
187       return bool;
188     }
189     return false;
190   }
191 
192   public void setReadonly(boolean readonly) {
193     getStateHelper().put(PropertyKeys.readonly, readonly);
194   }
195 
196   /**
197   Sets a CSS class in its parent, if the parent supports it.
198 
199    Which this feature it is possible to put a CSS class name into a component with the &lt;tc:style&gt; tag. Example:
200 
201    <pre>
202    &lt;tc:in&gt;
203      &lt;tc:style customClass="my-emphasized"/&gt;
204    &lt;/tc:in&gt;
205    </pre>
206 
207    One capability is, to used external CSS libs.
208    <br>
209    This feature should not be used imprudent.
210    Because it might be unstable against changes in the renderered HTML code.
211 
212   */
213   public org.apache.myfaces.tobago.renderkit.css.CustomClass getCustomClass() {
214     return (org.apache.myfaces.tobago.renderkit.css.CustomClass) getStateHelper().eval(PropertyKeys.customClass);
215   }
216 
217   public void setCustomClass(org.apache.myfaces.tobago.renderkit.css.CustomClass customClass) {
218     getStateHelper().put(PropertyKeys.customClass, customClass);
219   }
220 
221   /**
222   Flag indicating that this element is disabled.
223   <br>Default: <code>false</code>
224   */
225   public boolean isDisabled() {
226     Boolean bool = (Boolean) getStateHelper().eval(PropertyKeys.disabled);
227     if (bool != null) {
228       return bool;
229     }
230     return false;
231   }
232 
233   public void setDisabled(boolean disabled) {
234     getStateHelper().put(PropertyKeys.disabled, disabled);
235   }
236 
237   /**
238   Text value to display as tooltip.
239 
240   */
241   public java.lang.String getTip() {
242     return (java.lang.String) getStateHelper().eval(PropertyKeys.tip);
243   }
244 
245   public void setTip(java.lang.String tip) {
246     getStateHelper().put(PropertyKeys.tip, tip);
247   }
248 
249   /**
250   Range of items to render.
251 
252   */
253   public java.lang.String getRenderRange() {
254     return (java.lang.String) getStateHelper().eval(PropertyKeys.renderRange);
255   }
256 
257   public void setRenderRange(java.lang.String renderRange) {
258     getStateHelper().put(PropertyKeys.renderRange, renderRange);
259   }
260 
261 
262 }