Child pages
  • History

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3
Div
styledisplay:none

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'

Div
iddescription



HTML Table
id
classservoy sSummary
Colgroup Tag
Col
width80px
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Method Summary
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
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 the entire history stack.
Table Row (tr)
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()
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)
void
Table Cell (td)
go(i)
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)
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.



HTML Table
idfunction
classservoy sDetail
Colgroup Tag
Col
colspan2
width100%
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Method Details
Table Body (tbody)
idback
Table Row (tr)
idname
Table Cell (td)

back

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
back
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Navigates back in the history stack; shows the previous form (if present).
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
history.back();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idclear
Table Row (tr)
idname
Table Cell (td)

clear

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
clear
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Clear the entire history stack.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
history.clear();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idforward
Table Row (tr)
idname
Table Cell (td)

forward

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
forward
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Navigates forward in the history stack; shows the next form (if present).
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
history.forward();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetCurrentIndex
Table Row (tr)
idname
Table Cell (td)

getCurrentIndex

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Number
Span
stylefont-weight: bold;
getCurrentIndex
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Get the current absolute index in the history stack.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Number - the current absolute index
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var abs_index = history.getCurrentIndex();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetFormName-Number
Table Row (tr)
idname
Table Cell (td)

getFormName

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
getFormName
Span
(i)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Get the form name based on the specified absolute index in the history stack location.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Number} i - the absolute index
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String - the formName
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var name = history.getFormName(history.getCurrentIndex());
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgo-Number
Table Row (tr)
idname
Table Cell (td)

go

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
go
Span
(i)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Navigates to the relative index based on current position in the history.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Number} i - the relative index
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
history.go(-3);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idremoveForm-String
Table Row (tr)
idname
Table Cell (td)

removeForm

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
removeForm
Span
(formName)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
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)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} formName - the name of the form to remove.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean - true if successful
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var done = history.removeForm('mypreviousform');
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idremoveIndex-Number
Table Row (tr)
idname
Table Cell (td)

removeIndex

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
removeIndex
Span
(index)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Removes an absolute index based history stack form item.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Number} index - the index of the form to remove.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean - true if successful
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var done = history.removeIndex(history.getCurrentIndex()+1);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsize
Table Row (tr)
idname
Table Cell (td)

size

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Number
Span
stylefont-weight: bold;
size
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns the total size of the history stack.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Number - the size
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var size = history.size();
Table Row (tr)
classlastDetailRow
Table Cell (td)