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 Classorg.richfaces.taglib.FileUploadTag
TagExtraInfo ClassNone
Body ContentJSP
Display NameNone

Attributes
NameRequiredRequest-timeTypeDescription
acceptedTypesfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Files types allowed to upload
accesskeyfalsefalsejavax.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
addButtonClassfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
CSS style for add button
addButtonClassDisabledfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
CSS style for add button disabled
addControlLabelfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Defines a label for an add button
ajaxSinglefalsefalsejavax.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"
allowFlashfalsefalsejavax.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"
altfalsefalsejavax.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
autoclearfalsefalsejavax.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".
bindingfalsefalsejavax.el.ValueExpression
(must evaluate to javax.faces.component.UIComponent)
The attribute takes a value-binding expression for a component property of a backing bean
cancelEntryControlLabelfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Defines a label for a cancel control
cleanButtonClassfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
CSS style for clean button
cleanButtonClassDisabledfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
CSS style for clean button disabled
clearAllControlLabelfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Defines a label for a clearAll button
clearControlLabelfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Defines a label for a clear control
disabledfalsefalsejavax.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".
doneLabelfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Defines a label for a done label
fileEntryClassfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
CSS style upload file entry
fileEntryClassDisabledfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
CSS style upload file entry disabled
fileEntryControlClassfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
CSS style for upload enrty control
fileEntryControlClassDisabledfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
CSS style for upload enrty control disabled
fileUploadListenerfalsefalsejavax.el.MethodExpression
(signature must match void fileUploadListener(org.richfaces.event.UploadEvent))
MethodExpression representing an action listener method that will be notified after file uploaded.
idfalsefalsejava.lang.StringEvery component may have a unique id that is automatically created if omitted
immediatefalsefalsejavax.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
immediateUploadfalsefalsejavax.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".
listHeightfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Defines height of file list. Default value is "210px".
listWidthfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Defines width of file list. Default value is "400px".
localefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
Used for locale definition
maxFilesQuantityfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Integer)
Defines max files count allowed for upload (optional). Default value is "1".
noDuplicatefalsefalsejavax.el.ValueExpression
(must evaluate to boolean)
Defines if component should allow to add files that were already in list. Default value is "false".
onaddfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
HTML: script expression; a file is added.
onblurfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
HTML: script expression; the element lost the focus
onchangefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
HTML: script expression; the element value was changed
onclearfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
HTML: script expression; the file entries are cleared
onclickfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
HTML: a script expression; a pointer button is clicked
ondblclickfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
HTML: a script expression; a pointer button is double-clicked
onerrorfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
HTML: script expression; the file uploading is interrupted according to any errors
onfileuploadcompletefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
HTML: script expression; a file is uploaded to the server
onfocusfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
HTML: script expression; the element got the focus
onkeydownfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
HTML: a script expression; a key is pressed down
onkeypressfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
HTML: a script expression; a key is pressed and released
onkeyupfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
HTML: a script expression; a key is released
onmousedownfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
HTML: script expression; a pointer button is pressed down
onmousemovefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
HTML: a script expression; a pointer is moved within
onmouseoutfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
HTML: a script expression; a pointer is moved away
onmouseoverfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
HTML: a script expression; a pointer is moved onto
onmouseupfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
HTML: script expression; a pointer button is released
onselectfalsefalsejavax.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
onsizerejectedfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
HTML: script expression; the file uploading is rejected by fiel size overflow
ontyperejectedfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
HTML: script expression; the file type is rejected according to file types allowed
onuploadfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
HTML: script expression; the uploading is cancelled at client side
onuploadcanceledfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
HTML: script expression; uploading is cancelled
onuploadcompletefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
HTML: script expression; uploading all files from list is completed
progressLabelfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Defines a label for a progress label
renderedfalsefalsejavax.el.ValueExpression
(must evaluate to boolean)
If "false", this component is not rendered
requiredfalsefalsejavax.el.ValueExpression
(must evaluate to boolean)
If "true", this component is checked for non-empty input
requiredMessagefalsefalsejavax.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
sizeErrorLabelfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Defines a label for a size error label
statusfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
ID (in format of call UIComponent.findComponent()) of Request status component
stopButtonClassfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
CSS style for cancel button
stopButtonClassDisabledfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
CSS style for cancel button disabled
stopControlLabelfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Defines a label for a stop button
stopEntryControlLabelfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Defines a label for a stop control
stylefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
CSS style(s) is/are to be applied when this component is rendered
styleClassfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Corresponds to the HTML class attribute
tabindexfalsefalsejavax.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
transferErrorLabelfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Defines a label for a transfer error label
uploadButtonClassfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
CSS style for upload button
uploadButtonClassDisabledfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
CSS style for upload button disabled
uploadControlLabelfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Defines a label for an upload button
uploadDatafalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
Collection of files uploaded
uploadListClassfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
CSS style for upload list
uploadListClassDisabledfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
CSS style for upload list disabled
validatorfalsefalsejavax.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
validatorMessagefalsefalsejavax.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.


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.