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)
Assigns one or more space-separated CSS class names to the component 'Add' button
addButtonClassDisabledfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Assigns one or more space-separated CSS class names to the component '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)
Assigns one or more space-separated CSS class names to the component 'Clean' button
cleanButtonClassDisabledfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Assigns one or more space-separated CSS class names to the component '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)
Assigns one or more space-separated CSS class names to the file entries
fileEntryClassDisabledfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Assigns one or more space-separated CSS class names to the file entries disabled
fileEntryControlClassfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Assigns one or more space-separated CSS class names to the controls of the file entries
fileEntryControlClassDisabledfalsefalsejavax.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
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)
The client-side script method to be called before a file is added
onblurfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when the element loses the focus
onchangefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when the element value is changed
onclearfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when a file entry is cleared
onclickfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when the element is clicked
ondblclickfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when the element is double-clicked
onerrorfalsefalsejavax.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
onfileuploadcompletefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when a file is uploaded to the server
onfocusfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when the element gets the focus
onkeydownfalsefalsejavax.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
onkeypressfalsefalsejavax.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
onkeyupfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when a key is released
onmousedownfalsefalsejavax.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
onmousemovefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when a pointer is moved within the element
onmouseoutfalsefalsejavax.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
onmouseoverfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when a pointer is moved onto the element
onmouseupfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when a mouse button is released
onselectfalsefalsejavax.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.
onsizerejectedfalsefalsejavax.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
ontyperejectedfalsefalsejavax.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
onuploadfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when a file uploading is started
onuploadcanceledfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when a file uploading is cancelled
onuploadcompletefalsefalsejavax.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
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 which defines text of validation message to show, if a required field is missing
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)
Assigns one or more space-separated CSS class names to the component 'Cancel' button
stopButtonClassDisabledfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Assigns one or more space-separated CSS class names to the component '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 rules to be applied to the component
styleClassfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Assigns one or more CSS class names to the component. 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)
Assigns one or more space-separated CSS class names to the component 'Upload' button
uploadButtonClassDisabledfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Assigns one or more space-separated CSS class names to the component '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)
Assigns one or more space-separated CSS class names to the upload list
uploadListClassDisabledfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Assigns one or more space-separated CSS class names to the 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.