When set, the remainder of a selected part that does not fit on the page currently
being printed, will not be transported to the next page - it will break where the page
ends and continue on the next page. |
|
The background color of the form part. |
|
When set, the remainder of a selected part that is broken due to the page
ending will not be printed on the next page - it will be discarded. |
|
For Leading Subsummary or Trailing Subsummary parts, one or more
dataproviders can be added as Break (GroupBy) dataproviders. |
|
The height of a selected part; specified in pixels. |
|
A page break will be inserted after a specified number of occurences of a selected part. |
|
When set, a page break will be inserted before each occurrence of a selected part. |
|
When set, page numbering will be restarted after each occurrence of a selected part. |
|
When set, the last part on a page (such as a Trailing Grand Summary part) will
"sink" to the lowest part of the page when there is free space. |
|
Flag to set a set the header sticky so it will not scroll out of view. |
|
The Cascading Style Sheet (CSS) class name applied to the part. |
|
|
Returns the header text label on the form header if present. |
|
Returns the left-button on the form header if present. |
|
The Y offset of the part on the form, this will include all the super forms parts if this form extends a form. |
|
Returns the right-button on the form header if present. |
|
Returns the UUID of this component. |
|
Creates a new header text label on the form header. |
|
Creates a new left-button on the form header. |
|
Creates a new right-button on the form header. |
|
Remove the header text label on the form header if present. |
|
Remove the left-button on the form header if present. |
|
Remove the right-button on the form header if present. |
|
|
allowBreakAcrossPageBounds |
|
When set, the remainder of a selected part that does not fit on the page currently
being printed, will not be transported to the next page - it will break where the page
ends and continue on the next page.
NOTE: Make sure to set this option when you are printing more than one page per record. |
|
|
Sample var body = form.newPart(JSPart.BODY, 320);
body.allowBreakAcrossPageBounds = true;
body.discardRemainderAfterBreak = true; |
|
|
|
|
The background color of the form part.
NOTE: When no background color has been set, the default background
color will be determined by the Look and Feel (LAF) that has been selected
in Application Preferences. |
|
|
Supported Clients SmartClient,WebClient,NGClient |
|
|
Sample var body = form.newPart(JSPart.BODY, 320);
body.background = 'green'; |
|
|
|
|
discardRemainderAfterBreak |
|
When set, the remainder of a selected part that is broken due to the page
ending will not be printed on the next page - it will be discarded. |
|
|
Sample var body = form.newPart(JSPart.BODY, 320);
body.allowBreakAcrossPageBounds = true;
body.discardRemainderAfterBreak = true; |
|
|
|
|
For Leading Subsummary or Trailing Subsummary parts, one or more
dataproviders can be added as Break (GroupBy) dataproviders. The
Leading/Trailing Subsummary parts will be displayed once for each
resulted group of data. |
|
|
Supported Clients SmartClient,WebClient,NGClient |
|
|
Sample var leadingSubsummary = form.newPart(JSPart.LEADING_SUBSUMMARY, 160);
leadingSubsummary.groupbyDataProviderIDs = 'my_table_text'; |
|
|
|
|
The height of a selected part; specified in pixels.
This height property is the lowerbound as its ending Y value (0 == top of the form). |
|
|
Supported Clients SmartClient,WebClient,NGClient |
|
|
Sample var part = form.newPart(JSPart.HEADER, 100);
part.height = 200; |
|
|
|
|
A page break will be inserted after a specified number of occurences of a selected part. |
|
|
Sample var body = form.newPart(JSPart.BODY, 320);
body.pageBreakAfterOccurrence = 2; |
|
|
|
|
When set, a page break will be inserted before each occurrence of a selected part. |
|
|
Sample var leadingSubsummary = form.newPart(JSPart.LEADING_SUBSUMMARY, 160);
leadingSubsummary.groupbyDataProviderIDs = 'my_table_text';
leadingSubsummary.pageBreakBefore = true; |
|
|
|
|
When set, page numbering will be restarted after each occurrence of a selected part. |
|
|
Sample var trailingSubsummary = form.newPart(JSPart.TRAILING_SUBSUMMARY, 360);
trailingSubsummary.groupbyDataProviderIDs = 'my_table_text';
trailingSubsummary.restartPageNumber = true; |
|
|
|
|
When set, the last part on a page (such as a Trailing Grand Summary part) will
"sink" to the lowest part of the page when there is free space. |
|
|
Supported Clients SmartClient,WebClient,NGClient |
|
|
Sample var trailingGrandSummary = form.newPart(JSPart.TRAILING_GRAND_SUMMARY, 400);
trailingGrandSummary.sinkWhenLast = true; |
|
|
|
|
Flag to set a set the header sticky so it will not scroll out of view. |
|
|
Supported Clients SmartClient,WebClient,NGClient |
|
|
Sample var form = solutionModel.newForm('newForm1', myDatasource);
var header = form.newHeader()
header.sticky = false // default: true |
|
|
|
|
The Cascading Style Sheet (CSS) class name applied to the part. |
|
|
Supported Clients SmartClient,WebClient,NGClient |
|
|
Sample var body = form.newPart(JSPart.BODY, 320);
body.styleClass = 'myBody'; |
|
|
|
|
|
Returns the header text label on the form header if present. |
|
|
Supported Clients SmartClient,WebClient,NGClient |
|
|
Sample var form = solutionModel.getForm('myform');
var header = form.getHeader()
var title = header.getHeaderText()
title.text = 'Customers' |
|
|
|
|
Returns the left-button on the form header if present. |
|
|
Supported Clients SmartClient,WebClient,NGClient |
|
|
Sample var form = solutionModel.getForm('myform');
var header = form.getHeader()
var button = header.getLeftButton()
button.iconType = JSButton.ICON_HOME |
|
|
|
|
Supported Clients SmartClient,WebClient,NGClient |
|
|
Sample var allParts = form.getParts()
for (var i=0; i<allParts.length; i++) {
if (allParts[i].getPartType() == JSPart.BODY)
application.output('body Y offset: ' + allParts[i].getPartYOffset());
} |
|
|
|
|
The Y offset of the part on the form, this will include all the super forms parts if this form extends a form. |
|
|
Supported Clients SmartClient,WebClient,NGClient |
|
|
Sample var allParts = form.getParts()
for (var i=0; i<allParts.length; i++) {
if (allParts[i].getPartType() == JSPart.BODY)
application.output('body Y offset: ' + allParts[i].getPartYOffset());
} |
|
|
|
|
Returns the right-button on the form header if present. |
|
|
Supported Clients SmartClient,WebClient,NGClient |
|
|
Sample var form = solutionModel.getForm('myform');
var header = form.getHeader()
var button = header.getRightButton()
button.iconType = JSButton.ICON_GEARS |
|
|
|
|
Returns the UUID of this component. |
|
|
Supported Clients SmartClient,WebClient,NGClient |
|
|
Sample var button_uuid = solutionModel.getForm("my_form").getButton("my_button").getUUID();
application.output(button_uuid.toString()); |
|
|
|
|
Creates a new header text label on the form header. |
|
|
Supported Clients SmartClient,WebClient,NGClient |
|
|
Sample var form = solutionModel.newForm('newForm1', myDatasource);
var header = form.newHeader()
var title = header.newHeaderText('Contacts') |
|
|
|
|
newLeftButton(text, jsmethod) |
|
Creates a new left-button on the form header. |
|
|
Parameters the method assigned to handle an onAction event |
|
|
|
|
Supported Clients SmartClient,WebClient,NGClient |
|
|
Sample var form = solutionModel.newForm('newForm1', myDatasource);
var header = form.newHeader()
var button = header.newLeftButton('back', form.getMethod('goBack')) |
|
|
|
|
newRightButton(text, jsmethod) |
|
Creates a new right-button on the form header. |
|
|
Parameters the method assigned to handle an onAction event |
|
|
|
|
Supported Clients SmartClient,WebClient,NGClient |
|
|
Sample var form = solutionModel.newForm('newForm1', myDatasource);
var header = form.newHeader()
var button = header.newRightButton('save', form.getMethod('doSave')) |
|
|
|
|
Remove the header text label on the form header if present. |
|
|
Supported Clients SmartClient,WebClient,NGClient |
|
|
Sample var form = solutionModel.getForm('myform');
var header = form.getHeader()
var removed = header.removeHeaderText() |
|
|
|
|
Remove the left-button on the form header if present. |
|
|
Supported Clients SmartClient,WebClient,NGClient |
|
|
Sample var form = solutionModel.getForm('myform');
var header = form.getHeader()
var removed = header.removeLeftButton() |
|
|
|
|
Remove the right-button on the form header if present. |
|
|
Supported Clients SmartClient,WebClient,NGClient |
|
|
Sample var form = solutionModel.getForm('myform');
var header = form.getHeader()
var removed = header.removeRightButton() |
|
|
|
|
|
|