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)
${prop.xmlEncodedDescription}
alignfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
left|center|right|justify [CI] Deprecated. This attribute specifies the horizontal alignment of its element with respect to the surrounding context. Possible values: * left: text lines are rendered flush left. * center: text lines are centered. * right: text lines are rendered flush right. * justify: text lines are justified to both margins. The default depends on the base text direction. For left to right text, the default is align=left, while for right to left text, the default is align=right
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 immediatelly removed from list after upload completed
bindingfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
The attribute takes a value-binding expression for a component property of a backing bean
cancelButtonClassfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
CSS style for cancel button
cancelButtonClassDisabledfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
CSS style for cancel button disabled
cancelEntryControlLabelfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
${prop.xmlEncodedDescription}
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)
${prop.xmlEncodedDescription}
clearControlLabelfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
${prop.xmlEncodedDescription}
contentTypefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
the property to receive the contentType
converterfalsefalsejavax.el.ValueExpression
(must evaluate to javax.faces.convert.Converter)
Id of Converter to be used or reference to a Converter
converterMessagefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
converterMessage
disabledfalsefalsejavax.el.ValueExpression
(must evaluate to boolean)
Disabled attribute
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
fileNamefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
this value binding receives the filename (optional).
fileSizefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Integer)
this value binding receives the file size (optional).
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
listHeightfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Defines height of file list
listWidthfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Defines width of file list
localContentTypefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
localContentType
localFileNamefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
localFileName
localFileSizefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Integer)
localFileSize
localInputStreamfalsefalsejavax.el.ValueExpression
(must evaluate to java.io.InputStream)
localInputStream
localValueSetfalsefalsejavax.el.ValueExpression
(must evaluate to boolean)
localValueSet
localefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
locale
maxFilesQuantityfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Integer)
Defines max files count allowed for upload (optional).
maxlengthfalsefalsejavax.el.ValueExpression
(must evaluate to int)
When the type attribute has the value "text" or "password", this attribute specifies the maximum number of characters you may enter. This number may exceed the specified size, in which case the user agent should offer a scrolling mechanism. The default value for this attribute is an unlimited number
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
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)
${prop.xmlEncodedDescription}
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
onuploadfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
${prop.xmlEncodedDescription}
onuploadcanceledfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
${prop.xmlEncodedDescription}
onuploadcompletefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
${prop.xmlEncodedDescription}
progressInfofalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
Defines bean name where progress info should be stored (optional).
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)
requiredMessage
sizefalsefalsejavax.el.ValueExpression
(must evaluate to int)
This attribute tells the user agent the initial width of the control. The width is given in pixels except when type attribute has the value "text" or "password". In that case, its value refers to the (integer) number of characters
stopControlLabelfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
${prop.xmlEncodedDescription}
stopEntryControlLabelfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.String)
${prop.xmlEncodedDescription}
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
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)
${prop.xmlEncodedDescription}
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
validfalsefalsejavax.el.ValueExpression
(must evaluate to boolean)
valid
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)
validatorMessage
valuefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
The initial value to set when rendered for the first time
valueChangeListenerfalsefalsejavax.el.MethodExpression
(signature must match void valueChangeListener(javax.faces.event.ValueChangeEvent))
Listener for value changes

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.