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.AbstractUISelectManyShuttle;
25  import org.apache.myfaces.tobago.renderkit.css.CustomClass;
26  import org.apache.myfaces.tobago.renderkit.css.Style;
27  import org.apache.myfaces.tobago.internal.util.ArrayUtils;
28  import org.apache.myfaces.tobago.internal.util.StringUtils;
29  import org.apache.myfaces.tobago.internal.util.Deprecation;
30  import javax.el.ELException;
31  import javax.faces.FacesException;
32  import java.util.ArrayList;
33  import java.util.List;
34  import javax.el.MethodExpression;
35  import javax.el.ValueExpression;
36  
37  /** 
38    * UIComponent class, generated from template {@code component.stg} with class
39    * {@link org.apache.myfaces.tobago.internal.taglib.component.SelectManyShuttleTagDeclaration}.
40   */
41  public class UISelectManyShuttle
42      extends AbstractUISelectManyShuttle implements Visual {
43  
44    public static final String COMPONENT_TYPE = "org.apache.myfaces.tobago.SelectManyShuttle";
45  
46    public static final String COMPONENT_FAMILY = "javax.faces.SelectMany";
47  
48  
49    enum PropertyKeys {
50      markup,
51      selectedLabel,
52      labelLayout,
53      focus,
54      tabIndex,
55      label,
56      unselectedLabel,
57      readonly,
58      size,
59      customClass,
60      disabled,
61      tip,
62      style,
63    }
64  
65    public String getFamily() {
66      return COMPONENT_FAMILY;
67    }
68  
69  
70    public org.apache.myfaces.tobago.context.Markup getMarkup() {
71      Object object = getStateHelper().eval(PropertyKeys.markup);
72      if (object != null) {
73        return Markup.valueOf(object);
74      }
75      return null;
76    }
77  
78    public void setMarkup(org.apache.myfaces.tobago.context.Markup markup) {
79      getStateHelper().put(PropertyKeys.markup, markup);
80    }
81  
82    /**
83    A localized user presentable label for the right select box.
84  
85    */
86    public java.lang.String getSelectedLabel() {
87      return (java.lang.String) getStateHelper().eval(PropertyKeys.selectedLabel);
88    }
89  
90    public void setSelectedLabel(java.lang.String selectedLabel) {
91      getStateHelper().put(PropertyKeys.selectedLabel, selectedLabel);
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  
98    */
99    public org.apache.myfaces.tobago.component.LabelLayout getLabelLayout() {
100     org.apache.myfaces.tobago.component.LabelLayout labelLayout = (org.apache.myfaces.tobago.component.LabelLayout) getStateHelper().eval(PropertyKeys.labelLayout);
101     if (labelLayout != null) {
102       return labelLayout;
103     }
104     return getLabel() != null ? org.apache.myfaces.tobago.component.LabelLayout.flexLeft : org.apache.myfaces.tobago.component.LabelLayout.none;
105   }
106 
107   public void setLabelLayout(org.apache.myfaces.tobago.component.LabelLayout labelLayout) {
108     getStateHelper().put(PropertyKeys.labelLayout, labelLayout);
109   }
110 
111   /**
112   Flag indicating this component should receive the focus.
113   <br>Default: <code>false</code>
114   */
115   public boolean isFocus() {
116     Boolean bool = (Boolean) getStateHelper().eval(PropertyKeys.focus);
117     if (bool != null) {
118       return bool;
119     }
120     return false;
121   }
122 
123   public void setFocus(boolean focus) {
124     getStateHelper().put(PropertyKeys.focus, focus);
125   }
126 
127   /**
128   Controls the navigation of the focus through the
129    input controls on a page with the Tab-Key.
130    The navigation starts from the element with
131    the lowest tabIndex value to the element with the highest value.
132    Elements that have identical tabIndex values should be navigated
133    in the order they appear in the character stream
134    Elements that are disabled or with a negative tabIndex
135    do not participate in the tabbing order.
136 
137   */
138   public java.lang.Integer getTabIndex() {
139     Number value  = (Number) getStateHelper().eval(PropertyKeys.tabIndex);
140     if (value != null) {
141       return value.intValue();
142     }
143     return null;
144   }
145 
146   public void setTabIndex(java.lang.Integer tabIndex) {
147     getStateHelper().put(PropertyKeys.tabIndex, tabIndex);
148   }
149 
150   /**
151   A localized user presentable label for this component.
152 
153   */
154   public java.lang.String getLabel() {
155     return (java.lang.String) getStateHelper().eval(PropertyKeys.label);
156   }
157 
158   public void setLabel(java.lang.String label) {
159     getStateHelper().put(PropertyKeys.label, label);
160   }
161 
162   /**
163   A localized user presentable label for the left select box.
164 
165   */
166   public java.lang.String getUnselectedLabel() {
167     return (java.lang.String) getStateHelper().eval(PropertyKeys.unselectedLabel);
168   }
169 
170   public void setUnselectedLabel(java.lang.String unselectedLabel) {
171     getStateHelper().put(PropertyKeys.unselectedLabel, unselectedLabel);
172   }
173 
174   /**
175   Flag indicating that this component will prohibit changes by the user.
176   <br>Default: <code>false</code>
177   */
178   public boolean isReadonly() {
179     Boolean bool = (Boolean) getStateHelper().eval(PropertyKeys.readonly);
180     if (bool != null) {
181       return bool;
182     }
183     return false;
184   }
185 
186   public void setReadonly(boolean readonly) {
187     getStateHelper().put(PropertyKeys.readonly, readonly);
188   }
189 
190   /**
191   The number of the shown rows in the element. E. g. the size attribute of the select element in HTML.
192 
193   */
194   public java.lang.Integer getSize() {
195     Number value  = (Number) getStateHelper().eval(PropertyKeys.size);
196     if (value != null) {
197       return value.intValue();
198     }
199     return null;
200   }
201 
202   public void setSize(java.lang.Integer size) {
203     getStateHelper().put(PropertyKeys.size, size);
204   }
205 
206   /**
207   Sets a CSS class in its parent, if the parent supports it.
208 
209    Which this feature it is possible to put a CSS class name into a component with the &lt;tc:style&gt; tag. Example:
210 
211    <pre>
212    &lt;tc:in&gt;
213      &lt;tc:style customClass="my-emphasized"/&gt;
214    &lt;/tc:in&gt;
215    </pre>
216 
217    One capability is, to used external CSS libs.
218    <br>
219    This feature should not be used imprudent.
220    Because it might be unstable against changes in the renderered HTML code.
221 
222   */
223   public org.apache.myfaces.tobago.renderkit.css.CustomClass getCustomClass() {
224     return (org.apache.myfaces.tobago.renderkit.css.CustomClass) getStateHelper().eval(PropertyKeys.customClass);
225   }
226 
227   public void setCustomClass(org.apache.myfaces.tobago.renderkit.css.CustomClass customClass) {
228     getStateHelper().put(PropertyKeys.customClass, customClass);
229   }
230 
231   /**
232   Flag indicating that this element is disabled.
233   <br>Default: <code>false</code>
234   */
235   public boolean isDisabled() {
236     Boolean bool = (Boolean) getStateHelper().eval(PropertyKeys.disabled);
237     if (bool != null) {
238       return bool;
239     }
240     return false;
241   }
242 
243   public void setDisabled(boolean disabled) {
244     getStateHelper().put(PropertyKeys.disabled, disabled);
245   }
246 
247   /**
248   Text value to display as tooltip.
249 
250   */
251   public java.lang.String getTip() {
252     return (java.lang.String) getStateHelper().eval(PropertyKeys.tip);
253   }
254 
255   public void setTip(java.lang.String tip) {
256     getStateHelper().put(PropertyKeys.tip, tip);
257   }
258 
259   /**
260   For internal use. Used for rendering, if there is a child tag &lt;tc:style&gt;
261 
262   */
263   public org.apache.myfaces.tobago.renderkit.css.Style getStyle() {
264     return (org.apache.myfaces.tobago.renderkit.css.Style) getStateHelper().eval(PropertyKeys.style);
265   }
266 
267   public void setStyle(org.apache.myfaces.tobago.renderkit.css.Style style) {
268     getStateHelper().put(PropertyKeys.style, style);
269   }
270 
271 
272 }