A control that enables a user to upload a file. The model for this control (the type of object to which you bind the
control's value
attribute) is javax.servlet.http.Part
for a single file
java.util.List for multiple files.
For each Part
object, you can get:
getContentType()
method.getName()
method.getInputStream()
method.
When you are finished with a Part
, call its delete()
method to release its associated resources, such as its temp file on disk or bytes in memory.
You can only use this control in a Form control.
You can also upload files with asynchronous commands.
Info | Value |
---|---|
Component Type | com.webmethods.caf.faces.input.File |
Handler Class | None |
Renderer Type | com.webmethods.caf.faces.input.File |
Description | Allows user to upload a file |
Palette Location | CAF Html/Control/Input/File Input |
Client-Side Model | CAF.Input.File.Model |
Name | Required | Type | Description |
---|---|---|---|
accept | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| List of acceptable content-types in csv format |
accesskey | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| Keyboard shortcut letter |
converter | false | javax.el.ValueExpression
(must evaluate to javax.faces.convert.Converter )
| A value binding expression for a method that returns a converter instance. |
converterMessage | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| Will be used as the text of the converter message, replacing any message that comes from the converter. |
dir | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
|
Specifies the directionality of the flow of the content for the current element
Valid values are:
|
disabled | false | javax.el.ValueExpression
(must evaluate to boolean )
|
True if control is grayed-out and un-modifiable
If not specified, the default value is "false". |
id | false | java.lang.String | Control identifier |
immediate | false | javax.el.ValueExpression
(must evaluate to boolean )
|
True to process value change listeners in the Apply Request Values phase; false to process in the Process Validations phase
If not specified, the default value is "false". |
label | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| A localized user presentable name for this component. |
lang | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| Specifies the language of the enclosed content |
multiple | false | javax.el.ValueExpression
(must evaluate to boolean )
|
True to allow multiple files to be selected
If not specified, the default value is "false". |
onblur | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| JavaScript "onblur" event handler |
onchange | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| JavaScript "onchange" event handler |
onclick | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| JavaScript "onclick" event handler |
ondblclick | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| JavaScript "ondblclick" event handler |
onfocus | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| JavaScript "onfocus" event handler |
onkeydown | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| JavaScript "onkeydown" event handler |
onkeypress | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| JavaScript "onkeypress" event handler |
onkeyup | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| JavaScript "onkeyup" event handler |
onmousedown | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| JavaScript "onmousedown" event handler |
onmousemove | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| JavaScript "onmousemove" event handler |
onmouseout | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| JavaScript "onmouseout" event handler |
onmouseover | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| JavaScript "onmouseover" event handler |
onmouseup | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| JavaScript "onmouseup" event handler |
onselect | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| JavaScript "onselect" event handler |
readonly | false | javax.el.ValueExpression
(must evaluate to boolean )
|
True if control is un-modifiable
If not specified, the default value is "false". |
rendered | false | javax.el.ValueExpression
(must evaluate to boolean )
|
True to render control; false to ignore it
If not specified, the default value is "true". |
required | false | javax.el.ValueExpression
(must evaluate to boolean )
|
True if user must specify a value for control
If not specified, the default value is "false". |
requiredMessage | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| Will be used as the text of the validation message for the "required" facility, if the "required" facility is used. |
showClearButton | false | javax.el.ValueExpression
(must evaluate to boolean )
|
Show "clear" button in Firefox 3
If not specified, the default value is "true". |
style | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| HTML "style" attribute value |
styleClass | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
|
HTML "class" attribute value
Valid values are:
|
tabindex | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| Order in tab (key) sequence, from 1 to n. Zero adds control to tab sequence, negative integer removes control. |
title | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| HTML "title" attribute value (often displayed as a tooltip) |
useClientSideValidation | false | javax.el.ValueExpression
(must evaluate to boolean )
|
True if client side validation should be attempted (if available) for the control
If not specified, the default value is "true". Valid values are:
|
validator | false | javax.el.MethodExpression
(signature must match void validate(javax.faces.context.FacesContext, javax.faces.component.UIComponent, java.lang.Object) )
| A method binding expression for a method that validates the component local value. |
validatorMessage | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| Will be used as the description of the validator message. |
value | false | javax.el.ValueExpression
(must evaluate to java.lang.Object )
| Control value |
valueChangeListener | false | javax.el.MethodExpression
(signature must match void valueChange(javax.faces.event.ValueChangeEvent) )
| Value change listener method binding |
width | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
|
Pre-defined input width
Valid values are:
|
Output generated by Vdldoc View Declaration Language Documentation Generator.