History

Unknown macro: {div}

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

Unknown macro: {div}

Unknown macro: {table}

{column:width=80px|padding=0px}{column}{column}{column}

Unknown macro: {tr}

Unknown macro: {th}

Property Summary

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Boolean

Unknown macro: {td}

buttonsEnabled
Set/Get the history buttons enabled.

Unknown macro: {table}

{column:width=80px|padding=0px}{column}{column}{column}

Unknown macro: {tr}

Unknown macro: {th}

Method Summary

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

void

Unknown macro: {td}

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

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

void

Unknown macro: {td}

clear()
Clear the entire history stack.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

void

Unknown macro: {td}

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

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Number

Unknown macro: {td}

getCurrentIndex()
Get the current absolute index in the history stack.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

String

Unknown macro: {td}

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

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

void

Unknown macro: {td}

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

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Boolean

Unknown macro: {td}

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

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Boolean

Unknown macro: {td}

removeIndex(index)
Removes an absolute index based history stack form item.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Number

Unknown macro: {td}

size()
Returns the total size of the history stack.

Unknown macro: {table}

{column:width=100%|padding=0px}{column}

Unknown macro: {tr}

Unknown macro: {th}

Property Details

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

buttonsEnabled

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {table}

{column:width=100%|padding=0px}{column}

Unknown macro: {tr}

Unknown macro: {th}

Method Details

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

back

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

void

Unknown macro: {span}

back

Unknown macro: {span}

()

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

void

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

history.back();

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

clear

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

void

Unknown macro: {span}

clear

Unknown macro: {span}

()

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

void

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

history.clear();

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

forward

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

void

Unknown macro: {span}

forward

Unknown macro: {span}

()

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

void

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

history.forward();

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

getCurrentIndex

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Number

Unknown macro: {span}

getCurrentIndex

Unknown macro: {span}

()

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Number – the current absolute index

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

var abs_index = history.getCurrentIndex();

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

getFormName

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

String

Unknown macro: {span}

getFormName

Unknown macro: {span}

(i)

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {div}

{Number} i – the absolute index

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

String – the formName

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

go

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

void

Unknown macro: {span}

go

Unknown macro: {span}

(i)

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {div}

{Number} i – the relative index

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

void

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

history.go(-3);

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

removeForm

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Boolean

Unknown macro: {span}

removeForm

Unknown macro: {span}

(formName)

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} formName – the name of the form to remove.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean – true if successful

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

removeIndex

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Boolean

Unknown macro: {span}

removeIndex

Unknown macro: {span}

(index)

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {div}

{Number} index – the index of the form to remove.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean – true if successful

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

size

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Number

Unknown macro: {span}

size

Unknown macro: {span}

()

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Number – the size

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

var size = history.size();

Unknown macro: {tr}

Unknown macro: {td}

Child pages

History

buttonsEnabled

back

clear

forward

getCurrentIndex

getFormName

go

removeForm

removeIndex

size