Page History

...

padding	0px
width	80px

...

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Property Summary

...

Table Cell (td)
Boolean

...

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

Div

id	description

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.

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

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClientsWordListMobileClient

servoy sSummary12%30%58%height: 30px;3Property SummarySet/Get the history buttons enabled.

...

servoy sSummary

...

padding	0px
width	80px

...

12%

30%

58%

height: 30px;

...

Table Head (th)

colspan	2

Method Summary

...

Table Cell (td)
void

...

3

Methods Summary

void

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

...

void

...

Clear the entire history stack.

...

void

...

Table Cell (td)
Number

...

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

...

Get the current absolute index in the history stack.

...

Table Cell (td)
String

...

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

...

void

...

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

...

Table Cell (td)
Boolean

...

Table Cell (td)
Boolean

...

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

...

Removes an absolute index based history stack form item.

...

Table Cell (td)
Number

...

Returns the total size of the history stack.

...

property

...

servoy sDetail

...

padding	0px
width	100%

...

colspan	1

2100%

height:30px

...

2

Property Details

...

buttonsEnabled

...

name

...

buttonsEnabled

...

des

...

sIndent

Set/Get the history buttons enabled.

...

ret

...

Returns

...

sIndent

clients

...

Supported Clients

sIndent

...

SmartClient,WebClient,NGClient

sam

...

class	lastDetailRow

...

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

td

Sample

Div

class	sIndent

Code Block

language	javascript


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

sIdent

javascript

lastDetailRow

functionservoy sDetail2100%height:30px2Methods Detailsbackname

back()

des

sIndent

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

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient,MobileClient

sam

Sample

sIdent

javascript

lastDetailRow

clear

name

clear()

des

sIndent

Clear the entire history stack.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient,MobileClient

sam

Sample

sIdent

javascript

lastDetailRow

forward

name

forward()

des

sIndent

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

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient,MobileClient

sam

Sample

sIdent

javascript

lastDetailRow

getCurrentIndex

name

getCurrentIndex()

des

sIndent

Get the current absolute index in the history stack.

ret

Returns

sIndent

the current absolute index

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient,MobileClient

sam

Sample

sIdent

javascript

lastDetailRow

getFormName

name

getFormName(i)

des

sIndent

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

prs

Parameters

sIndent

i

the absolute index

ret

Returns

sIndent

the formName

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient,MobileClient

sam

Sample

sIdent

javascript

lastDetailRow

go

name

go(i)

des

sIndent

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

prs

Parameters

sIndent

i

the relative index

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient,MobileClient

sam

Sample

sIdent

javascript

lastDetailRow

removeForm

name

removeForm(formName)

des

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)

prs

Parameters

sIndent

formName

the name of the form to remove.

ret

Returns

sIndent

true if successful

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient,MobileClient

sam

Sample

sIdent

javascript

lastDetailRow

removeIndex

name

removeIndex(index)

des

sIndent

Removes an absolute index based history stack form item.

prs

Parameters

sIndent

index

the index of the form to remove.

ret

Returns

sIndent

true if successful

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient,MobileClient

sam

Sample

sIdent

javascript

lastDetailRow

size

name

size()

des

sIndent

Returns the total size of the history stack.

ret

Returns

sIndent

the size

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient,MobileClient

sam

Sample

sIdent

javascript

lastDetailRow

Child pages

Versions Compared

Old Version 26

New Version Current

Key

buttonsEnabled

back

clear

forward

getCurrentIndex

getFormName

go

removeForm

removeIndex

size

back()

clear()

forward()

getCurrentIndex()

getFormName(i)

go(i)

removeForm(formName)

removeIndex(index)

size()