001    /*
002     * Licensed to the Apache Software Foundation (ASF) under one
003     * or more contributor license agreements.  See the NOTICE file
004     * distributed with this work for additional information
005     * regarding copyright ownership.  The ASF licenses this file
006     * to you under the Apache License, Version 2.0 (the
007     * "License"); you may not use this file except in compliance
008     * with the License.  You may obtain a copy of the License at
009     *
010     *   http://www.apache.org/licenses/LICENSE-2.0
011     *
012     * Unless required by applicable law or agreed to in writing,
013     * software distributed under the License is distributed on an
014     * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015     * KIND, either express or implied.  See the License for the
016     * specific language governing permissions and limitations
017     * under the License.
018     */
019    
020    package org.apache.myfaces.tobago.taglib.component;
021    
022    import org.apache.myfaces.tobago.apt.annotation.Tag;
023    import org.apache.myfaces.tobago.apt.annotation.TagAttribute;
024    import org.apache.myfaces.tobago.apt.annotation.UIComponentTag;
025    import org.apache.myfaces.tobago.apt.annotation.UIComponentTagAttribute;
026    import org.apache.myfaces.tobago.taglib.decl.HasIdBindingAndRendered;
027    import org.apache.myfaces.tobago.taglib.decl.HasLabelAndAccessKey;
028    import org.apache.myfaces.tobago.taglib.decl.HasOnchange;
029    import org.apache.myfaces.tobago.taglib.decl.HasTabIndex;
030    import org.apache.myfaces.tobago.taglib.decl.HasTip;
031    import org.apache.myfaces.tobago.taglib.decl.HasValidator;
032    import org.apache.myfaces.tobago.taglib.decl.HasValueChangeListener;
033    import org.apache.myfaces.tobago.taglib.decl.IsDisabled;
034    import org.apache.myfaces.tobago.taglib.decl.IsReadonly;
035    import org.apache.myfaces.tobago.taglib.decl.IsRequired;
036    
037    /**
038     * Renders a file input field.
039     * You need to define an org.apache.myfaces.tobago.webapp.TobagoMultipartFormdataFilter in your web.xml or
040     * add the tobago-fileupload.jar to your project.
041     * The tobago-fileupload.jar contains a FacesContextFactory that wraps the
042     * multipart-formdata request inside the facesContext.
043     * <p>
044     * For content constraints please use <a href="validateFileItem.html">tc:validateFileItem</a>.
045     */
046    @Tag(name = "file")
047    @UIComponentTag(
048        uiComponent = "org.apache.myfaces.tobago.component.UIFileInput",
049        rendererType = "File")
050    public interface FileTagDeclaration
051        extends BeanTagDeclaration, HasValidator, HasOnchange, HasValueChangeListener, HasIdBindingAndRendered, IsDisabled,
052        HasLabelAndAccessKey, HasTip, IsReadonly, IsRequired, HasTabIndex {
053    
054      /**
055       * Value binding expression pointing to a
056       * <code>org.apache.commons.fileupload.FileItem</code> property to store the
057       * uploaded file.
058       */
059      @TagAttribute()
060      @UIComponentTagAttribute(type = {"org.apache.commons.fileupload.FileItem"})
061      void setValue(String value);
062    }