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.Behavior;
23  import org.apache.myfaces.tobago.apt.annotation.DynamicExpression;
24  import org.apache.myfaces.tobago.apt.annotation.Tag;
25  import org.apache.myfaces.tobago.apt.annotation.TagAttribute;
26  import org.apache.myfaces.tobago.apt.annotation.UIComponentTag;
27  import org.apache.myfaces.tobago.apt.annotation.UIComponentTagAttribute;
28  import org.apache.myfaces.tobago.component.ClientBehaviors;
29  import org.apache.myfaces.tobago.component.RendererTypes;
30  import org.apache.myfaces.tobago.internal.taglib.declaration.HasAccessKey;
31  import org.apache.myfaces.tobago.internal.taglib.declaration.HasConverterMessage;
32  import org.apache.myfaces.tobago.internal.taglib.declaration.HasIdBindingAndRendered;
33  import org.apache.myfaces.tobago.internal.taglib.declaration.HasLabel;
34  import org.apache.myfaces.tobago.internal.taglib.declaration.HasLabelLayout;
35  import org.apache.myfaces.tobago.internal.taglib.declaration.HasRequiredMessage;
36  import org.apache.myfaces.tobago.internal.taglib.declaration.HasTabIndex;
37  import org.apache.myfaces.tobago.internal.taglib.declaration.HasTip;
38  import org.apache.myfaces.tobago.internal.taglib.declaration.HasValidator;
39  import org.apache.myfaces.tobago.internal.taglib.declaration.HasValidatorMessage;
40  import org.apache.myfaces.tobago.internal.taglib.declaration.HasValueChangeListener;
41  import org.apache.myfaces.tobago.internal.taglib.declaration.IsDisabled;
42  import org.apache.myfaces.tobago.internal.taglib.declaration.IsFocus;
43  import org.apache.myfaces.tobago.internal.taglib.declaration.IsMultiple;
44  import org.apache.myfaces.tobago.internal.taglib.declaration.IsReadonly;
45  import org.apache.myfaces.tobago.internal.taglib.declaration.IsRequired;
46  import org.apache.myfaces.tobago.internal.taglib.declaration.IsVisual;
47  
48  import javax.faces.component.UIInput;
49  
50  /**
51   * <p>
52   * Renders a file input field.
53   * </p>
54   * <p>
55   * For content constraints please use <a href="validateFileItem.html">tc:validateFileItem</a>.
56   * </p>
57   */
58  @Tag(name = "file")
59  @UIComponentTag(
60      uiComponent = "org.apache.myfaces.tobago.component.UIFile",
61      uiComponentBaseClass = "org.apache.myfaces.tobago.internal.component.AbstractUIFile",
62      uiComponentFacesClass = "javax.faces.component.UIInput",
63      componentFamily = UIInput.COMPONENT_FAMILY,
64      rendererType = RendererTypes.FILE,
65      allowedChildComponenents = "NONE",
66      behaviors = {
67          @Behavior(
68              name = ClientBehaviors.CHANGE,
69              isDefault = true),
70          @Behavior(
71              name = ClientBehaviors.CLICK),
72          @Behavior(
73              name = ClientBehaviors.DBLCLICK),
74          @Behavior(
75              name = ClientBehaviors.FOCUS),
76          @Behavior(
77              name = ClientBehaviors.BLUR)
78      })
79  public interface FileTagDeclaration
80      extends HasValidator, HasValidatorMessage, HasRequiredMessage, HasConverterMessage,
81      HasValueChangeListener, HasIdBindingAndRendered, IsDisabled, IsFocus, IsMultiple,
82      HasLabel, HasLabelLayout, HasAccessKey, HasTip, IsReadonly, IsRequired, HasTabIndex, IsVisual {
83  
84    /**
85     * Value binding expression pointing to a
86     * {@link javax.servlet.http.Part} property to store the
87     * uploaded file.
88     */
89    @TagAttribute()
90    @UIComponentTagAttribute(
91        type = { "javax.servlet.http.Part", "javax.servlet.http.Part[]" },
92        expression = DynamicExpression.VALUE_EXPRESSION_REQUIRED)
93    void setValue(String value);
94  }