JavaScript API Reference for Oracle ADF Faces

oracle.adfinternal.view.js.util
Class AdfFileUploadUtils

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

public class AdfFileUploadUtils
extends AdfFileUploadManager

_APPLET_ID

private static Object _APPLET_ID

_authHeader

private Object _authHeader

_AUTHORIZATION_HEADER

private static Object _AUTHORIZATION_HEADER

_clientId

private Object _clientId

_cookies

private Object _cookies

_COOKIES

private static Object _COOKIES

_CSS_PROPERTY_DISPLAY

private static Object _CSS_PROPERTY_DISPLAY

_CSS_PROPERTY_OVERFLOWY

private static Object _CSS_PROPERTY_OVERFLOWY

_CSS_PROPERTY_VISIBILITY

private static Object _CSS_PROPERTY_VISIBILITY

_DELAYED_UPLOAD_CONTENT_ID

private static Object _DELAYED_UPLOAD_CONTENT_ID

State constants.

_DELAYED_UPLOAD_FORM_ID

private static Object _DELAYED_UPLOAD_FORM_ID

_delayedResetInputFileNode

private Object _delayedResetInputFileNode

_FORM_ENCODING

private static Object _FORM_ENCODING

_itemId

private Object _itemId

_MAX_CHUNK_SIZE

private static Object _MAX_CHUNK_SIZE

_maxChunkSize

private Object _maxChunkSize

_MAXIMUM_FILES

private static Object _MAXIMUM_FILES

_maximumFiles

private Object _maximumFiles

_MULTIPART_ENCODING

private static Object _MULTIPART_ENCODING

_MULTIPART_FRAME

private static Object _MULTIPART_FRAME

_MULTIPLE_UPLOAD_CHUNK_COUNT_PARAM

private static Object _MULTIPLE_UPLOAD_CHUNK_COUNT_PARAM

_MULTIPLE_UPLOAD_CHUNK_FILENAME_PARAM

private static Object _MULTIPLE_UPLOAD_CHUNK_FILENAME_PARAM

_MULTIPLE_UPLOAD_CHUNK_NUM_PARAM

private static Object _MULTIPLE_UPLOAD_CHUNK_NUM_PARAM

_MULTIPLE_UPLOAD_FILE_PROPERTY_PARAM

private static Object _MULTIPLE_UPLOAD_FILE_PROPERTY_PARAM

_MULTIPLE_UPLOAD_PARAM

private static Object _MULTIPLE_UPLOAD_PARAM

_peer

private Object _peer

_percentCompleteItems

private Object _percentCompleteItems

_STYLE_DISPLAY_INLINE

private static Object _STYLE_DISPLAY_INLINE

_STYLE_DISPLAY_NONE

private static Object _STYLE_DISPLAY_NONE

_STYLE_VISIBILITY_HIDDEN

private static Object _STYLE_VISIBILITY_HIDDEN

_STYLE_VISIBILITY_VISIBLE

private static Object _STYLE_VISIBILITY_VISIBLE

_UPLOAD_FORM_ID

private static Object _UPLOAD_FORM_ID

_uploadQueue

private Object _uploadQueue

_uploadRequestQueue

private Object _uploadRequestQueue

_uploadResult

private Object _uploadResult

AdfFileUploadUtils

public AdfFileUploadUtils(Object peer,
                          Object component,
                          Object domElement)

Parameters:

peer
component
domElement

addEventListener

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

Add a File Upload Event listener.

Parameters:

type
listener
instance

Return:

Object

Overrides:

AdfFileUploadManager.addEventListener(Object, Object, Object)

_addFileItemToUploadResultList

private Object _addFileItemToUploadResultList(Object fileItem)

Parameters:

fileItem

Return:

Object

addFileToQueue

public Object addFileToQueue(Object file)

Add a File to the upload queue.

Parameters:

file

Return:

Object

Overrides:

AdfFileUploadManager.addFileToQueue(Object)

_addFileToUploadQueue

