| Info | Value |
|---|---|
| Component Type | org.primefaces.component.FileUpload |
| Handler Class | org.primefaces.component.fileupload.FileUploadHandler |
| Renderer Type | org.primefaces.component.FileUploadRenderer |
| Description | None |
| Name | Required | Type | Description |
|---|---|---|---|
accept | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| To filter files in native file browser dialog. |
allowTypes | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Regular expression for accepted file types, e.g., /(\.|\/)(gif|jpeg|jpg|png)$/ |
auto | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When set to true, selecting a file starts the upload process implicitly. Default is false. |
binding | false | jakarta.el.ValueExpression
(must evaluate to javax.faces.component.UIComponent)
| An el expression referring to a server side UIComponent instance in a backing bean. |
cancelButtonStyleClass | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Style class for cancel button. |
cancelButtonTitle | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Native title tooltip for cancel button. |
cancelIcon | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| No Description |
cancelLabel | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Label of the cancel button, default is 'Cancel'. |
chooseButtonStyleClass | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Style class for choose button. |
chooseButtonTitle | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Native title tooltip for choose button. |
chooseIcon | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| No Description |
converter | false | jakarta.el.ValueExpression
(must evaluate to javax.faces.convert.Converter)
| An el expression or a literal text that defines a converter for the component. When it's an EL expression, it's resolved to a converter instance. In case it's a static text, it must refer to a converter id. |
converterMessage | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Message to display when conversion fails. |
disabled | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Disables fileupload user interface interaction. |
displayFilename | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Simple Mode: if the filename should be displayed. |
dragDropSupport | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Specifies dragdrop based file selection from filesystem, default is true and works only on supported browsers. |
dropZone | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Component that should be used as the drop zone. |
fileLimit | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Maximum number of files to be uploaded. Deprecated please attach 'p:validateFile'. |
global | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Global AJAX requests are listened by ajaxStatus component, setting global to false will not trigger ajaxStatus. |
id | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Unique identifier of the component in a namingContainer. |
immediate | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When set true, process validations logic is executed at apply request values phase for this component. Default is false. |
label | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Label of the browse button, default is 'Choose'. |
listener | false | jakarta.el.ValueExpression
(must evaluate to javax.el.MethodExpression)
| Method expression to invoke when a file is uploaded. |
maxChunkSize | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Long)
| To upload large files in smaller chunks, set this option to a preferred maximum chunk size. If set to 0 (default), null or undefined, or the browser does not support the required Blob API, files will be uploaded as a whole. Only works in "advanced" mode. |
maxRetries | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Only for chunked file upload: Amount of retries when upload get´s interrupted due to e.g. unstable network connection. |
messageTemplate | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Message template to use when displaying file in simple upload mode and some client side validation messages in advanced mode. Default is "{name} {size}". |
mode | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Mode of the uploader, valid values are "simple" and "advanced". |
multiple | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Allows choosing of multi file uploads from native file browse dialog, turned off by default. |
onAdd | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Callback to execute before adding a file. |
oncancel | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Callback to execute after fileupload request is cancelled. |
oncomplete | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Callback to execute after fileupload request completes. |
onerror | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Callback to execute after fileupload request fails. |
onstart | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Callback to execute at the beginning of fileupload. |
onupload | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Callback to execute before the files are sent. If this callback returns false, the file upload request is not started. |
onvalidationfailure | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Callback to execute after a fileupload client validation error. |
previewWidth | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Width for image previews in pixels. Default value is 80. |
process | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Component(s) to be processed during fileupload request. |
rendered | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Boolean value to specify the rendering of the component, when set to false component will not be rendered. |
required | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Marks component as required. |
requiredMessage | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Message to display when required field validation fails. |
retryTimeout | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Only for chunked file upload: (Base-)Timeout in milliseconds to wait until the next retry. It is multiplied with the retry count. (first retry: retryTimeout * 1, second retry: retryTimeout *2, ...) |
sequential | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Uploads are concurrent by default set this option to true for sequential uploads. |
sizeLimit | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Long)
| Individual file size limit in bytes. Default is unlimited. Deprecated please attach 'p:validateFile'. |
skinSimple | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Applies theming to simple uploader, default is false. |
style | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Inline style of the main component. |
styleClass | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Style class of the component. |
title | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Native title tooltip for simple mode. |
update | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Component(s) to be updated after fileupload completes. |
uploadButtonStyleClass | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Style class for upload button. |
uploadButtonTitle | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Native title tooltip for upload button. |
uploadIcon | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| No Description |
uploadLabel | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Label of the upload button, default is 'Upload'. |
validateContentType | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Whether content type validation should be performed, based on the types defined in the accept attribute. Default is false. |
validator | false | jakarta.el.ValueExpression
(must evaluate to javax.faces.validator.Validator)
| A method expression referring to a method validating the input. |
validatorMessage | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Message to display when validation fails. |
value | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Object)
| Value of the component. |
valueChangeListener | false | jakarta.el.ValueExpression
(must evaluate to javax.faces.event.ValueChangeListener)
| A method binding expression referring to a method for handling a valuchangeevent. |
virusScan | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Whether virus scan should be performed. Default is false. |
widgetVar | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Name of the client side widget. |
Output generated by Vdldoc View Declaration Language Documentation Generator.