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