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

Property Summary

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

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

HTML Table

id
class	servoy sSummary

Colgroup Tag

Column

padding	0px
width	80px

Column

tbody

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Summary

tbody

Table Row (tr)

Table Cell (td)
void

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

Table Row (tr)

Table Cell (td)
void

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

Table Body (tbody)

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
#forward 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 getCurrentIndex() Get the current absolute index in the history stack.

tbody

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

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

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
#go 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 removeForm(formName) Removes the named form item from the history stack (and from memory) if not currently shown.

tbody

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

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

Table Row (tr)

Table Cell (td)
Number

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

Table Row (tr)

id	name

Table Cell (td)
buttonsEnabled

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Set/Get the history buttons enabled.

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

...

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

Table Row (tr)

id	name

Table Cell (td)
back

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

back

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

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

Table Row (tr)

id	name

Table Cell (td)
clear

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

clear

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Clear the entire history stack.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

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

Table Row (tr)

id	name

Table Cell (td)
forward

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

forward

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

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

Table Row (tr)

id	name

Table Cell (td)
getCurrentIndex

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Number

Span

style	font-weight: bold;

getCurrentIndex

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Get the current absolute index in the history stack.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

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-Number

Table Row (tr)

id	name

Table Cell (td)
getFormName

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

getFormName

Span
(i)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Get the form name based on the specified absolute index in the history stack location.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} i

...

- the absolute index

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

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-Number

Table Row (tr)

id	name

Table Cell (td)
go

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

go

Span
(i)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Navigates to the relative index based on current position in the history.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} i

...

- the relative index

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

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-String

Table Row (tr)

id	name

Table Cell (td)
removeForm

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

removeForm

Span
(formName)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Removes the named form item from the history stack (and from memory) if not currently shown.
Will return false when the form can't be removed, this can happen in certain situations:
1> The form is visible,
2> The form is executing a function (is actively used),
3> There are references to this form by a global variable/array,
4> If the form has a separate foundset with edited records that can't be saved (for example autosave is false)

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} formName

...

- the name of the form to remove.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

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-Number

Table Row (tr)

id	name

Table Cell (td)
removeIndex

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

removeIndex

Span
(index)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Removes an absolute index based history stack form item.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} index

...

- the index of the form to remove.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

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

Table Row (tr)

id	name

Table Cell (td)
size

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Number

Span

style	font-weight: bold;

size

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns the total size of the history stack.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

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 26

New Version 27

Key

buttonsEnabled

back

clear

forward

getCurrentIndex

getFormName

go

removeForm

removeIndex

size