Child pages
  • JSProgressMonitor

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin
{div:style=}
Wiki Markup
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



Enter additional information related to this 'class'

inside

the

\

{div}

macro

with

'id=description'

{div} {div:id=description}{div}\\ {table:id=|class=servoy sSummary}{colgroup}{column:width=80px|padding=0px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Method Summary{th}{tr}{tbody}{tr}{td}[Boolean]{td}{td}[#cancel]\() Cancels the transfer process.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#getCurrentBytesToTransfer]\() Returns the number of bytes to transfer for the current file.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#getCurrentFileIndex]\() Returns the index of the current file being transferred.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#getCurrentTransferredBytes]\() Returns the number of bytes already transferred for the current file.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#getCurrentTransferredFileName]\() Returns the name of the current file being transferred.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#getTotalBytesToTransfer]\() Returns the total bytes to transfer to or from the server (sum of all the files size){td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#getTotalFilesToTransfer]\() Returns the total number of files to transfer.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#getTotalTransferredBytes]\() Returns the total bytes already transferred (for all files){td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#isCanceled]\() Returns true if the process was canceled.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#isFinished]\() Returns true if the process is finished.{td}{tr}{tbody}{tbody}{tr}{td}[JSProgressMonitor]{td}{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.{td}{tr}{tbody}{tbody}{tr}{td}[JSProgressMonitor]{td}{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.{td}{tr}{tbody}{table}\\ {table:id=function|class=servoy sDetail}{colgroup}{column:width=100%|padding=0px}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Method Details{th}{tr}{tbody:id=cancel}{tr:id=name}{td}h6.cancel{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Boolean]{span}{span:style=font-weight: bold;}cancel{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Cancels the transfer process.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} monitor.cancel(); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getCurrentBytesToTransfer}{tr:id=name}{td}h6.getCurrentBytesToTransfer{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Number]{span}{span:style=font-weight: bold;}getCurrentBytesToTransfer{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Returns the number of bytes to transfer for the current file.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

Div
iddescription


HTML Table
id
classservoy sSummary
Colgroup Tag
Column
padding0px
width80px

Column

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Method Summary
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#cancel()
Cancels the transfer process.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#getCurrentBytesToTransfer()
Returns the number of bytes to transfer for the current file.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#getCurrentFileIndex()
Returns the index of the current file being transferred.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#getCurrentTransferredBytes()
Returns the number of bytes already transferred for the current file.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#getCurrentTransferredFileName()
Returns the name of the current file being transferred.
Table Body (tbody)
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 Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#getTotalFilesToTransfer()
Returns the total number of files to transfer.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#getTotalTransferredBytes()
Returns the total bytes already transferred (for all files)
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#isCanceled()
Returns true if the process was canceled.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#isFinished()
Returns true if the process is finished.
Table Body (tbody)
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 Body (tbody)
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.

HTML Table
idfunction
classservoy sDetail
Colgroup Tag
Column
padding0px
width100%

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan1
Method Details
Table Body (tbody)
idcancel
Table Row (tr)
idname
Table Cell (td)
cancel
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
cancel
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Cancels the transfer process.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Boolean
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

monitor.cancel();
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetCurrentBytesToTransfer
Table Row (tr)
idname
Table Cell (td)
getCurrentBytesToTransfer
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Number
Span
stylefont-weight: bold;
getCurrentBytesToTransfer
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns the number of bytes to transfer for the current file.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Number
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

application.output('total transferred: ' + monitor.getTotalTransferredBytes() + ' / ' + monitor.getTotalBytesToTransfer());
application.output('current file: ' + monitor.getCurrentTransferredFileName() + ' ( ' + monitor.getCurrentFileIndex() + ' / ' + monitor.getTotalFilesToTransfer() + ' )');
application.output('current bytes transferred: '+monitor.getCurrentTransferredBytes() + ' / ' + monitor.getCurrentBytesToTransfer());
if (monitor.isCanceled()) {
	application.output('canceled!')
}
if (monitor.isFinished()) {
	application.output('finished!')
}
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getCurrentFileIndex}{tr:id=name}{td}h6.getCurrentFileIndex{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Number]{span}{span:style=font-weight: bold;}getCurrentFileIndex{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Returns the index of the current file being transferred.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetCurrentFileIndex
Table Row (tr)
idname
Table Cell (td)
getCurrentFileIndex
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Number
Span
stylefont-weight: bold;
getCurrentFileIndex
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns the index of the current file being transferred.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Number
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

application.output('total transferred: ' + monitor.getTotalTransferredBytes() + ' / ' + monitor.getTotalBytesToTransfer());
application.output('current file: ' + monitor.getCurrentTransferredFileName() + ' ( ' + monitor.getCurrentFileIndex() + ' / ' + monitor.getTotalFilesToTransfer() + ' )');
application.output('current bytes transferred: '+monitor.getCurrentTransferredBytes() + ' / ' + monitor.getCurrentBytesToTransfer());
if (monitor.isCanceled()) {
	application.output('canceled!')
}
if (monitor.isFinished()) {
	application.output('finished!')
}
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getCurrentTransferredBytes}{tr:id=name}{td}h6.getCurrentTransferredBytes{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Number]{span}{span:style=font-weight: bold;}getCurrentTransferredBytes{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Returns the number of bytes already transferred for the current file.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetCurrentTransferredBytes
Table Row (tr)
idname
Table Cell (td)
getCurrentTransferredBytes
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Number
Span
stylefont-weight: bold;
getCurrentTransferredBytes
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns the number of bytes already transferred for the current file.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Number
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

application.output('total transferred: ' + monitor.getTotalTransferredBytes() + ' / ' + monitor.getTotalBytesToTransfer());
application.output('current file: ' + monitor.getCurrentTransferredFileName() + ' ( ' + monitor.getCurrentFileIndex() + ' / ' + monitor.getTotalFilesToTransfer() + ' )');
application.output('current bytes transferred: '+monitor.getCurrentTransferredBytes() + ' / ' + monitor.getCurrentBytesToTransfer());
if (monitor.isCanceled()) {
	application.output('canceled!')
}
if (monitor.isFinished()) {
	application.output('finished!')
}
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getCurrentTransferredFileName}{tr:id=name}{td}h6.getCurrentTransferredFileName{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}getCurrentTransferredFileName{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Returns the name of the current file being transferred.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetCurrentTransferredFileName
Table Row (tr)
idname
Table Cell (td)
getCurrentTransferredFileName
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
getCurrentTransferredFileName
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns the name of the current file being transferred.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

application.output('total transferred: ' + monitor.getTotalTransferredBytes() + ' / ' + monitor.getTotalBytesToTransfer());
application.output('current file: ' + monitor.getCurrentTransferredFileName() + ' ( ' + monitor.getCurrentFileIndex() + ' / ' + monitor.getTotalFilesToTransfer() + ' )');
application.output('current bytes transferred: '+monitor.getCurrentTransferredBytes() + ' / ' + monitor.getCurrentBytesToTransfer());
if (monitor.isCanceled()) {
	application.output('canceled!')
}
if (monitor.isFinished()) {
	application.output('finished!')
}
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getTotalBytesToTransfer}{tr:id=name}{td}h6.getTotalBytesToTransfer{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Number]{span}{span:style=font-weight: bold;}getTotalBytesToTransfer{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Returns the total bytes to transfer to or from the server (sum of all the files size){div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetTotalBytesToTransfer
Table Row (tr)
idname
Table Cell (td)
getTotalBytesToTransfer
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Number
Span
stylefont-weight: bold;
getTotalBytesToTransfer
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns the total bytes to transfer to or from the server (sum of all the files size)
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Number
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

application.output('total transferred: ' + monitor.getTotalTransferredBytes() + ' / ' + monitor.getTotalBytesToTransfer());
application.output('current file: ' + monitor.getCurrentTransferredFileName() + ' ( ' + monitor.getCurrentFileIndex() + ' / ' + monitor.getTotalFilesToTransfer() + ' )');
application.output('current bytes transferred: '+monitor.getCurrentTransferredBytes() + ' / ' + monitor.getCurrentBytesToTransfer());
if (monitor.isCanceled()) {
	application.output('canceled!')
}
if (monitor.isFinished()) {
	application.output('finished!')
}
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getTotalFilesToTransfer}{tr:id=name}{td}h6.getTotalFilesToTransfer{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Number]{span}{span:style=font-weight: bold;}getTotalFilesToTransfer{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Returns the total number of files to transfer.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetTotalFilesToTransfer
Table Row (tr)
idname
Table Cell (td)
getTotalFilesToTransfer
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Number
Span
stylefont-weight: bold;
getTotalFilesToTransfer
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns the total number of files to transfer.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Number
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

application.output('total transferred: ' + monitor.getTotalTransferredBytes() + ' / ' + monitor.getTotalBytesToTransfer());
application.output('current file: ' + monitor.getCurrentTransferredFileName() + ' ( ' + monitor.getCurrentFileIndex() + ' / ' + monitor.getTotalFilesToTransfer() + ' )');
application.output('current bytes transferred: '+monitor.getCurrentTransferredBytes() + ' / ' + monitor.getCurrentBytesToTransfer());
if (monitor.isCanceled()) {
	application.output('canceled!')
}
if (monitor.isFinished()) {
	application.output('finished!')
}
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getTotalTransferredBytes}{tr:id=name}{td}h6.getTotalTransferredBytes{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Number]{span}{span:style=font-weight: bold;}getTotalTransferredBytes{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Returns the total bytes already transferred (for all files){div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetTotalTransferredBytes
Table Row (tr)
idname
Table Cell (td)
getTotalTransferredBytes
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Number
Span
stylefont-weight: bold;
getTotalTransferredBytes
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns the total bytes already transferred (for all files)
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Number
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

application.output('total transferred: ' + monitor.getTotalTransferredBytes() + ' / ' + monitor.getTotalBytesToTransfer());
application.output('current file: ' + monitor.getCurrentTransferredFileName() + ' ( ' + monitor.getCurrentFileIndex() + ' / ' + monitor.getTotalFilesToTransfer() + ' )');
application.output('current bytes transferred: '+monitor.getCurrentTransferredBytes() + ' / ' + monitor.getCurrentBytesToTransfer());
if (monitor.isCanceled()) {
	application.output('canceled!')
}
if (monitor.isFinished()) {
	application.output('finished!')
}
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=isCanceled}{tr:id=name}{td}h6.isCanceled{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Boolean]{span}{span:style=font-weight: bold;}isCanceled{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Returns true if the process was canceled.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idisCanceled
Table Row (tr)
idname
Table Cell (td)
isCanceled
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
isCanceled
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns true if the process was canceled.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Boolean
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

application.output('total transferred: ' + monitor.getTotalTransferredBytes() + ' / ' + monitor.getTotalBytesToTransfer());
application.output('current file: ' + monitor.getCurrentTransferredFileName() + ' ( ' + monitor.getCurrentFileIndex() + ' / ' + monitor.getTotalFilesToTransfer() + ' )');
application.output('current bytes transferred: '+monitor.getCurrentTransferredBytes() + ' / ' + monitor.getCurrentBytesToTransfer());
if (monitor.isCanceled()) {
	application.output('canceled!')
}
if (monitor.isFinished()) {
	application.output('finished!')
}
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=isFinished}{tr:id=name}{td}h6.isFinished{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Boolean]{span}{span:style=font-weight: bold;}isFinished{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Returns true if the process is finished.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idisFinished
Table Row (tr)
idname
Table Cell (td)
isFinished
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
isFinished
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns true if the process is finished.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Boolean
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

application.output('total transferred: ' + monitor.getTotalTransferredBytes() + ' / ' + monitor.getTotalBytesToTransfer());
application.output('current file: ' + monitor.getCurrentTransferredFileName() + ' ( ' + monitor.getCurrentFileIndex() + ' / ' + monitor.getTotalFilesToTransfer() + ' )');
application.output('current bytes transferred: '+monitor.getCurrentTransferredBytes() + ' / ' + monitor.getCurrentBytesToTransfer());
if (monitor.isCanceled()) {
	application.output('canceled!')
}
if (monitor.isFinished()) {
	application.output('finished!')
}
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idsetProgressCallBack-Function_Number
}{
Table Row (tr)
:
id
=
name
}{td}h6.setProgressCallBack{td}{tr}{tr:id=sig}{td}{span:style=
Table Cell (td)
setProgressCallBack
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right:
5px;
}[
JSProgressMonitor
]{span}{span:style=
Span
stylefont-weight:
bold;
}
setProgressCallBack
{span}{span}\
Span
(function,
interval)
{span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}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).{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Function]} function -- the Function to call back at the specified interval \{[Number]} interval -- the interval (in seconds) to use {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[JSProgressMonitor] -- this for chaining{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
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).
Table Row (tr)
idprs
Table Cell (td)
Parameters
Div
classsIndent
{Function} function – the Function to call back at the specified interval
{Number} interval – the interval (in seconds) to use
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
JSProgressMonitor – this for chaining
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

// call the progressCallbackFuntion every 2 and a half seconds (with a delay of 200ms in developer):
monitor.setProgressCallBack(progressCallbackFunction, 2.5, (application.isInDeveloper() ? 200 : 0));
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idsetProgressCallBack-Function_Number_Number
}{
Table Row (tr)
:
id
=
name
}{td}h6.setProgressCallBack{td}{tr}{tr:id=sig}{td}{span:style=
Table Cell (td)
setProgressCallBack
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right:
5px;
}[
JSProgressMonitor
]{span}{span:style=
Span
stylefont-weight:
bold;
}
setProgressCallBack
{span}{span}\
Span
(function,
interval,
delay)
{span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}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).{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Function]} function -- the Function to call back at the specified interval \{[Number]} interval -- the interval (in seconds) to use \{[Number]} delay -- adds a delay for testing purpose in Developer {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[JSProgressMonitor] -- this for chaining{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
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).
Table Row (tr)
idprs
Table Cell (td)
Parameters
Div
classsIndent
{Function} function – the Function to call back at the specified interval
{Number} interval – the interval (in seconds) to use
{Number} delay – adds a delay for testing purpose in Developer
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
JSProgressMonitor – this for chaining
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

// call the progressCallbackFuntion every 2 and a half seconds (with a delay of 200ms in developer):
monitor.setProgressCallBack(progressCallbackFunction, 2.5, (application.isInDeveloper() ? 200 : 0));
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}
Table Row (tr)
classlastDetailRow
Table Cell (td)