Page History

...

Cache

...

tablecolgroupcolcolspan2width100%coltheadid

2

Supported Clients

sWordList

SmartClient

sWordList

WebClient

sWordList

NGClient

sWordList

MobileClient

index

showRefresh
true
idrefreshclass	100dservoy sReturnTypes

true

id

doc

title

Refresh page

showDate

true

retry

Table Row (tr)

style

Enable

HTML Table

servoy sReturnTypes2100%height: 30px;

Table Head (th)

colspan

Table Row (tr)

Table Cell (td)

Span

class

Span

class

Span

class

Span

class

...

servoy sSummary

30%

58%

height: 30px;

3

Property Summary

Colgroup Tag
	class
Col
width	12%
Col
width
Col
width
Table Head (thead)
Table Row (tr)
style
Table Head (th)
colspan
Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
buttonsEnabled

Table Cell (td)

Set/Get the history buttons enabled.

servoy sSummary

30%

58%

height: 30px;

3

Methods Summary

void

HTML Table
id	class

Colgroup Tag
Col
width
HTML Table
id	12%
Col
width
Col
width
Table Head (thead)
Table Row (tr)
style
Table Head (th)
colspan
Table Row (tr)
Table Cell (td)
Table Cell (td)

Table Cell (td)
back()

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

Table Row (tr) Table Cell (td) Table Cell (td)

void

Table Cell (td)
clear()

Clear the entire history stack.

Table Row (tr) Table Cell (td) Table Cell (td)

void

Table Cell (td)
forward()

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

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
getCurrentIndex()

Table Cell (td)

Get the current absolute index in the history stack.

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 Row (tr) Table Cell (td) Table Cell (td)

void

Table Cell (td)
go(i)

Table Cell (td)

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

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 Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
removeIndex(index)

Table Cell (td)

Removes an absolute index based history stack form item.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
size()

Returns the total size of the history stack.

servoy sDetail

100%

Colgroup Tag
	property	class
Col
colspan	2	width

Col

Table Head (thead) Table Row (tr)style

height:30px

Table Head (th)colspan

2

Property Details

Table Body (tbody)idid

buttonsEnabled

Table Row (tr)

name

td

buttonsEnabled

Table Row (tr)id

des

Table Cell (td) Divclass

sIndent

Set/Get the history buttons enabled.

Table Row (tr)idtd

ret

Returns

div

class Table Row (tr)idsIndentBooleanclients

Table Cell (td)

Supported Clients

Divclass

sIndent

SmartClient,WebClient,NGClient

Table Row (tr)id

sam

Table Cell (td)class

Sample

Div

sIdent

Code Blocklanguage Table Row (tr)class

javascript

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

Table Cell (td)

lastDetailRow

...

HTML Table
id

servoy sDetail

100%

Colgroup Tag
	function	class
Col
colspan	2	width

Col

Table Head (thead) Table Row (tr)style

height:30px

Table Head (th)colspan

2

Methods Details

Table Body (tbody)idid

back

Table Row (tr)

name

Table Cell (td)

back()

Table Row (tr)id

des

Table Cell (td) Divclass

sIndent

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

Table Row (tr)id

ret

Table Cell (td)

Returns

Divclass Table Row (tr)id

sIndentvoidclients

Table Cell (td)

Supported Clients

Divclass

sIndentSmartClient,WebClient,MobileClient Table Row (tr)idtdsam

Sample

div

classsIdent Code Blocklanguageclassjavascript

history.back();

Table Row (tr)

Table Cell (td)

lastDetailRow

id

Table Body (tbody) Table Row (tr)id

clear

name

Table Cell (td)

clear()

Table Row (tr)id Table Cell (td) Divclass

des

sIndent

Clear the entire history stack.

Table Row (tr)id

ret

Table Cell (td)

Returns

Divclassvoid Table Row (tr)id

sIndentclients

Table Cell (td)

Supported Clients

Divclass

sIndentSmartClient,WebClient,MobileClient Table Row (tr)idsam

Table Cell (td)

Sample

Divclass Code Blocklanguage

sIdent

history.clear();

Table Row (tr)class

javascript

Table Cell (td)

lastDetailRow

id

Table Body (tbody) Table Row (tr)id

forward

name

Table Cell (td)id

forward()

Table Row (tr) Table Cell (td) Divclass

des

sIndent

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

Table Row (tr)idtd

ret

Returns

Divclassvoid Table Row (tr)id

sIndentclients

Table Cell (td)

Supported Clients

Divclass

sIndent

SmartClient,WebClient,MobileClient

Table Row (tr)idtd

sam

Sample

Divclass Code Blocklanguage

sIdent

history.forward();

Table Row (tr)class

javascript

