[richfaces-planning-issues] [JBoss JIRA] Commented: (RFPL-972) fileUpload: documentation review

[Konstantin Mishin (JIRA)]

    [ https://issues.jboss.org/browse/RFPL-972?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12573267#comment-12573267 ] 

Konstantin Mishin commented on RFPL-972:
----------------------------------------

9.3. <rich:fileUpload>
The <rich:fileUpload> component allows the user to upload files to a server. It features multiple uploads, progress bars, restrictions on file types and sizes to be uploaded.

9.3.1. Basic usage
Basic usage requires the fileUploadListener attribute. Use it to call a function on the server side after each file is uploaded. 
<rich:fileUpload fileUploadListener="#{bean.listener}" />

9.3.2. Interactivity options
Files are uploaded to either the temporary folder (different for each operating system) or to RAM (random-access memory), depending on the value of the org.richfaces.fileUpload.createTempFile context-parameter of  web.xml for the project. 
The <rich:fileUpload> component can place restrictions on the files that can be uploaded. The acceptedTypes attribute restricts the file types to just those listed. The noDuplicate attribute prevents addition of similarly named files. To enforce size restrictions on individual files, set the org.richfaces.fileUpload.maxRequestSize context-parameter of  web.xml for the project. 
The text labels used in the component can be completely customized. Labels for the various controls of the component can be set using addLabel, clearAllLabel, clearLabell, and uploadLabel.

9.3.3. <rich:fileUpload> client-side events
There are a number of event handlers specific to the <rich:fileUpload> component: 
onfilesubmit is triggered before a file is uploaded. 
onuploadcomplete is triggered after all files in the list have finished uploading. 

9.3.4. Reference data
component-type: org.richfaces.FileUpload 
component-class: org.richfaces.component.UIFileUpload
component-family: org.richfaces.FileUpload
renderer-type: org.richfaces.FileUploadRenderer

> fileUpload: documentation review
> --------------------------------
>
>                 Key: RFPL-972
>                 URL: https://issues.jboss.org/browse/RFPL-972
>             Project: RichFaces Planning
>          Issue Type: Task
>      Security Level: Public(Everyone can see) 
>          Components: components, doc
>    Affects Versions: 4.0.0.Milestone5
>            Reporter: Sean Rogers
>            Assignee: Konstantin Mishin
>             Fix For: 4.0.0.CR1
>
>
> Please review the documentation:
> http://docs.jboss.org/richfaces/nightly_4_0_X/Component_Reference/en-US/html_single/#sect-Component_Reference-Rich_inputs-richfileUpload

-- 
This message is automatically generated by JIRA.
-
For more information on JIRA, see: http://www.atlassian.com/software/jira