Page History

Hidden

DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY, UNLESS YOU KNOW WHAT YOU'RE DOING.
		THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO EXTRACT CHANGES FROM THE PAGE AND MERGE THEM BACK INTO SERVOY SOURCE

HTML Table

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() 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(progressCallbackFunction, interval, [testDelay]) 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
class	node

Table Row (tr)

id	name

Table Cell (td)
cancel

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Boolean

Span

style	float: left; font-weight: bold;
id	iets

cancel

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
Cancels the transfer process.

Table Row (tr)

id	ret

Table Cell (td)
Returns 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
class	node

Table Row (tr)

id	name

Table Cell (td)
getCurrentBytesToTransfer

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Number

Span

style	float: left; font-weight: bold;
id	iets

getCurrentBytesToTransfer

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

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

Table Row (tr)

id	ret

Table Cell (td)
Returns 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
class	node

Table Row (tr)

id	name

Table Cell (td)
getCurrentFileIndex

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Number

Span

style	float: left; font-weight: bold;
id	iets

getCurrentFileIndex

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

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

Table Row (tr)

id	ret

Table Cell (td)
Returns 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
class	node

Table Row (tr)

id	name

Table Cell (td)
getCurrentTransferredBytes

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Number

Span

style	float: left; font-weight: bold;
id	iets

getCurrentTransferredBytes

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
Returns the number of bytes already transferred for the current file.

Table Row (tr)

id	ret

Table Cell (td)
Returns 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
class	node

Table Row (tr)

id	name

Table Cell (td)
getCurrentTransferredFileName

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

String

Span

style	float: left; font-weight: bold;
id	iets

getCurrentTransferredFileName

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
Returns the name of the current file being transferred.

Table Row (tr)

id	ret

Table Cell (td)
Returns 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
class	node

Table Row (tr)

id	name

Table Cell (td)
getTotalBytesToTransfer

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Number

Span

style	float: left; font-weight: bold;
id	iets

getTotalBytesToTransfer

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
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 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
class	node

Table Row (tr)

id	name

Table Cell (td)
getTotalFilesToTransfer

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Number

Span

style	float: left; font-weight: bold;
id	iets

getTotalFilesToTransfer

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
Returns the total number of files to transfer.

Table Row (tr)

id	ret

Table Cell (td)
Returns 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
class	node

Table Row (tr)

id	name

Table Cell (td)
getTotalTransferredBytes

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Number

Span

style	float: left; font-weight: bold;
id	iets

getTotalTransferredBytes

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

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

Table Row (tr)

id	ret

Table Cell (td)
Returns 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
class	node

Table Row (tr)

id	name

Table Cell (td)
isCanceled

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Boolean

Span

style	float: left; font-weight: bold;
id	iets

isCanceled

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

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

Table Row (tr)

id	ret

Table Cell (td)
Returns 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
class	node

Table Row (tr)

id	name

Table Cell (td)
isFinished

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Boolean

Span

style	float: left; font-weight: bold;
id	iets

isFinished

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

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

Table Row (tr)

id	ret

Table Cell (td)
Returns 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
class	node

Table Row (tr)

id	name

Table Cell (td)
setProgressCallBack

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

JSProgressMonitor

Span

style	float: left; font-weight: bold;
id	iets

setProgressCallBack

Span

style	float: left;
id	iets

(progressCallbackFunction, interval, [testDelay])

Table Row (tr)

id	des

Table Cell (td)
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 progressCallbackFunction interval [testDelay]

Table Row (tr)

id	ret

Table Cell (td)
Returns JSProgressMonitor

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 16

New Version Current

Key

cancel

getCurrentBytesToTransfer

getCurrentFileIndex

getCurrentTransferredBytes

getCurrentTransferredFileName

getTotalBytesToTransfer

getTotalFilesToTransfer

getTotalTransferredBytes

isCanceled

isFinished

setProgressCallBack