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'



Property Summary
Boolean
sticky
Flag to set a set the header sticky so it will not scroll out of view.
String
styleClass
The Cascading Style Sheet (CSS) class name applied to the part.



Method Summary
JSTitle
getHeaderText()
Returns the header text label on the form header if present.
JSButton
getLeftButton()
Returns the left-button on the form header if present.
JSButton
getRightButton()
Returns the right-button on the form header if present.
JSTitle
newHeaderText(text)
Creates a new header text label on the form header.
JSButton
newLeftButton(text, jsmethod)
Creates a new left-button on the form header.
JSButton
newRightButton(text, jsmethod)
Creates a new right-button on the form header.
Boolean
removeHeaderText()
Remove the header text label on the form header if present.
Boolean
removeLeftButton()
Remove the left-button on the form header if present.
Boolean
removeRightButton()
Remove the right-button on the form header if present.



Property Details

sticky

Flag to set a set the header sticky so it will not scroll out of view.

Returns

Boolean

Sample

var form = solutionModel.newForm('newForm1', myDatasource);
var header = form.newHeader()
header.sticky = false // default: true
 

styleClass

The Cascading Style Sheet (CSS) class name applied to the part.

Returns

String

Sample

var body = form.newPart(JSPart.BODY, 320);
body.styleClass = 'myBody';
 



Method Details

getHeaderText

JSTitle
getHeaderText
()
Returns the header text label on the form header if present.

Returns

JSTitle - a JSTitle object if the header text exists, null otherwise

Sample

var form = solutionModel.getForm('myform');
var header = form.getHeader()
var title = header.getHeaderText()
title.text = 'Customers'
 

getLeftButton

JSButton
getLeftButton
()
Returns the left-button on the form header if present.

Returns

JSButton - a JSButton object if the left-button exists, null otherwise

Sample

var form = solutionModel.getForm('myform');
var header = form.getHeader()
var button = header.getLeftButton()
button.iconType = JSButton.ICON_HOME
 

getRightButton

JSButton
getRightButton
()
Returns the right-button on the form header if present.

Returns

JSButton - a JSButton object if the right-button exists, null otherwise

Sample

var form = solutionModel.getForm('myform');
var header = form.getHeader()
var button = header.getRightButton()
button.iconType = JSButton.ICON_GEARS
 

newHeaderText

JSTitle
newHeaderText
(text)
Creates a new header text label on the form header.

Parameters

text - the text on the header

Returns

JSTitle - a new JSTitle object

Sample

var form = solutionModel.newForm('newForm1', myDatasource);
var header = form.newHeader()
var title = header.newHeaderText('Contacts')
 

newLeftButton

JSButton
newLeftButton
(text, jsmethod)
Creates a new left-button on the form header.

Parameters

{String} text - the text on the button
{JSMethod} jsmethod - the method assigned to handle an onAction event

Returns

JSButton - a new JSButton object

Sample

var form = solutionModel.newForm('newForm1', myDatasource);
var header = form.newHeader()
var button = header.newLeftButton('back', form.getMethod('goBack'))
 

newRightButton

JSButton
newRightButton
(text, jsmethod)
Creates a new right-button on the form header.

Parameters

{String} text - the text on the button
{JSMethod} jsmethod - the method assigned to handle an onAction event

Returns

JSButton - a new JSButton object

Sample

var form = solutionModel.newForm('newForm1', myDatasource);
var header = form.newHeader()
var button = header.newRightButton('save', form.getMethod('doSave'))
 

removeHeaderText

Boolean
removeHeaderText
()
Remove the header text label on the form header if present.

Returns

Boolean - true if header text existed and was removed

Sample

var form = solutionModel.getForm('myform');
var header = form.getHeader()
var removed = header.removeHeaderText()
 

removeLeftButton

Boolean
removeLeftButton
()
Remove the left-button on the form header if present.

Returns

Boolean - true if button existed and was removed

Sample

var form = solutionModel.getForm('myform');
var header = form.getHeader()
var removed = header.removeLeftButton()
 

removeRightButton

Boolean
removeRightButton
()
Remove the right-button on the form header if present.

Returns

Boolean - true if button existed and was removed

Sample

var form = solutionModel.getForm('myform');
var header = form.getHeader()
var removed = header.removeRightButton()