JavaScript API Reference for Oracle ADF Faces

oracle.adf.view.js.util
Class AdfFileUploadManager

org.ecmascript.object.Object
   |
   +--oracle.adf.view.js.base.AdfObject
         |
         +--oracle.adf.view.js.util.AdfFileUploadManager

public class AdfFileUploadManager
extends AdfObject

_component

private Object _component

EVENT_SOURCE_APPLET

public static Object EVENT_SOURCE_APPLET

EVENT_SOURCE_FALLBACK

public static Object EVENT_SOURCE_FALLBACK

EVENT_SOURCE_QUEUE

public static Object EVENT_SOURCE_QUEUE

EVENT_SOURCE_UPLOAD

public static Object EVENT_SOURCE_UPLOAD

EVENT_STATUS_COMPLETE

public static Object EVENT_STATUS_COMPLETE

EVENT_STATUS_FAILED

public static Object EVENT_STATUS_FAILED

EVENT_STATUS_IN_PROGRESS

public static Object EVENT_STATUS_IN_PROGRESS

EVENT_STATUS_START

public static Object EVENT_STATUS_START

EVENT_TYPE_PROGRESS

public static Object EVENT_TYPE_PROGRESS

EVENT_TYPE_STATE

public static Object EVENT_TYPE_STATE

EVENT_TYPE_STATUS

public static Object EVENT_TYPE_STATUS

OPERATION_ADDED

public static Object OPERATION_ADDED

OPERATION_CANCEL

public static Object OPERATION_CANCEL

OPERATION_CANCEL_ALL

public static Object OPERATION_CANCEL_ALL

OPERATION_DELETE

public static Object OPERATION_DELETE

State constants.

OPERATION_LOAD

public static Object OPERATION_LOAD

OPERATION_UPLOAD

public static Object OPERATION_UPLOAD

AdfFileUploadManager

public AdfFileUploadManager(Object component)

Parameters:

component

addEventListener

public Object addEventListener(Object type,
                               Object listener,
                               Object instance)

Add a File Upload Event listener.

Parameters:

type
listener
instance

Return:

Object

addFileToQueue

public Object addFileToQueue(Object file)

Add a File to the upload queue.

Parameters:

file

Return:

Object

cancelAllUploads

public Object cancelAllUploads()

Cancel all uploads.

Return:

Object

cancelCurrentUpload

public Object cancelCurrentUpload(Object force)

Cancel currently uploading file. If there are more files waiting in the upload queue then those uploads will be continued.

Parameters:

force

Return:

Object

deleteFileFromQueue

public Object deleteFileFromQueue(Object filename)

Delete a file from the upload queue.

Parameters:

filename

Return:

Object

deleteUploadedFile

public Object deleteUploadedFile(Object filename)

Delete an uploaded but unsubmitted file.

Parameters:

filename

Return:

Object

FileItem

protected static Object FileItem(Object itemId,
                                 Object filename,
                                 Object filesize,
                                 Object data,
                                 Object success)

Upload queue and result list item.

Parameters:

itemId
filename
filesize
data
success

Return:

Object

getFileUploadQueue

public Object getFileUploadQueue()

Get the file upload queue. The size of the queue can be determined by checking its length property. Items in the queue can be fetched by calling item(num). The upload queue object is not an Array. It is an immutable list of FileItem objects.

Return:

Object

getFileUploadResults

public Object getFileUploadResults()

Get the uploaded file result list. The size of the queue can be determined by checking its length property. Items in the queue can be fetched by calling item(num). The result list object is not an Array. It is an immutable list of FileItem objects.

Return:

Object

Init

protected Object Init(Object component)

Initializes the instance. Subclasses of AdfObject must call their superclass' Init

Parameters:

component

Return:

Object

Overrides:

AdfObject.Init()

InitClass

protected static Object InitClass()

Return:

Object

isBusy

public Object isBusy()

Indicates whether the component is busy uploading and cannot accepot any other upload requests.

Return:

Object

removeEventListener

public Object removeEventListener(Object type,
                                  Object listener,
                                  Object instance)

Remove a File Upload Event listener.

Parameters:

type
listener
instance

Return:

Object

setFileProperties

public Object setFileProperties(Object filename,
                                Object properties)

Set the properties on a file in the upload queue. Properties are arbitrary String name/value pairs which can be retrieved using the getProperty() method of the UploadedFile object.

Parameters:

filename
properties

Return:

Object

setFileProperty

public Object setFileProperty(Object filename,
                              Object propertyName,
                              Object propertyValue)

Set a property on a file in the upload queue. Properties are arbitrary String name/value pairs which can be retrieved using the getProperty() method of the UploadedFile object.

Parameters:

filename
propertyName
propertyValue

Return:

Object

uploadAllFilesFromQueue

public Object uploadAllFilesFromQueue()

Upload all the files in the upload queue. Files will be uploaded one by one.

Return:

Object

uploadFileFromQueue

public Object uploadFileFromQueue(Object filename)

Upload the specified file from the upload queue.

Parameters:

filename

Return:

Object