Overview   Library    Tag    Help 
 FRAMES   NO FRAMES 

Tomahawk tag library.
Tag inputFileUpload

Creates a file-selection widget in the rendered page which allows a user to select a file for uploading to the server.

When the page is selected (using a command component such as commandButton), the currently selected file contents are included in the data posted to the server. The contents are cached somewhere, and an object of type UploadedFile will then be assigned to the property pointed to by the "value" expression of this component.

You must enable the Tomahawk ExtensionsFilter to make this component work (see web.xml).

Also, don't forget to set the form's attribute "enctype" to "multipart/form-data". See "examples/web/fileupload.jsp" for an example!

Unless otherwise specified, all attributes accept static values or EL expressions.


Tag Information
Tag Classorg.apache.myfaces.custom.fileupload.HtmlInputFileUploadTag
TagExtraInfo ClassNone
Body ContentJSP
Display NameNone

Attributes
NameRequiredRequest-timeTypeDescription
storagefalsefalsejava.lang.StringThis setting was intended to allow control over how the contents of the file get temporarily stored during processing.

It allows three options

  • "default": The file is handled on memory while the file size is below uploadThresholdSize value, otherwise is handled on disk or file storage when decode occur (set submitted value)
  • "memory": The file is loaded to memory when decode occur (set submitted value). In other words, before set the uploaded file as submitted value it is loaded to memory. Use with caution, because it could cause OutOfMemory exceptions when the uploaded files are too big.
  • "file": The file is handled on disk or file storage.
acceptfalsefalsejava.lang.StringThis attribute specifies a comma-separated list of content types that a server processing this form will handle correctly. User agents may use this information to filter out non-conforming files when prompting a user to select files to be sent to the server (cf. the INPUT element when type="file")."
valuefalsefalsejava.lang.StringAn EL expression to which an UploadedFile object will be assigned on postback if the user specified a file to upload to the server.
enabledOnUserRolefalsefalsejava.lang.StringIf user is in given role, this component will be rendered normally. If not, no hyperlink is rendered but all nested tags (=body) are rendered.
visibleOnUserRolefalsefalsejava.lang.StringIf user is in given role, this component will be rendered normally. If not, nothing is rendered and the body of this tag will be skipped.
alignfalsefalsejava.lang.StringHTML: Specifies the horizontal alignment of this element. Deprecated in HTML 4.01.
maxlengthfalsefalsejava.lang.StringHTML: The maximum number of characters allowed to be entered.
sizefalsefalsejava.lang.StringHTML: The initial width of this control, in characters.
stylefalsefalsejava.lang.StringHTML: CSS styling instructions.
styleClassfalsefalsejava.lang.StringThe CSS class for this element. Corresponds to the HTML 'class' attribute.
altfalsefalsejava.lang.StringHTML: Specifies alternative text that can be used by a browser that can't show this element.
tabindexfalsefalsejava.lang.StringHTML: Specifies the position of this element within the tab order of the document.
onblurfalsefalsejava.lang.StringHTML: Specifies a script to be invoked when the element loses focus.
onfocusfalsefalsejava.lang.StringHTML: Specifies a script to be invoked when the element receives focus.
accesskeyfalsefalsejava.lang.StringHTML: Sets the access key for this element.
onclickfalsefalsejava.lang.StringHTML: Script to be invoked when the element is clicked.
ondblclickfalsefalsejava.lang.StringHTML: Script to be invoked when the element is double-clicked.
onkeydownfalsefalsejava.lang.StringHTML: Script to be invoked when a key is pressed down over this element.
onkeypressfalsefalsejava.lang.StringHTML: Script to be invoked when a key is pressed over this element.
onkeyupfalsefalsejava.lang.StringHTML: Script to be invoked when a key is released over this element.
onmousedownfalsefalsejava.lang.StringHTML: Script to be invoked when the pointing device is pressed over this element.
onmousemovefalsefalsejava.lang.StringHTML: Script to be invoked when the pointing device is moved while it is in this element.
onmouseoutfalsefalsejava.lang.StringHTML: Script to be invoked when the pointing device is moves out of this element.
onmouseoverfalsefalsejava.lang.StringHTML: Script to be invoked when the pointing device is moved into this element.
onmouseupfalsefalsejava.lang.StringHTML: Script to be invoked when the pointing device is released over this element.
onchangefalsefalsejava.lang.StringHTML: Specifies a script to be invoked when the element is modified.
onselectfalsefalsejava.lang.StringHTML: Specifies a script to be invoked when the element is selected.
dirfalsefalsejava.lang.StringHTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).
langfalsefalsejava.lang.StringHTML: The base language of this document.
titlefalsefalsejava.lang.StringHTML: An advisory title for this element. Often used by the user agent as a tooltip.
disabledfalsefalsejava.lang.StringHTML: When true, this element cannot receive focus.
readonlyfalsefalsejava.lang.StringHTML: When true, indicates that this component cannot be modified by the user. The element may receive focus unless it has also been disabled.
validatorfalsefalsejava.lang.StringA method binding EL expression, accepting FacesContext, UIComponent, and Object parameters, and returning void, that validates the component's local value.
valueChangeListenerfalsefalsejava.lang.StringA method binding EL expression, accepting a ValueChangeEvent parameter and returning void. The specified method is invoked if this component is modified. The phase that this handler is fired in can be controlled via the immediate attribute.
immediatefalsefalsejava.lang.StringA boolean value that identifies the phase during which value change events should fire. During normal event processing, value change events are fired during the "process validations" phase of request processing. If this attribute is set to "true", these methods are fired instead at the end of the "apply request values" phase.
requiredfalsefalsejava.lang.StringA boolean value that indicates whether an input value is required. If this value is true, and no input value is provided, the error message javax.faces.component.UIInput.REQUIRED is posted.
converterfalsefalsejava.lang.StringThe value can either be a static value (ID) or an EL expression. When a static id is specified, an instance of the converter type registered with that id is used. When this is an EL expression, the result of evaluating the expression must be an object that implements the Converter interface.
idfalsefalsejava.lang.StringAn identifier for this particular component instance within a component view.

The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view

This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted.

renderedfalsefalsejava.lang.StringA boolean value that indicates whether this component should be rendered. Default value: true.
bindingfalsefalsejava.lang.StringIdentifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.

Variables
No Variables Defined.

 Overview   Library    Tag    Help 
 FRAMES   NO FRAMES 
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.