JSPart

Number

BODY
Constant use for specifying the type of form parts.

Number

FOOTER
Constant use for specifying the type of form parts.

Number

HEADER
Constant use for specifying the type of form parts.

Number

LEADING_GRAND_SUMMARY
Constant use for specifying the type of form parts.

Number

LEADING_SUBSUMMARY
Constant use for specifying the type of form parts.

Number

TITLE_FOOTER
Constant use for specifying the type of form parts.

Number

TITLE_HEADER
Constant use for specifying the type of form parts.

Number

TRAILING_GRAND_SUMMARY
Constant use for specifying the type of form parts.

Number

TRAILING_SUBSUMMARY
Constant use for specifying the type of form parts.

Boolean

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.

String

background
The background color of the form part.

Boolean

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.

String

groupbyDataProviderIDs
For Leading Subsummary or Trailing Subsummary parts, one or more
dataproviders can be added as Break (GroupBy) dataproviders.

Number

height
The height of a selected part; specified in pixels.

Number

pageBreakAfterOccurrence
A page break will be inserted after a specified number of occurences of a selected part.

Boolean

pageBreakBefore
When set, a page break will be inserted before each occurrence of a selected part.

Boolean

restartPageNumber
When set, page numbering will be restarted after each occurrence of a selected part.

Boolean

sinkWhenLast
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.

String

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

Number

getPartType()
The type of this part.

Number

getPartYOffset()
The Y offset of the part on the form, this will include all the super forms parts if this form extends a form.

UUID

getUUID()
Returns the UUID of this component.

BODY

Returns

Sample

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

FOOTER

Returns

Sample

var footer = form.newPart(JSPart.FOOTER, 440);

HEADER

Returns

Sample

var header = form.newPart(JSPart.HEADER, 80);

LEADING_GRAND_SUMMARY

Returns

Sample

var leadingGrandSummary = form.newPart(JSPart.LEADING_GRAND_SUMMARY, 120);

LEADING_SUBSUMMARY

Returns

Sample

var leadingSubsummary = form.newPart(JSPart.LEADING_SUBSUMMARY, 160);

TITLE_FOOTER

Returns

Sample

var titleFooter = form.newPart(JSPart.TITLE_FOOTER, 500);

TITLE_HEADER

Returns

Sample

var titleHeader = form.newPart(JSPart.TITLE_HEADER, 40);

TRAILING_GRAND_SUMMARY

Returns

Sample

var trailingGrandSummary = form.newPart(JSPart.TRAILING_GRAND_SUMMARY, 400);

TRAILING_SUBSUMMARY

Returns

Sample

var trailingSubsummary = form.newPart(JSPart.TRAILING_SUBSUMMARY, 360);

allowBreakAcrossPageBounds

Returns

Sample

var body = form.newPart(JSPart.BODY, 320);
body.allowBreakAcrossPageBounds = true;
body.discardRemainderAfterBreak = true;

background

Returns

Sample

var body = form.newPart(JSPart.BODY, 320);
body.background = 'green';

discardRemainderAfterBreak

Returns

Sample

var body = form.newPart(JSPart.BODY, 320);
body.allowBreakAcrossPageBounds = true;
body.discardRemainderAfterBreak = true;

groupbyDataProviderIDs

Returns

Sample

var leadingSubsummary = form.newPart(JSPart.LEADING_SUBSUMMARY, 160);
leadingSubsummary.groupbyDataProviderIDs = 'my_table_text';

height

Returns

Sample

var part = form.newPart(JSPart.HEADER, 100);
part.height = 200;

pageBreakAfterOccurrence

Returns

Sample

var body = form.newPart(JSPart.BODY, 320);
body.pageBreakAfterOccurrence = 2;

pageBreakBefore

Returns

Sample

var leadingSubsummary = form.newPart(JSPart.LEADING_SUBSUMMARY, 160);
leadingSubsummary.groupbyDataProviderIDs = 'my_table_text';
leadingSubsummary.pageBreakBefore = true;

restartPageNumber

Returns

Sample

var trailingSubsummary = form.newPart(JSPart.TRAILING_SUBSUMMARY, 360);
trailingSubsummary.groupbyDataProviderIDs = 'my_table_text';
trailingSubsummary.restartPageNumber = true;

sinkWhenLast

Returns

Sample

var trailingGrandSummary = form.newPart(JSPart.TRAILING_GRAND_SUMMARY, 400);
trailingGrandSummary.sinkWhenLast = true;

styleClass

Returns

Sample

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

getPartType

Returns

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());
}

getPartYOffset

Returns

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());
}

getUUID

Returns

Sample

var button_uuid = solutionModel.getForm("my_form").getButton("my_button").getUUID();
application.output(button_uuid.toString());