Page History

...

Table Cell (td)
Number

...

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'

Divcache

styleindex	display:none

...

id	description

...

padding	0px
width	80px

...

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Summary

Table Row (tr)

Table Cell (td)
Boolean

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

true
refresh	100d
showRefresh	true
id	doc
title	Refresh page
showDate	true
retry	Enable

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.

...

Table Cell (td)
Number

...

Returns the index of the current file being transferred.

...

Table Cell (td)
Number

...

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

...

Table Cell (td)
String

...

Returns the name of the current file being transferred.

...

Table Cell (td)
Number

...

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

...

Table Cell (td)
Number

...

)

...

Returns the total number of files to transfer.

...

Table Cell (td)
Number

...

Returns the total bytes already transferred (for all files)

...

Table Cell (td)
Boolean

...

Returns true if the process was canceled.

...

Table Cell (td)
Boolean

Returns true if the process is finished.

...

Table Cell (td)
JSProgressMonitor

...

Table Cell (td)
JSProgressMonitor

...

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.

...

function

...

servoy sDetail

...

padding	0px
width	100%

...

2100%

height:30px

...

Table Head (th)

colspan	1

Method Details

...

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

...

class	lastDetailRow

...

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

...

class	lastDetailRow

...

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

...

class	lastDetailRow

...

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

...

class	lastDetailRow

...

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

...

class	lastDetailRow

...

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

...

class	lastDetailRow

...

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

...

class	lastDetailRow

...

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

...

class	lastDetailRow

...

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

...

class	lastDetailRow

...

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

...

class	lastDetailRow

...

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

...

class	lastDetailRow

...

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

...

class	lastDetailRow

...

2

Methods Details

cancel

name

cancel()

des

sIndent

Cancels the transfer process.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getCurrentBytesToTransfer

name

getCurrentBytesToTransfer()

des

sIndent

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getCurrentFileIndex

name

getCurrentFileIndex()

des

sIndent

Returns the index of the current file being transferred.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getCurrentTransferredBytes

name

getCurrentTransferredBytes()

des

sIndent

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getCurrentTransferredFileName

name

getCurrentTransferredFileName()

des

sIndent

Returns the name of the current file being transferred.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getTotalBytesToTransfer

name

getTotalBytesToTransfer()

des

sIndent

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getTotalFilesToTransfer

name

getTotalFilesToTransfer()

des

sIndent

Returns the total number of files to transfer.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getTotalTransferredBytes

name

getTotalTransferredBytes()

des

sIndent

Returns the total bytes already transferred (for all files)

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

isCanceled

name

isCanceled()

des

sIndent

Returns true if the process was canceled.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

isFinished

name

isFinished()

des

sIndent

Returns true if the process is finished.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

setProgressCallBack

name

setProgressCallBack(function, interval)

des

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).

prs

Parameters

sIndent

function

the Function to call back at the specified interval

interval

the interval (in seconds) to use

ret

Returns

sIndent

this for chaining

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

setProgressCallBack

name

setProgressCallBack(function, interval, delay)

des

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).

prs

Parameters

sIndent

function

the Function to call back at the specified interval

interval

the interval (in seconds) to use

delay

adds a delay for testing purpose in Developer

ret

Returns

sIndent

this for chaining

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

Child pages

Versions Compared

Old Version 11

New Version Current

Key

cancel

getCurrentBytesToTransfer

getCurrentFileIndex

getCurrentTransferredBytes

getCurrentTransferredFileName

getTotalBytesToTransfer

getTotalFilesToTransfer

getTotalTransferredBytes

isCanceled

isFinished

setProgressCallBack

setProgressCallBack

cancel()

getCurrentBytesToTransfer()

getCurrentFileIndex()

getCurrentTransferredBytes()

getCurrentTransferredFileName()

getTotalBytesToTransfer()

getTotalFilesToTransfer()

getTotalTransferredBytes()

isCanceled()

isFinished()

setProgressCallBack(function, interval)

setProgressCallBack(function, interval, delay)