private Object _addFileToUploadQueue(Object filename,
                                     Object filesize,
                                     Object data,
                                     Object itemId,
                                     Object isAppletUpload)

Parameters:

filename
filesize
data
itemId
isAppletUpload

Return:

Object

addFileUploadQueueItem

public Object addFileUploadQueueItem(Object fileItem)

Parameters:

fileItem

Return:

Object

addFileUploadResultItem

public Object addFileUploadResultItem(Object fileItem)

Parameters:

fileItem

Return:

Object

appletAddFile

public static Object appletAddFile(Object clientId,
                                   Object filename,
                                   Object filesize,
                                   Object itemId)

Parameters:

clientId
filename
filesize
itemId

Return:

Object

appletRequestStatusChanged

public static Object appletRequestStatusChanged(Object clientId,
                                                Object statusCode,
                                                Object responseMessage)

Parameters:

clientId
statusCode
responseMessage

Return:

Object

appletUpdateProgress

public static Object appletUpdateProgress(Object clientId,
                                          Object filename,
                                          Object percentComplete)

Parameters:

clientId
filename
percentComplete

Return:

Object

cancelAllUploads

public Object cancelAllUploads(Object force)

Cancel all uploads.

Parameters:

force

Return:

Object

Overrides:

AdfFileUploadManager.cancelAllUploads()

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

Overrides:

AdfFileUploadManager.cancelCurrentUpload(Object)

_copyAndHideInputNode

private Object _copyAndHideInputNode(Object inputNode)

Parameters:

inputNode

Return:

Object

deleteFileFromQueue

public Object deleteFileFromQueue(Object filename)

Delete a file from the upload queue.

Parameters:

filename

Return:

Object

Overrides:

AdfFileUploadManager.deleteFileFromQueue(Object)

deleteUploadedFile

public Object deleteUploadedFile(Object filename)

Delete an uploaded but unsubmitted file.

Parameters:

filename

Return:

Object

Overrides:

AdfFileUploadManager.deleteUploadedFile(Object)

_deleteUploadedFile

private Object _deleteUploadedFile(Object filename)

Parameters:

filename

Return:

Object

_dtsRequestStatusChanged

private Object _dtsRequestStatusChanged(Object requestEvent)

Parameters:

requestEvent

Return:

Object

_getComponent

private Object _getComponent()

Return:

Object

_getCSSText

private static Object _getCSSText(Object selector)

Parameters:

selector

Return:

Object

_getDataTransferService

private Object _getDataTransferService()

Return:

Object

_getFilename

private static Object _getFilename(Object fullpath)

Parameters:

fullpath

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

Overrides:

AdfFileUploadManager.getFileUploadQueue()

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

Overrides:

AdfFileUploadManager.getFileUploadResults()

_getIframeDoc

private static Object _getIframeDoc()

Return:

Object

_getIframeTransferForm

private static Object _getIframeTransferForm(Object component,
                                             Object encoding,
                                             Object id)

Parameters:

component
encoding
id

Return:

Object

_getItem

private Object _getItem(Object filename)

Parameters:

filename

Return:

Object

_getPopupAncestor

private static Object _getPopupAncestor(Object component)

Parameters:

component

Return:

Object

_getTotalRows

private Object _getTotalRows()

Return:

Object

_getUploadResultItem

private Object _getUploadResultItem(Object itemId)

Parameters:

itemId

Return:

Object

_handleDomChange

private Object _handleDomChange(Object component,
                                Object domEvent)

Parameters:

component
domEvent

Return:

Object

_hideDropArea

private Object _hideDropArea(Object nodeId)

Parameters:

nodeId

Return:

Object

Init

protected Object Init(Object peer,
                      Object component,
                      Object domElement)

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

Parameters:

peer
component
domElement

Return:

Object

Overrides:

AdfObject.Init()

InitClass

protected static Object InitClass()

Return:

Object

Overrides:

AdfFileUploadManager.InitClass()

_initFallbackMode

