View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  
20  package org.apache.myfaces.tobago.internal.taglib.component;
21  
22  import org.apache.myfaces.tobago.apt.annotation.DynamicExpression;
23  import org.apache.myfaces.tobago.apt.annotation.Tag;
24  import org.apache.myfaces.tobago.apt.annotation.TagAttribute;
25  import org.apache.myfaces.tobago.apt.annotation.UIComponentTag;
26  import org.apache.myfaces.tobago.apt.annotation.UIComponentTagAttribute;
27  import org.apache.myfaces.tobago.component.RendererTypes;
28  import org.apache.myfaces.tobago.internal.taglib.declaration.HasConverterMessage;
29  import org.apache.myfaces.tobago.internal.taglib.declaration.HasCurrentMarkup;
30  import org.apache.myfaces.tobago.internal.taglib.declaration.HasIdBindingAndRendered;
31  import org.apache.myfaces.tobago.internal.taglib.declaration.HasLabelAndAccessKey;
32  import org.apache.myfaces.tobago.internal.taglib.declaration.HasMarkup;
33  import org.apache.myfaces.tobago.internal.taglib.declaration.HasOnchange;
34  import org.apache.myfaces.tobago.internal.taglib.declaration.HasRequiredMessage;
35  import org.apache.myfaces.tobago.internal.taglib.declaration.HasTabIndex;
36  import org.apache.myfaces.tobago.internal.taglib.declaration.HasTip;
37  import org.apache.myfaces.tobago.internal.taglib.declaration.HasValidator;
38  import org.apache.myfaces.tobago.internal.taglib.declaration.HasValidatorMessage;
39  import org.apache.myfaces.tobago.internal.taglib.declaration.HasValueChangeListener;
40  import org.apache.myfaces.tobago.internal.taglib.declaration.IsDisabled;
41  import org.apache.myfaces.tobago.internal.taglib.declaration.IsFocus;
42  import org.apache.myfaces.tobago.internal.taglib.declaration.IsGridLayoutComponent;
43  import org.apache.myfaces.tobago.internal.taglib.declaration.IsReadonly;
44  import org.apache.myfaces.tobago.internal.taglib.declaration.IsRequired;
45  
46  import javax.faces.component.UIInput;
47  
48  /**
49   * Renders a file input field.
50   * You need to define an org.apache.myfaces.tobago.webapp.TobagoMultipartFormdataFilter in your web.xml or
51   * add the tobago-fileupload.jar to your project.
52   * The tobago-fileupload.jar contains a FacesContextFactory that wraps the
53   * multipart-formdata request inside the facesContext.
54   * <p />
55   * For content constraints please use <a href="validateFileItem.html">tc:validateFileItem</a>.
56   */
57  @Tag(name = "file")
58  @UIComponentTag(
59      uiComponent = "org.apache.myfaces.tobago.component.UIFile",
60      uiComponentBaseClass = "org.apache.myfaces.tobago.internal.component.AbstractUIFile",
61      uiComponentFacesClass = "javax.faces.component.UIInput",
62      componentFamily = UIInput.COMPONENT_FAMILY,
63      rendererType = RendererTypes.FILE,
64      allowedChildComponenents = "NONE")
65  public interface FileTagDeclaration
66      extends HasValidator, HasValidatorMessage, HasRequiredMessage, HasConverterMessage, HasOnchange,
67      HasValueChangeListener, HasIdBindingAndRendered, IsDisabled, HasMarkup, HasCurrentMarkup, IsFocus,
68      HasLabelAndAccessKey, HasTip, IsReadonly, IsRequired, HasTabIndex, IsGridLayoutComponent {
69  
70    /**
71     * Value binding expression pointing to a
72     * <code>org.apache.commons.fileupload.FileItem</code> property to store the
73     * uploaded file.
74     */
75    @TagAttribute()
76    @UIComponentTagAttribute(
77        type = { "org.apache.commons.fileupload.FileItem" },
78        expression = DynamicExpression.VALUE_EXPRESSION_REQUIRED)
79    void setValue(String value);
80  }