6.50.  < rich:fileUpload >

6.50.1. Description

The <rich:fileUpload> component designed to perform Ajax-ed files upload to server.

<rich:fileUpload> component

Figure 6.84.  <rich:fileUpload> component


6.50.2. Key Features

  • Highly customizable look and feel
  • File types/File sizes restrictions
  • Multiple files upload support
  • Cancel the request possibility
  • One request for every upload component
  • Different submit modes (Server/Client)
  • Asynchronous mode

Table 6.189. rich : fileUpload attributes

Attribute NameDescription
acceptedTypesFiles types allowed to upload
accesskeyThis 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
addButtonClassCSS style for add button
addButtonClassDisabledCSS style for add button disabled
addControlLabel${prop.xmlEncodedDescription}
alignleft|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
altFor 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
autoclearIf this attribute is true files will be immediatelly removed from list after upload completed
bindingThe attribute takes a value-binding expression for a component property of a backing bean
cancelButtonClassCSS style for cancel button
cancelButtonClassDisabledCSS style for cancel button disabled
cancelEntryControlLabel${prop.xmlEncodedDescription}
cleanButtonClassCSS style for clean button
cleanButtonClassDisabledCSS style for clean button disabled
clearAllControlLabel${prop.xmlEncodedDescription}
clearControlLabel${prop.xmlEncodedDescription}
contentTypethe property to receive the contentType
converterId of Converter to be used or reference to a Converter
converterMessageconverterMessage
disabledDisabled attribute
fileEntryClassCSS style upload file entry
fileEntryClassDisabledCSS style upload file entry disabled
fileEntryControlClassCSS style for upload enrty control
fileEntryControlClassDisabledCSS style for upload enrty control disabled
fileNamethis value binding receives the filename (optional).
fileSizethis value binding receives the file size (optional).
fileUploadListenerMethodExpression representing an action listener method that will be notified after file uploaded.
idEvery component may have a unique id that is automatically created if omitted
immediateA 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
listHeightDefines height of file list
listWidthDefines width of file list
localContentTypelocalContentType
localelocale
localFileNamelocalFileName
localFileSizelocalFileSize
localInputStreamlocalInputStream
localValueSetlocalValueSet
maxFilesQuantityDefines max files count allowed for upload (optional).
maxlengthWhen 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
onblurHTML: script expression; the element lost the focus
onchangeHTML: script expression; the element value was changed
onclickHTML: a script expression; a pointer button is clicked
ondblclickHTML: a script expression; a pointer button is double-clicked
onerror${prop.xmlEncodedDescription}
onfocusHTML: script expression; the element got the focus
onkeydownHTML: a script expression; a key is pressed down
onkeypressHTML: a script expression; a key is pressed and released
onkeyupHTML: a script expression; a key is released
onmousedownHTML: script expression; a pointer button is pressed down
onmousemoveHTML: a script expression; a pointer is moved within
onmouseoutHTML: a script expression; a pointer is moved away
onmouseoverHTML: a script expression; a pointer is moved onto
onmouseupHTML: script expression; a pointer button is released
onselectHTML: 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
onupload${prop.xmlEncodedDescription}
onuploadcanceled${prop.xmlEncodedDescription}
onuploadcomplete${prop.xmlEncodedDescription}
progressInfoDefines bean name where progress info should be stored (optional).
renderedIf "false", this component is not rendered
requiredIf "true", this component is checked for non-empty input
requiredMessagerequiredMessage
sizeThis 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
stopControlLabel${prop.xmlEncodedDescription}
stopEntryControlLabel${prop.xmlEncodedDescription}
styleCSS style(s) is/are to be applied when this component is rendered
styleClassCorresponds to the HTML class attribute
tabindexThis 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
uploadButtonClassCSS style for upload button
uploadButtonClassDisabledCSS style for upload button disabled
uploadControlLabel${prop.xmlEncodedDescription}
uploadDataCollection of files uploaded
uploadListClassCSS style for upload list
uploadListClassDisabledCSS style for upload list disabled
validvalid
validatorMethodBinding pointing at a method that is called during Process Validations phase of the request processing lifecycle, to validate the current value of this component
validatorMessagevalidatorMessage
valueThe initial value to set when rendered for the first time
valueChangeListenerListener for value changes