Page History

...

HTML Table

id
class	servoy sSummary

Colgroup Tag

Column

padding	0px
width	80px

Column

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Summary

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#cancel cancel() Cancels the transfer process.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#getCurrentBytesToTransfer getCurrentBytesToTransfer() Returns the number of bytes to transfer for the current file.

tbody

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#getCurrentFileIndex getCurrentFileIndex() Returns the index of the current file being transferred.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#getCurrentTransferredBytes 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 getCurrentTransferredFileName() Returns the name of the current file being transferred.

tbody

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#getTotalBytesToTransfer 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 getTotalFilesToTransfer() Returns the total number of files to transfer.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#getTotalTransferredBytes getTotalTransferredBytes() Returns the total bytes already transferred (for all files)

tbody

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#isCanceled isCanceled() Returns true if the process was canceled.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#isFinished isFinished() Returns true if the process is finished.

tbody

Table Body (tbody)

Table Row (tr)

Table Cell (td)
JSProgressMonitor

Table Cell (td)
#setProgressCallBack 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 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

id	function
class	servoy sDetail

Colgroup Tag

Column

padding	0px
width	100%

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	1

Method Details

Table Body (tbody)

id	cancel

Table Row (tr)

id	name

Table Cell (td)
cancel

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

cancel

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Cancels the transfer process.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

...

monitor.cancel();

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getCurrentBytesToTransfer

Table Row (tr)

id	name

Table Cell (td)
getCurrentBytesToTransfer

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Number

Span

style	font-weight: bold;

getCurrentBytesToTransfer

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

...

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!')
}

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getCurrentFileIndex

Table Row (tr)

id	name

Table Cell (td)
getCurrentFileIndex

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Number

Span

style	font-weight: bold;

getCurrentFileIndex

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns the index of the current file being transferred.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

...

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!')
}

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getCurrentTransferredBytes

Table Row (tr)

id	name

Table Cell (td)
getCurrentTransferredBytes

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Number

Span

style	font-weight: bold;

getCurrentTransferredBytes

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

...

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!')
}

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getCurrentTransferredFileName

Table Row (tr)

id	name

Table Cell (td)
getCurrentTransferredFileName

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

getCurrentTransferredFileName

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns the name of the current file being transferred.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

...

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!')
}

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getTotalBytesToTransfer

Table Row (tr)

id	name

Table Cell (td)
getTotalBytesToTransfer

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Number

Span

style	font-weight: bold;

getTotalBytesToTransfer

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

...

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!')
}

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getTotalFilesToTransfer

Table Row (tr)

id	name

Table Cell (td)
getTotalFilesToTransfer

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Number

Span

style	font-weight: bold;

getTotalFilesToTransfer

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns the total number of files to transfer.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

...

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!')
}

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getTotalTransferredBytes

Table Row (tr)

id	name

Table Cell (td)
getTotalTransferredBytes

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Number

Span

style	font-weight: bold;

getTotalTransferredBytes

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns the total bytes already transferred (for all files)

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

...

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!')
}

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	isCanceled

Table Row (tr)

id	name

Table Cell (td)
isCanceled

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

isCanceled

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns true if the process was canceled.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

...

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!')
}

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	isFinished

Table Row (tr)

id	name

Table Cell (td)
isFinished

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

isFinished

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns true if the process is finished.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

...

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!')
}

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	setProgressCallBack-Function_Number

Table Row (tr)

id	name

Table Cell (td)
setProgressCallBack

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSProgressMonitor

Span

style	font-weight: bold;

setProgressCallBack

Span
(function, interval)

Table Row (tr)

id	des

Table Cell (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).

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Function} function

...

- the Function to call back at the specified interval
{Number} interval

...

- the interval (in seconds) to use

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSProgressMonitor

...

- this for chaining

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

...

// 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));

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	setProgressCallBack-Function_Number_Number

Table Row (tr)

id	name

Table Cell (td)
setProgressCallBack

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSProgressMonitor

Span

style	font-weight: bold;

setProgressCallBack

Span
(function, interval, delay)

Table Row (tr)

id	des

Table Cell (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).

Table Row (tr)

id	prs

Table Cell (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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSProgressMonitor

...

- this for chaining

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

...

// 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));

...

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Child pages

Versions Compared

Old Version 10

New Version 11

Key

cancel

getCurrentBytesToTransfer

getCurrentFileIndex

getCurrentTransferredBytes

getCurrentTransferredFileName

getTotalBytesToTransfer

getTotalFilesToTransfer

getTotalTransferredBytes

isCanceled

isFinished

setProgressCallBack

setProgressCallBack