private Object _initFallbackMode(Object inputId)

Parameters:

inputId

Return:

Object

_initNonAppletMode

private Object _initNonAppletMode()

Return:

Object

_initUploadApplet

private Object _initUploadApplet(Object settings)

Parameters:

settings

Return:

Object

isBusy

public Object isBusy()

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

Return:

Object

Overrides:

AdfFileUploadManager.isBusy()

_isInPopup

private static Object _isInPopup(Object component)

Parameters:

component

Return:

Object

load

public Object load(Object settings)

Parameters:

settings

Return:

Object

_marshallProperties

private static Object _marshallProperties(Object properties)

Parameters:

properties

Return:

Object

_notifyListeners

private Object _notifyListeners(Object type,
                                Object data)

Parameters:

type
data

Return:

Object

_performAutoSubmitCheck

private Object _performAutoSubmitCheck()

Return:

Object

_refreshListFunctions

private Object _refreshListFunctions()

Return:

Object

removeEventListener

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

Remove a File Upload Event listener.

Parameters:

type
listener
instance

Return:

Object

Overrides:

AdfFileUploadManager.removeEventListener(Object, Object, Object)

_removeFileFromUploadQueue

private Object _removeFileFromUploadQueue(Object filename)

Parameters:

filename

Return:

Object

_removeFileItemFromUploadResultList

private Object _removeFileItemFromUploadResultList(Object itemId)

Parameters:

itemId

Return:

Object

_removeIframeTransferForm

private Object _removeIframeTransferForm()

Return:

Object

_requestStatusChanged

private Object _requestStatusChanged(Object statusCode,
                                     Object responseMessage)

Parameters:

statusCode
responseMessage

Return:

Object

_resetInputFileNode

private Object _resetInputFileNode(Object node)

Parameters:

node

Return:

Object

_resetUpload

private Object _resetUpload(Object resetChunk)

Parameters:

resetChunk

Return:

Object

_sendUploadRequest

private Object _sendUploadRequest(Object data,
                                  Object headerParams,
                                  Object params,
                                  Object eventListeners,
                                  Object chunkNum)

Parameters:

data
headerParams
params
eventListeners
chunkNum

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

Overrides:

AdfFileUploadManager.setFileProperty(Object, Object, Object)

unload

public Object unload()

Return:

Object

_updateProgressFunction

private static Object _updateProgressFunction(Object fileUploadUtil,
                                              Object filename,
                                              Object chunkNum,
                                              Object chunkCount)

Parameters:

fileUploadUtil
filename
chunkNum
chunkCount

Return:

Object

uploadAllFilesFromQueue

public Object uploadAllFilesFromQueue()

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

Return:

Object

Overrides:

AdfFileUploadManager.uploadAllFilesFromQueue()

uploadFileFromQueue

public Object uploadFileFromQueue(Object filename)

Upload the specified file from the upload queue.

Parameters:

filename

Return:

Object

Overrides:

AdfFileUploadManager.uploadFileFromQueue(Object)

_uploadFileInQueue

private Object _uploadFileInQueue(Object filename)

Parameters:

filename

Return:

Object

_validateFilename

private Object _validateFilename(Object filename)

Parameters:

filename

Return:

Object

_validateFilesize

private Object _validateFilesize(Object filesize)

Parameters:

filesize

Return:

Object

validateMaxFileSizeMaxDiskSpace

public static Object validateMaxFileSizeMaxDiskSpace(Object component,
                                                     Object fileSize,
                                                     Object totalFileSize,
                                                     Object errorCallBack)

This function will check the following conditions: 1) Ensure that fileSize is smaller than the MAX_FILE_SIZE [if provided] 2) Ensure that totalFileSize is smaller than MAX_DISK_SPACE If either 1 or 2 are invalid, then it will: 1) Create the necessary AdfFacesMessage and invoke errorCallBack with it 2) Set the component to be invalid 3) And return false from the function

Parameters:

component
fileSize
totalFileSize
errorCallBack

Return:

Object