| Info | Value |
|---|---|
| Component Type | org.primefaces.component.FileUpload |
| Display Name | None |
| Handler Class | org.primefaces.component.fileupload.FileUploadHandler |
| Renderer Type | org.primefaces.component.FileUploadRenderer |
| Description | None |
| Name | Required | Type | Description |
|---|---|---|---|
id | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Unique identifier of the component in a namingContainer. |
rendered | false | javax.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. |
binding | false | javax.el.ValueExpression
(must evaluate to javax.faces.component.UIComponent)
| An el expression referring to a server side UIComponent instance in a backing bean. |
value | false | javax.el.ValueExpression
(must evaluate to java.lang.Object)
| Value of the component. |
converter | false | javax.el.ValueExpression
(must evaluate to java.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. |
immediate | false | javax.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. |
required | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Marks component as required. |
validator | false | javax.el.ValueExpression
(must evaluate to javax.faces.validator.Validator)
| A method expression referring to a method validationg the input. |
valueChangeListener | false | javax.el.ValueExpression
(must evaluate to javax.faces.event.ValueChangeListener)
| A method binding expression referring to a method for handling a valuchangeevent. |
requiredMessage | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Message to display when required field validation fails. |
converterMessage | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Message to display when conversion fails. |
validatorMessage | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Message to display when validation fails. |
widgetVar | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Name of the client side widget. |
style | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Inline style of the main component. |
styleClass | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Style class of the component. |
update | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Component(s) to be updated after fileupload completes. |
process | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Component(s) to be processed during fileupload request. |
fileUploadListener | false | javax.el.ValueExpression
(must evaluate to javax.el.MethodExpression)
| Method expression to listen file upload events. |
multiple | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Allows choosing of multi file uploads from native file browse dialog, turned off by default. |
auto | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When set to true, selecting a file starts the upload process implicitly. Default is false. |
label | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Label of the browse button, default is 'Choose'. |
allowTypes | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Regular expression for accepted file types, e.g. /(\.|\/)(gif|jpe?g|png)$/ |
fileLimit | false | javax.el.ValueExpression
(must evaluate to java.lang.Integer)
| Maximum number of files to be uploaded. |
sizeLimit | false | javax.el.ValueExpression
(must evaluate to java.lang.Long)
| Individual file size limit in bytes. Default is unlimited. |
mode | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Mode of the uploader, valid values are "simple" and "advanced". |
uploadLabel | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Label of the upload button, default is 'Upload'. |
cancelLabel | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Label of the cancel button, default is 'Cancel'. |
invalidSizeMessage | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Message to display when file size validation fails. |
invalidFileMessage | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Message to display when file limit validation fails. |
fileLimitMessage | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Message to display when file count validation fails. |
dragDropSupport | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Specifies dragdrop based file selection from filesystem, default is true and works only on supported browsers. |
onstart | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Callback to execute at the beginning of fileupload. |
oncomplete | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Callback to execute after fileupload request completes. |
onerror | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Callback to execute after fileupload request fails. |
disabled | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Disables fileupload user interface interaction. |
messageTemplate | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Message template to use when displaying file validation errors. Default is "{name} {size}". |
previewWidth | false | javax.el.ValueExpression
(must evaluate to java.lang.Integer)
| Width for image previews in pixels. Default value is 80. |
Output generated by Vdldoc View Declaration Language Documentation Generator.