Tobago Components 1.5.x
Tag file


Renders a file input field. You need to define an org.apache.myfaces.tobago.webapp.TobagoMultipartFormdataFilter in your web.xml or add the tobago-fileupload.jar to your project. The tobago-fileupload.jar contains a FacesContextFactory that wraps the multipart-formdata request inside the facesContext.

For content constraints please use tc:validateFileItem.

UIComponentClass: org.apache.myfaces.tobago.component.UIFileInput

RendererType: File



Tag Information
Tag Classorg.apache.myfaces.tobago.internal.taglib.FileTag
TagExtraInfo ClassNone
Body ContentJSP
Display NameNone

Attributes
NameRequiredRequest-timeTypeDescription
validatorfalsefalsejavax.el.MethodExpression
(signature must match void validator(javax.faces.context.FacesContext, javax.faces.component.UIComponent, java.lang.Object))
A method binding EL expression, accepting FacesContext, UIComponent, and Object parameters, and returning void, that validates the component's local value.
validatorMessagefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
An expression that specifies the validator message
Type: java.lang.String
requiredMessagefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
An expression that specifies the required message
Type: java.lang.String
converterMessagefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
An expression that specifies the converter message
Type: java.lang.String
onchangefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Clientside script function to add to this component's onchange handler.
Type: java.lang.String
valueChangeListenerfalsefalsejavax.el.MethodExpression
(signature must match void valueChangeListener(javax.faces.event.ValueChangeEvent))
MethodBinding representing a value change listener method that will be notified when a new value has been set for this input component. The expression must evaluate to a public method that takes a ValueChangeEvent parameter, with a return type of void.
idfalsetruejava.lang.StringThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.
Type: java.lang.String
bindingfalsefalsejavax.el.ValueExpression
(must evaluate to javax.faces.component.UIComponent)
The value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:

  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.

Type: javax.faces.component.UIComponent
renderedfalsefalsejavax.el.ValueExpression
(must evaluate to boolean)
Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.
Type: boolean
Default: true
disabledfalsefalsejavax.el.ValueExpression
(must evaluate to boolean)
Flag indicating that this element is disabled.
Type: boolean
Default: false
markupfalsefalsejavax.el.ValueExpression
(must evaluate to org.apache.myfaces.tobago.context.Markup)
Indicate markup of this component. The allowed markups can be defined or overridden in the theme. The value 'none' should not be used any longer. Just leave the attribute empty, or use a NULL pointer.
Type: org.apache.myfaces.tobago.context.Markup
labelfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Text value to display as label. If text contains an underscore the next character is used as accesskey.
Type: java.lang.String
accessKeyfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Character)

**** @deprecated. Will be removed in a future version ****

Deprecated! Has not longer any function.
Type: java.lang.Character
labelWithAccessKeyfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)

**** @deprecated. Will be removed in a future version ****

Deprecated! Use 'label' instead. Text value to display as label. If text contains an underscore the next character overwrites 'accesskey'.
Type: java.lang.String
tipfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Text value to display as tooltip.
Type: java.lang.String
readonlyfalsefalsejavax.el.ValueExpression
(must evaluate to boolean)
Flag indicating that this component will prohibit changes by the user.
Type: boolean
Default: false
requiredfalsefalsejavax.el.ValueExpression
(must evaluate to boolean)
Flag indicating that a value is required. If the value is an empty string a ValidationError occurs and a Error Message is rendered.
Type: boolean
Default: false
tabIndexfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Integer)
Controls the navigation of the focus through the input controls on a page with the Tab-Key. The navigation starts from the element with the lowest tabIndex value to the element with the highest value. Elements that have identical tabIndex values should be navigated in the order they appear in the character stream Elements that are disabled or with a negative tabIndex do not participate in the tabbing order.
Type: java.lang.Integer
valuefalsefalsejavax.el.ValueExpression
(must evaluate to org.apache.commons.fileupload.FileItem)
Value binding expression pointing to a org.apache.commons.fileupload.FileItem property to store the uploaded file.
Type: org.apache.commons.fileupload.FileItem

Variables
No Variables Defined.


Output Generated by Tag Library Documentation Generator. Java, JSP, and JavaServer Pages are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries. Copyright 2002-4 Sun Microsystems, Inc. 4150 Network Circle Santa Clara, CA 95054, U.S.A. All Rights Reserved.