Child pages
  • JSProgressMonitor

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Rev: 1384958006482
Div
styledisplay:none

DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY (EXCEPT INSIDE THE DIV BELOW WITH ID=DESCRIPTION), UNLESS YOU KNOW WHAT YOU'RE DOING.
THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO AUTO UPDATE THE CONTENT THROUGH THE DOC GENERATOR. Enter additional information related to this 'class' inside the {div} macro with 'id=description'

Div
iddescription



HTML Table
id
classservoy sSummary
Colgroup Tag
Col
width80px
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Method Summary
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
cancel()
Cancels the transfer process.
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
getCurrentBytesToTransfer()
Returns the number of bytes to transfer for the current file.
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
getCurrentFileIndex()
Returns the index of the current file being transferred.
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
getCurrentTransferredBytes()
Returns the number of bytes already transferred for the current file.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
getCurrentTransferredFileName()
Returns the name of the current file being transferred.
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
getTotalBytesToTransfer()
Returns the total bytes to transfer to or from the server (sum of all the files size)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
getTotalFilesToTransfer()
Returns the total number of files to transfer.
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
getTotalTransferredBytes()
Returns the total bytes already transferred (for all files)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
isCanceled()
Returns true if the process was canceled.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
isFinished()
Returns true if the process is finished.
Table Row (tr)
Table Cell (td)
JSProgressMonitor
Table Cell (td)
setProgressCallBack(function, interval)
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.
Table Row (tr)
Table Cell (td)
JSProgressMonitor
Table Cell (td)
setProgressCallBack(function, interval, delay)
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.

...