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.AbstractUIFile;
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.annotation.Generated;
30  import javax.el.ELException;
31  import javax.faces.FacesException;
32  import java.util.Arrays;
33  import java.util.ArrayList;
34  import java.util.Collection;
35  import java.util.List;
36  import javax.el.MethodExpression;
37  import javax.el.ValueExpression;
38  
39  /** 
40   <p>
41    Renders a file input field.
42    </p>
43    <p>
44    For content constraints please use <a href="validateFileItem.html">tc:validateFileItem</a>.
45    </p>
46    * UIComponent class, generated from template {@code component.stg} with class
47    * {@link org.apache.myfaces.tobago.internal.taglib.component.FileTagDeclaration}.
48   */
49  @Generated("component.stg")
50  public class UIFile
51      extends AbstractUIFile implements Visual {
52  
53    public static final String COMPONENT_TYPE = "org.apache.myfaces.tobago.File";
54  
55    public static final String COMPONENT_FAMILY = "javax.faces.Input";
56  
57    private static final Collection<String> EVENT_NAMES = Arrays.asList("change", "click", "dblclick", "focus", "blur");
58  
59    @Override
60    public Collection<String> getEventNames() {
61      return EVENT_NAMES;
62    }
63  
64    @Override
65    public String getDefaultEventName() {
66      return "change";
67    }
68  
69  
70    enum PropertyKeys {
71      markup,
72      labelLayout,
73      multiple,
74      focus,
75      tabIndex,
76      label,
77      readonly,
78      accessKey,
79      customClass,
80      disabled,
81      tip,
82    }
83  
84    public String getFamily() {
85      return COMPONENT_FAMILY;
86    }
87  
88  
89    public org.apache.myfaces.tobago.context.Markup getMarkup() {
90      Object object = getStateHelper().eval(PropertyKeys.markup);
91      if (object != null) {
92        return Markup.valueOf(object);
93      }
94      return null;
95    }
96  
97    public void setMarkup(org.apache.myfaces.tobago.context.Markup markup) {
98      getStateHelper().put(PropertyKeys.markup, markup);
99    }
100 
101   /**
102   Defines the position of the label relative to the field.
103    The default is flexLeft, if the label is set, or none, if the label isn't set.
104    Set to 'skip' to avoid surrounding label container.
105    Hint for tc:out: set also compact=true to render only text (without html tags).
106 
107   */
108   public org.apache.myfaces.tobago.component.LabelLayout getLabelLayout() {
109     org.apache.myfaces.tobago.component.LabelLayout labelLayout = (org.apache.myfaces.tobago.component.LabelLayout) getStateHelper().eval(PropertyKeys.labelLayout);
110     if (labelLayout != null) {
111       return labelLayout;
112     }
113     return getLabel() != null ? org.apache.myfaces.tobago.component.LabelLayout.flexLeft : org.apache.myfaces.tobago.component.LabelLayout.none;
114   }
115 
116   public void setLabelLayout(org.apache.myfaces.tobago.component.LabelLayout labelLayout) {
117     getStateHelper().put(PropertyKeys.labelLayout, labelLayout);
118   }
119 
120   public boolean isMultiple() {
121     Boolean bool = (Boolean) getStateHelper().eval(PropertyKeys.multiple);
122     if (bool != null) {
123       return bool;
124     }
125     return false;
126   }
127 
128   public void setMultiple(boolean multiple) {
129     getStateHelper().put(PropertyKeys.multiple, multiple);
130   }
131 
132   /**
133   Flag indicating this component should receive the focus.
134   <br>Default: <code>false</code>
135   */
136   public boolean isFocus() {
137     Boolean bool = (Boolean) getStateHelper().eval(PropertyKeys.focus);
138     if (bool != null) {
139       return bool;
140     }
141     return false;
142   }
143 
144   public void setFocus(boolean focus) {
145     getStateHelper().put(PropertyKeys.focus, focus);
146   }
147 
148   /**
149   Controls the navigation of the focus through the
150    input controls on a page with the Tab-Key.
151    The navigation starts from the element with
152    the lowest tabIndex value to the element with the highest value.
153    Elements that have identical tabIndex values should be navigated
154    in the order they appear in the character stream
155    Elements that are disabled or with a negative tabIndex
156    do not participate in the tabbing order.
157 
158   */
159   public java.lang.Integer getTabIndex() {
160     Number value  = (Number) getStateHelper().eval(PropertyKeys.tabIndex);
161     if (value != null) {
162       return value.intValue();
163     }
164     return null;
165   }
166 
167   public void setTabIndex(java.lang.Integer tabIndex) {
168     getStateHelper().put(PropertyKeys.tabIndex, tabIndex);
169   }
170 
171   /**
172   A localized user presentable label for this component.
173 
174   */
175   public java.lang.String getLabel() {
176     return (java.lang.String) getStateHelper().eval(PropertyKeys.label);
177   }
178 
179   public void setLabel(java.lang.String label) {
180     getStateHelper().put(PropertyKeys.label, label);
181   }
182 
183   /**
184   Flag indicating that this component will prohibit changes by the user.
185   <br>Default: <code>false</code>
186   */
187   public boolean isReadonly() {
188     Boolean bool = (Boolean) getStateHelper().eval(PropertyKeys.readonly);
189     if (bool != null) {
190       return bool;
191     }
192     return false;
193   }
194 
195   public void setReadonly(boolean readonly) {
196     getStateHelper().put(PropertyKeys.readonly, readonly);
197   }
198 
199   /**
200   The access key of this control.
201 
202   */
203   public java.lang.Character getAccessKey() {
204     return (java.lang.Character) getStateHelper().eval(PropertyKeys.accessKey);
205   }
206 
207   public void setAccessKey(java.lang.Character accessKey) {
208     getStateHelper().put(PropertyKeys.accessKey, accessKey);
209   }
210 
211   /**
212   Sets a CSS class in its parent, if the parent supports it.
213 
214    Which this feature it is possible to put a CSS class name into a component with the &lt;tc:style&gt; tag. Example:
215 
216    <pre>
217    &lt;tc:in&gt;
218      &lt;tc:style customClass="my-emphasized"/&gt;
219    &lt;/tc:in&gt;
220    </pre>
221 
222    One capability is, to used external CSS libs.
223    <br>
224    This feature should not be used imprudent.
225    Because it might be unstable against changes in the renderered HTML code.
226 
227   */
228   public org.apache.myfaces.tobago.renderkit.css.CustomClass getCustomClass() {
229     return (org.apache.myfaces.tobago.renderkit.css.CustomClass) getStateHelper().eval(PropertyKeys.customClass);
230   }
231 
232   public void setCustomClass(org.apache.myfaces.tobago.renderkit.css.CustomClass customClass) {
233     getStateHelper().put(PropertyKeys.customClass, customClass);
234   }
235 
236   /**
237   Flag indicating that this element is disabled.
238   <br>Default: <code>false</code>
239   */
240   public boolean isDisabled() {
241     Boolean bool = (Boolean) getStateHelper().eval(PropertyKeys.disabled);
242     if (bool != null) {
243       return bool;
244     }
245     return false;
246   }
247 
248   public void setDisabled(boolean disabled) {
249     getStateHelper().put(PropertyKeys.disabled, disabled);
250   }
251 
252   /**
253   Text value to display as tooltip.
254 
255   */
256   public java.lang.String getTip() {
257     return (java.lang.String) getStateHelper().eval(PropertyKeys.tip);
258   }
259 
260   public void setTip(java.lang.String tip) {
261     getStateHelper().put(PropertyKeys.tip, tip);
262   }
263 
264 
265   @Override
266   public void restoreState(FacesContext context, Object state) {
267     // FIXME HACK for mojarra SystemEventListener state restoring bug
268     pushComponentToEL(context, this);
269     super.restoreState(context, state);
270     popComponentFromEL(context);
271   }
272 
273 }