A control that enables a user to upload a file via drag and drop. 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>javax.servlet.http.Part<
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.
Info | Value |
---|---|
Component Type | com.webmethods.caf.faces.input.dnd.File |
Handler Class | com.webmethods.caf.faces.component.input.DragAndDropFileInputHandler |
Renderer Type | com.webmethods.caf.faces.input.dnd.File |
Description | Allows user to upload files via drag and drop |
Palette Location | CAF Html/Control/Input/Drag And Drop File Input |
Client-Side Model | CAF.Input.File.DnD.Model |
Name | Required | Type | Description |
---|---|---|---|
action | false | javax.el.MethodExpression
(signature must match java.lang.Object action() )
| MethodExpression representing the application action to invoke when this component is activated by the user. The expression must evaluate to a public method that takes no parameters, and returns an Object (the toString() of which is called to derive the logical outcome) which is passed to the NavigationHandler for this application. |
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:
|
execute | false | javax.el.ValueExpression
(must evaluate to java.lang.Object )
|
Evaluates to Collection<String>. This is a space separated list of client ids of components that will participate in the "execute" portion of the Request Processing Lifecycle. If a literal is specified the ids must be space delimited. Any of the keywords "@this", "@form", "@all", "@none" may be specified in the id list. If not specified, the default value of "@this" is assumed. For example, @this clientIdOne clientIdTwo.
Valid values are:
|
id | false | java.lang.String | Control identifier |
immediate | false | javax.el.ValueExpression
(must evaluate to boolean )
|
True to process action listeners in the Apply Request Values phase; false to process in the Invoke Application 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 |
listener | false | javax.el.MethodExpression
(signature must match void processAjaxBehavior(javax.faces.event.AjaxBehaviorEvent) )
| Method expression referencing a method that will be called when an AjaxBehaviorEvent has been broadcast for the listener. |
multiple | false | javax.el.ValueExpression
(must evaluate to boolean )
|
True to allow multiple files to be selected
If not specified, the default value is "true". |
onerror | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| The name of the JavaScript function that will handle errors. |
render | false | javax.el.ValueExpression
(must evaluate to java.lang.Object )
|
Evaluates to Collection<String>. The clientIds of components that will participate in the "render" portion of the Request Processing Lifecycle. If a literal is specified the identifiers must be space delimited. Any of the keywords "@this", "@form", "@all", "@none" may be specified in the identifier list. If not specified, the default value of "@none" is assumed. For example, @this clientIdOne clientIdTwo.
Valid values are:
|
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". |
resetValues | false | javax.el.ValueExpression
(must evaluate to boolean )
| If true, indicate that this particular Ajax transaction is a value reset transaction. This will cause resetValue() to be called on any EditableValueHolder instances encountered as a result of this ajax transaction. If not specified, or the value is false, no such indication is made. |
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:
|
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 |
Output generated by Vdldoc View Declaration Language Documentation Generator.