fileUpload (RichFaces JSF components library Tag library documentation)
Keywords: $title

Overview | Library | Tag | Help
| FRAMES NO FRAMES

## RichFaces ( Legacy URL )
Tag fileUpload

Renders a file upload control. The following configuration options for ajax4jsf filter may be configured in web.xml: * createTempFiles - if this option is set to true, uploaded files are streamed to a temporary file instead of in memory. * maxRequestSize - the maximum size of a file upload request, in bytes. Here's an example:

Tag Information
Tag Class | org.richfaces.taglib.FileUploadTag
TagExtraInfo Class | None
Body Content | JSP
Display Name | None

Attributes
Name | Required | Request-time | Type | Description
acceptedTypes | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Files types allowed to upload
accesskey | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | This attribute assigns an access key to an element. An access key is a single character from the document character set. Note: Authors should consider the input method of the expected reader when specifying an accesskey
addButtonClass | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Assigns one or more space-separated CSS class names to the component 'Add' button
addButtonClassDisabled | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Assigns one or more space-separated CSS class names to the component 'Add' button disabled
addControlLabel | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Defines a label for an add button
ajaxSingle | false | false | `javax.el.ValueExpression` (must evaluate to `boolean`) | Boolean attribute which provides possibility to limit JSF tree processing(decoding, conversion/validation, value applying) to the component which send the request only. Default value is "false"
allowFlash | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Attribute which allow the component to use the flash module that provides file upload functionality [false, true, auto]. Default value is "false"
alt | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | For a user agents that cannot display images, forms, or applets, this attribute specifies alternate text. The language of the alternate text is specified by the lang attribute
autoclear | false | false | `javax.el.ValueExpression` (must evaluate to `boolean`) | If this attribute is "true" files will be immediately removed from list after upload completed. Default value is "false".
binding | false | false | `javax.el.ValueExpression` (must evaluate to `javax.faces.component.UIComponent`) | The attribute takes a value-binding expression for a component property of a backing bean
cancelEntryControlLabel | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Defines a label for a cancel control
cleanButtonClass | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Assigns one or more space-separated CSS class names to the component 'Clean' button
cleanButtonClassDisabled | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Assigns one or more space-separated CSS class names to the component 'Clean' button disabled
clearAllControlLabel | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Defines a label for a clearAll button
clearControlLabel | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Defines a label for a clear control
disabled | false | false | `javax.el.ValueExpression` (must evaluate to `boolean`) | Attribute 'disabled' provides a possibility to make the whole component disabled if its value equals to "true". Default value is "false".
doneLabel | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Defines a label for a done label
doneLabelClass | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Assigns one or more space-separated CSS class names to the component 'Done' label
entryCancelLabelClass | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Assigns one or more space-separated CSS class names to the component 'Cancel entry' label in fileUpload list
entryClearLabelClass | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Assigns one or more space-separated CSS class names to the component 'Clear entry' label in fileUpload list
entryStopLabelClass | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Assigns one or more space-separated CSS class names to the component 'Stop entry' label in fileUpload list
fileEntryClass | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Assigns one or more space-separated CSS class names to the file entries
fileEntryClassDisabled | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Assigns one or more space-separated CSS class names to the file entries disabled
fileEntryControlClass | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Assigns one or more space-separated CSS class names to the controls of the file entries
fileEntryControlClassDisabled | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Assigns one or more space-separated CSS class names to the disabled controls of the file entries
fileUploadListener | false | false | `javax.el.MethodExpression` (signature must match `void fileUploadListener(org.richfaces.event.UploadEvent)`) | MethodExpression representing an action listener method that will be notified after file uploaded.
id | false | false | `java.lang.String` | Every component may have a unique id that is automatically created if omitted
immediate | false | false | `javax.el.ValueExpression` (must evaluate to `boolean`) | A flag indicating that this component value must be converted and validated immediately (that is, during Apply Request Values phase), rather than waiting until a Process Validations phase
immediateUpload | false | false | `javax.el.ValueExpression` (must evaluate to `boolean`) | If this attribute is true files will be immediately uploaded after they have been added in list. Default value is "false".
listHeight | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Defines height of file list. Default value is "210px".
listWidth | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Defines width of file list. Default value is "400px".
locale | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.Object`) | Used for locale definition
maxFilesQuantity | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.Integer`) | Defines max files count allowed for upload (optional). Default value is "1".
noDuplicate | false | false | `javax.el.ValueExpression` (must evaluate to `boolean`) | Defines if component should allow to add files that were already in list. Default value is "false".
onadd | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The client-side script method to be called before a file is added
onblur | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The client-side script method to be called when the element loses the focus
onchange | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The client-side script method to be called when the element value is changed
onclear | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The client-side script method to be called when a file entry is cleared
onclick | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The client-side script method to be called when the element is clicked
ondblclick | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The client-side script method to be called when the element is double-clicked
onerror | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The client-side script method to be called when a file uploading is interrupted according to any errors
onfileuploadcomplete | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The client-side script method to be called when a file is uploaded to the server
onfocus | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The client-side script method to be called when the element gets the focus
onkeydown | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The client-side script method to be called when a key is pressed down over the element
onkeypress | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The client-side script method to be called when a key is pressed over the element and released
onkeyup | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The client-side script method to be called when a key is released
onmousedown | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The client-side script method to be called when a mouse button is pressed down over the element
onmousemove | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The client-side script method to be called when a pointer is moved within the element
onmouseout | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The client-side script method to be called when a pointer is moved away from the element
onmouseover | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The client-side script method to be called when a pointer is moved onto the element
onmouseup | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The client-side script method to be called when a mouse button is released
onselect | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The client-side script method to be called when some text is selected in the text field. This attribute can be used with the INPUT and TEXTAREA elements.
onsizerejected | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The client-side script method to be called when a file uploading is rejected by the file size overflow
ontyperejected | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The client-side script method to be called when a file type is rejected according to the file types allowed
onupload | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The client-side script method to be called when a file uploading is started
onuploadcanceled | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The client-side script method to be called when a file uploading is cancelled
onuploadcomplete | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The client-side script method to be called when uploading of all files from the list is completed
progressLabel | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Defines a label for a progress label
progressLabelClass | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Assigns one or more space-separated CSS class names to the component 'Progress' label
rendered | false | false | `javax.el.ValueExpression` (must evaluate to `boolean`) | If "false", this component is not rendered
required | false | false | `javax.el.ValueExpression` (must evaluate to `boolean`) | If "true", this component is checked for non-empty input
requiredMessage | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | A ValueExpression enabled attribute which defines text of validation message to show, if a required field is missing
sizeErrorLabel | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Defines a label for a size error label
sizeErrorLabelClass | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Assigns one or more space-separated CSS class names to the component 'Size error' label
status | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | ID (in format of call UIComponent.findComponent()) of Request status component
stopButtonClass | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Assigns one or more space-separated CSS class names to the component 'Cancel' button
stopButtonClassDisabled | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Assigns one or more space-separated CSS class names to the component 'Cancel' button disabled
stopControlLabel | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Defines a label for a stop button
stopEntryControlLabel | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Defines a label for a stop control
style | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | CSS style rules to be applied to the component
styleClass | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Assigns one or more CSS class names to the component. Corresponds to the HTML "class" attribute.
tabindex | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | This attribute specifies the position of the current element in the tabbing order for the current document. This value must be a number between 0 and 32767. User agents should ignore leading zeros
transferErrorLabel | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Defines a label for a transfer error label
transferErrorLabelClass | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Assigns one or more space-separated CSS class names to the component 'Transfer error' label
uploadButtonClass | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Assigns one or more space-separated CSS class names to the component 'Upload' button
uploadButtonClassDisabled | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Assigns one or more space-separated CSS class names to the component 'Upload' button disabled
uploadControlLabel | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Defines a label for an upload button
uploadData | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.Object`) | Collection of files uploaded
uploadListClass | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Assigns one or more space-separated CSS class names to the upload list
uploadListClassDisabled | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Assigns one or more space-separated CSS class names to the upload list disabled
validator | false | false | `javax.el.MethodExpression` (signature must match `void validator(javax.faces.context.FacesContext, javax.faces.component.UIComponent, java.lang.Object)`) | MethodBinding pointing at a method that is called during Process Validations phase of the request processing lifecycle, to validate the current value of this component
validatorMessage | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | A ValueExpression enabled attribute that, if present, will be used as the text of the validator message, replacing any message that comes from the validator

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.