Child pages
  • JSProgressMonitor

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Cache
indextrue
refresh100d
showRefreshtrue
iddoc
titleRefresh page
showDatetrue
retryEnable

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClient

servoy sSummary12%30%58%height: 30px;3Methods SummaryCancels the transfer process.Returns the number of bytes to transfer for the current file.Returns the index of the current file being transferred.Returns the number of bytes already transferred for the current file.Returns the name of the current file being transferred.Returns the total bytes to transfer to or from the server (sum of all the files size)Returns the total number of files to transfer.Returns the total bytes already transferred (for all files)Returns true if the process was canceled.Returns true if the process is finished.Sets a method to be called repeatedly at the given interval (in seconds), the method will receive an instance of this JSProgressMonitor updated with the latest values.Sets a method to be called repeatedly at the given interval (in seconds), the method will receive an instance of this JSProgressMonitor updated with the latest values.

functionservoy sDetail2100%height:30px2Methods Detailscancelname

cancel()

dessIndent
Cancels the transfer process.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRowgetCurrentBytesToTransfername

getCurrentBytesToTransfer()

dessIndent
Returns the number of bytes to transfer for the current file.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getCurrentFileIndexname

getCurrentFileIndex()

dessIndent
Returns the index of the current file being transferred.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getCurrentTransferredBytesname

getCurrentTransferredBytes()

dessIndent
Returns the number of bytes already transferred for the current file.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getCurrentTransferredFileNamename

getCurrentTransferredFileName()

dessIndent
Returns the name of the current file being transferred.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getTotalBytesToTransfername

getTotalBytesToTransfer()

dessIndent
Returns the total bytes to transfer to or from the server (sum of all the files size)
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getTotalFilesToTransfername

getTotalFilesToTransfer()

dessIndent
Returns the total number of files to transfer.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getTotalTransferredBytesname

getTotalTransferredBytes()

dessIndent
Returns the total bytes already transferred (for all files)
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
isCanceledname

isCanceled()

dessIndent
Returns true if the process was canceled.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
isFinishedname

isFinished()

dessIndent
Returns true if the process is finished.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
setProgressCallBackname

setProgressCallBack(function, interval)

dessIndent
Sets a method to be called repeatedly at the given interval (in seconds), the method will receive an instance of this JSProgressMonitor updated with the latest values. Can use an optional delay (for testing purpose in developer).
prs

Parameters

sIndentfunctionthe Function to call back at the specified intervalintervalthe interval (in seconds) to use
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
setProgressCallBackname

setProgressCallBack(function, interval, delay)

dessIndent
Sets a method to be called repeatedly at the given interval (in seconds), the method will receive an instance of this JSProgressMonitor updated with the latest values. Can use an optional delay (for testing purpose in developer).
prs

Parameters

sIndentfunctionthe Function to call back at the specified intervalintervalthe interval (in seconds) to usedelayadds a delay for testing purpose in Developer
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow