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: <filter> <display-name>Ajax4jsf Filter</display-name> <filter-name>ajax4jsf</filter-name> <filter-class>org.ajax4jsf.Filter</filter-class> <init-param> <param-name>createTempFiles</param-name> <param-value>false</param-value> </init-param> <init-param> <param-name>maxRequestSize</param-name> <param-value>20000000</param-value> </init-param> </filter>

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`) | CSS style for add button
addButtonClassDisabled | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | CSS style for 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.
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
cancelButtonClass | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | CSS style for cancel button
cancelButtonClassDisabled | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | CSS style for cancel button disabled
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`) | CSS style for clean button
cleanButtonClassDisabled | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | CSS style for 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
fileEntryClass | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | CSS style upload file entry
fileEntryClassDisabled | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | CSS style upload file entry disabled
fileEntryControlClass | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | CSS style for upload enrty control
fileEntryControlClassDisabled | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | CSS style for upload enrty control disabled
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".
onblur | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | HTML: script expression; the element lost the focus
onchange | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | HTML: script expression; the element value was changed
onclear | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | A JavaScript event handler called when the file entries were cleared
onclick | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | HTML: a script expression; a pointer button is clicked
ondblclick | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | HTML: a script expression; a pointer button is double-clicked
onerror | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | A JavaScript event handler called when the file upload was interrupted according to any errors
onfocus | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | HTML: script expression; the element got the focus
onkeydown | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | HTML: a script expression; a key is pressed down
onkeypress | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | HTML: a script expression; a key is pressed and released
onkeyup | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | HTML: a script expression; a key is released
onmousedown | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | HTML: script expression; a pointer button is pressed down
onmousemove | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | HTML: a script expression; a pointer is moved within
onmouseout | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | HTML: a script expression; a pointer is moved away
onmouseover | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | HTML: a script expression; a pointer is moved onto
onmouseup | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | HTML: script expression; a pointer button is released
onselect | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | HTML: script expression; The onselect event occurs when you select some text in a text field. This attribute may be used with the INPUT and TEXTAREA elements
onsizerejected | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | A JavaScript event handler called when the file uploading was rejected by fiel size overflow
ontyperejected | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | A JavaScript event handler called when the file type was rejected according to file types allowed
onupload | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | A JavaScript event handler called on an upload operation
onuploadcanceled | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | A JavaScript event handler called when upload is cancelled
onuploadcomplete | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | A JavaScript event handler called when upload is completed
progressLabel | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Defines a label for a 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 that, if present, will be used as the text of the validation message for the "required" facility, if the "required" facility is used
sizeErrorLabel | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Defines a label for a 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
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(s) is/are to be applied when this component is rendered
styleClass | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | 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
uploadButtonClass | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | CSS style for upload button
uploadButtonClassDisabled | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | CSS style for 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`) | CSS style for upload list
uploadListClassDisabled | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | CSS style for 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.