Child pages
  • JSHeader

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
Property Summary
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
sticky
Flag to set a set the header sticky so it will not scroll out of view.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
styleClass
The Cascading Style Sheet (CSS) class name applied to the part.



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)
JSTitle
Table Cell (td)
getHeaderText()
Returns the header text label on the form header if present.
Table Row (tr)
Table Cell (td)
JSButton
Table Cell (td)
getLeftButton()
Returns the left-button on the form header if present.
Table Row (tr)
Table Cell (td)
JSButton
Table Cell (td)
getRightButton()
Returns the right-button on the form header if present.
Table Row (tr)
Table Cell (td)
JSTitle
Table Cell (td)
newHeaderText(text)
Creates a new header text label on the form header.
Table Row (tr)
Table Cell (td)
JSButton
Table Cell (td)
newLeftButton(text, jsmethod)
Creates a new left-button on the form header.
Table Row (tr)
Table Cell (td)
JSButton
Table Cell (td)
newRightButton(text, jsmethod)
Creates a new right-button on the form header.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
removeHeaderText()
Remove the header text label on the form header if present.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
removeLeftButton()
Remove the left-button on the form header if present.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
removeRightButton()
Remove the right-button on the form header if present.



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

sticky

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Flag to set a set the header sticky so it will not scroll out of view.
Table Row (tr)
idret
Table Cell (td)

Returns

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

Sample

Div
classsIndent
Code Block
languagejavascript
var form = solutionModel.newForm('newForm1', myDatasource);
var header = form.newHeader()
header.sticky = false // default: true
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idstyleClass
Table Row (tr)
idname
Table Cell (td)

styleClass

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The Cascading Style Sheet (CSS) class name applied to the part.
Table Row (tr)
idret
Table Cell (td)

Returns

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

Sample

Div
classsIndent
Code Block
languagejavascript
var body = form.newPart(JSPart.BODY, 320);
body.styleClass = 'myBody';
Table Row (tr)
classlastDetailRow
Table Cell (td)
 



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

getHeaderText

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSTitle
Span
stylefont-weight: bold;
getHeaderText
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns the header text label on the form header if present.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSTitle - a JSTitle object if the header text exists, null otherwise
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var form = solutionModel.getForm('myform');
var header = form.getHeader()
var title = header.getHeaderText()
title.text = 'Customers'
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetLeftButton
Table Row (tr)
idname
Table Cell (td)

getLeftButton

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSButton
Span
stylefont-weight: bold;
getLeftButton
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns the left-button on the form header if present.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSButton - a JSButton object if the left-button exists, null otherwise
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var form = solutionModel.getForm('myform');
var header = form.getHeader()
var button = header.getLeftButton()
button.iconType = JSButton.ICON_HOME
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetRightButton
Table Row (tr)
idname
Table Cell (td)

getRightButton

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSButton
Span
stylefont-weight: bold;
getRightButton
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns the right-button on the form header if present.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSButton - a JSButton object if the right-button exists, null otherwise
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var form = solutionModel.getForm('myform');
var header = form.getHeader()
var button = header.getRightButton()
button.iconType = JSButton.ICON_GEARS
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idnewHeaderText-
Table Row (tr)
idname
Table Cell (td)

newHeaderText

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSTitle
Span
stylefont-weight: bold;
newHeaderText
Span
(text)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Creates a new header text label on the form header.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
text - the text on the header
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSTitle - a new JSTitle object
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var form = solutionModel.newForm('newForm1', myDatasource);
var header = form.newHeader()
var title = header.newHeaderText('Contacts')
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idnewLeftButton-String_JSMethod
Table Row (tr)
idname
Table Cell (td)

newLeftButton

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSButton
Span
stylefont-weight: bold;
newLeftButton
Span
(text, jsmethod)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Creates a new left-button on the form header.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} text - the text on the button
{JSMethod} jsmethod - the method assigned to handle an onAction event
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSButton - a new JSButton object
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var form = solutionModel.newForm('newForm1', myDatasource);
var header = form.newHeader()
var button = header.newLeftButton('back', form.getMethod('goBack'))
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idnewRightButton-String_JSMethod
Table Row (tr)
idname
Table Cell (td)

newRightButton

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSButton
Span
stylefont-weight: bold;
newRightButton
Span
(text, jsmethod)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Creates a new right-button on the form header.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} text - the text on the button
{JSMethod} jsmethod - the method assigned to handle an onAction event
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSButton - a new JSButton object
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var form = solutionModel.newForm('newForm1', myDatasource);
var header = form.newHeader()
var button = header.newRightButton('save', form.getMethod('doSave'))
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idremoveHeaderText
Table Row (tr)
idname
Table Cell (td)

removeHeaderText

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
removeHeaderText
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Remove the header text label on the form header if present.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean - true if header text existed and was removed
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var form = solutionModel.getForm('myform');
var header = form.getHeader()
var removed = header.removeHeaderText()
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idremoveLeftButton
Table Row (tr)
idname
Table Cell (td)

removeLeftButton

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
removeLeftButton
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Remove the left-button on the form header if present.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean - true if button existed and was removed
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var form = solutionModel.getForm('myform');
var header = form.getHeader()
var removed = header.removeLeftButton()
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idremoveRightButton
Table Row (tr)
idname
Table Cell (td)

removeRightButton

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
removeRightButton
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Remove the right-button on the form header if present.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean - true if button existed and was removed
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var form = solutionModel.getForm('myform');
var header = form.getHeader()
var removed = header.removeRightButton()
Table Row (tr)
classlastDetailRow
Table Cell (td)