Table Cell (td)

lastDetailRow

id

Table Body (tbody) Table Row (tr)id

getCurrentIndex

td

name

getCurrentIndex()

tr

id Table Cell (td) Divclass

des

sIndent

Get the current absolute index in the history stack.

Table Row (tr)id

ret

Table Cell (td)

Returns

div

class Table Row (tr)idsIndentNumberclients

Table Cell (td)

Supported Clients

Divclass

sIndent

SmartClient,WebClient,MobileClient

Table Row (tr)id

sam

Table Cell (td)class

Sample

Divlanguage

sIdent

Code Block Table Row (tr)class

javascript

var abs_index = history.getCurrentIndex();

Table Cell (td)

lastDetailRow

id

Table Body (tbody) Table Row (tr)id

getFormName

name

Table Cell (td)

getFormName(i)

Table Row (tr)id Divclass

des

Table Cell (td)

sIndent

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

Table Row (tr)idtd

prs

Parameters

HTML Tableclass

Table Cell (td)
Number

Table Cell (td)

sIndent Table Cell (td)iidthe absolute index Table Row (tr)tdret

Returns

Divclass Table Row (tr)id

sIndentStringclients

Table Cell (td)

Supported Clients

Divclass

sIndentSmartClient,WebClient,MobileClient Table Row (tr)idtdsamclass

Sample

Divlanguage

sIdent

Code Block Table Row (tr)class

javascript

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

Table Cell (td)

lastDetailRow

id

Table Body (tbody) Table Row (tr)id

go

name

Table Cell (td)id

go(i)

Table Row (tr) Divclass

des

Table Cell (td)

sIndent

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

Table Row (tr)id

prs

Table Cell (td)

Parameters

HTML Tableclass

Table Cell (td)
Number

Table Cell (td)

sIndent Table Cell (td)i Table Row (tr)idthe relative indexret

Table Cell (td)

Returns

Divclassid

sIndent

void Table Row (tr)

clients

Table Cell (td)

Supported Clients

Divclass

sIndentSmartClient,WebClient,MobileClient Table Row (tr)idsam

Table Cell (td)

Sample

Divclasslanguage

sIdent Code Block Table Row (tr)classjavascript

history.go(-3);

Table Cell (td)

lastDetailRow

id

Table Body (tbody) Table Row (tr)id

removeForm

name

Table Cell (td)id

removeForm(formName)

Table Row (tr)class

des

Table Cell (td) Div

sIndent

Table Row (tr)id

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

Table Cell (td)class

Parameters

HTML Table

Table Cell (td)
String

Table Cell (td)

sIndent

Table Cell (td)

formName

the name of the form to remove.

Table Row (tr)id

ret

Table Cell (td)

Returns

Divclassid

sIndentBoolean Table Row (tr)clients

Table Cell (td)

Supported Clients

Divclass

sIndentSmartClient,WebClient,NGClient,MobileClient Table Row (tr)idsam

Table Cell (td)

Sample

Divclasslanguage

sIdent Code Block Table Row (tr)classjavascript

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

Table Cell (td)

lastDetailRow

id

Table Body (tbody) Table Row (tr)id

removeIndex

td

name

id

removeIndex(index)

Table Row (tr) Divclass

des

Table Cell (td)

sIndent

Removes an absolute index based history stack form item.

Table Row (tr)idtd

prs

Parameters

table

class Table Cell (td)sIndent

Table Cell (td)
Number

Table Cell (td)

index

the index of the form to remove.

Table Row (tr)idtd

ret

Returns

div

classidsIndentBoolean Table Row (tr)clients

Table Cell (td)

Supported Clients

Divclass

sIndentSmartClient,WebClient,MobileClient Table Row (tr)idtdsam

Sample

Divclasslanguage

sIdent Code Block Table Row (tr)classjavascript

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

Table Cell (td)

lastDetailRow

id

Table Body (tbody) Table Row (tr)id

size

name

Table Cell (td)id

size()

Table Row (tr) Divclass

des

Table Cell (td)

sIndent

Returns the total size of the history stack.

Table Row (tr)idtd

ret

Returns

Divclassid

sIndentNumber Table Row (tr)clients

Table Cell (td)

Supported Clients

Divclass

sIndentSmartClient,WebClient,MobileClient Table Row (tr)idsam

Table Cell (td)class

Sample

Divlanguage

sIdent

Code Block Table Row (tr)class

javascript

var size = history.size();

Table Cell (td)

lastDetailRow

Child pages

Versions Compared

Old Version 39

New Version 40

Key

buttonsEnabled

back()

clear()

forward()

getCurrentIndex()

getFormName(i)

go(i)

removeForm(formName)

removeIndex(index)

size()