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

History is a stack of form names that were visible on the screen ordered by appearance. The first/oldest item is stored in position/index 1.

Each container (the main application window or dialogs showing forms) has its own history stack. When the History object is accessed from within scripting, the methods of the History object will work with the history stack for the active container.

Only main forms ( currentcontroller) will be stored in History, so not forms displayed in tabpanels or splitpanes.

The history has a maximum size of 10 entries. When the maximum size is reached, the oldest entries are automatically removed to make place for new entries.

HTML Table

class	servoy sSummery

Colgroup Tag

Column

padding	0px
width	80px

Column

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Property Summery

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#buttonsEnabled Set/Get the history buttons enabled.

HTML Table

class	servoy sSummery

Colgroup Tag

Column

padding	0px
width	80px

Column

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Summery

Table Body (tbody)

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
#back() Navigates back in the history stack; shows the previous form (if present).

Table Body (tbody)

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
#clear() Clear the entire history stack.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
#forward() Navigates forward in the history stack; shows the next form (if present).

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#getCurrentIndex() Get the current absolute index in the history stack.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#getFormName(i) Get the form name based on the specified absolute index in the history stack location.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
#go(i) Navigates to the relative index based on current position in the history.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#removeForm(formName) Removes the named form item from the history stack (and from memory) if not currently shown.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#removeIndex(index) Removes an absolute index based history stack form item.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#size() Returns the total size of the history stack.

HTML Table

id	property
class	servoy sDetail

Colgroup Tag

Column

padding	0px
width	100%

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	1

Property Details

Table Body (tbody)

id	buttonsEnabled
class	node

Table Row (tr)

id	name

Table Cell (td)
buttonsEnabled

Table Row (tr)

id	des

Table Cell (td)
Set/Get the history buttons enabled.

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

history.buttonsEnabled = true;
var status = history.buttonsEnabled;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

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	back
class	node

Table Row (tr)

id	name

Table Cell (td)
back

Table Row (tr)

id	sig

Table Cell (td)

Span

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

void

Span

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

back

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
Navigates back in the history stack; shows the previous form (if present).

Table Row (tr)

id	ret

Table Cell (td)
Returns void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

history.back();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	clear
class	node

Table Row (tr)

id	name

Table Cell (td)
clear

Table Row (tr)

id	sig

Table Cell (td)

Span

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

void

Span

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

clear

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
Clear the entire history stack.

Table Row (tr)

id	ret

Table Cell (td)
Returns void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

history.clear();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	forward
class	node

Table Row (tr)

id	name

Table Cell (td)
forward

Table Row (tr)

id	sig

Table Cell (td)

Span

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

void

Span

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

forward

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
Navigates forward in the history stack; shows the next form (if present).

Table Row (tr)

id	ret

Table Cell (td)
Returns void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

history.forward();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getCurrentIndex
class	node

Table Row (tr)

id	name

Table Cell (td)
getCurrentIndex

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

getCurrentIndex

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
Get the current absolute index in the history stack.

Table Row (tr)

id	ret

Table Cell (td)
Returns Number – the current absolute index

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var abs_index = history.getCurrentIndex();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getFormName
class	node

Table Row (tr)

id	name

Table Cell (td)
getFormName

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

getFormName

Span

style	float: left;
id	iets

(i)

Table Row (tr)

id	des

Table Cell (td)
Get the form name based on the specified absolute index in the history stack location.

Table Row (tr)

id	prs

Table Cell (td)
Parameters {Number} i – the absolute index

Table Row (tr)

id	ret

Table Cell (td)
Returns String – the formName

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var name = history.getFormName(history.getCurrentIndex());

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	go
class	node

Table Row (tr)

id	name

Table Cell (td)
go

Table Row (tr)

id	sig

Table Cell (td)

Span

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

void

Span

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

go

Span

style	float: left;
id	iets

(i)

Table Row (tr)

id	des

Table Cell (td)
Navigates to the relative index based on current position in the history.

Table Row (tr)

id	prs

Table Cell (td)
Parameters {Number} i – the absolute index

Table Row (tr)

id	ret

Table Cell (td)
Returns void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

history.go(-3);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	removeForm
class	node

Table Row (tr)

id	name

Table Cell (td)
removeForm

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

removeForm

Span

style	float: left;
id	iets

(formName)

Table Row (tr)

id	des

Table Cell (td)
Removes the named form item from the history stack (and from memory) if not currently shown.

Table Row (tr)

id	prs

Table Cell (td)
Parameters {String} formName – the name of the form to remove.

Table Row (tr)

id	ret

Table Cell (td)
Returns Boolean – true if successful

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var done = history.removeForm('mypreviousform');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	removeIndex
class	node

Table Row (tr)

id	name

Table Cell (td)
removeIndex

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

removeIndex

Span

style	float: left;
id	iets

(index)

Table Row (tr)

id	des

Table Cell (td)
Removes an absolute index based history stack form item.

Table Row (tr)

id	prs

Table Cell (td)
Parameters {Number} index – the index of the form to remove.

Table Row (tr)

id	ret

Table Cell (td)
Returns Boolean – true if successful

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var done = history.removeIndex(history.getCurrentIndex()+1);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	size
class	node

Table Row (tr)

id	name

Table Cell (td)
size

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

size

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
Returns the total size of the history stack.

Table Row (tr)

id	ret

Table Cell (td)
Returns Number – the size

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var size = history.size();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Child pages

Versions Compared

Old Version 15

New Version Current

Key

buttonsEnabled

back

clear

forward

getCurrentIndex

getFormName

go

removeForm

removeIndex

size