Supported Clients
SmartClient
WebClient

Property Summary
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.

Methods Summary
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.

Property Details

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.

Returns

Boolean

Supported Clients

SmartClient,WebClient

Sample

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

background

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.

Returns

String

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.

Returns

Boolean

Supported Clients

SmartClient,WebClient

Sample

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

groupbyDataProviderIDs

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.

Returns

String

Supported Clients

SmartClient,WebClient,NGClient

Sample

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

height

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

Returns

Number

Supported Clients

SmartClient,WebClient,NGClient

Sample

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

pageBreakAfterOccurrence

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

Returns

Number

Supported Clients

SmartClient,WebClient

Sample

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

pageBreakBefore

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

Returns

Boolean

Supported Clients

SmartClient,WebClient

Sample

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

restartPageNumber

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

Returns

Boolean

Supported Clients

SmartClient,WebClient

Sample

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

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.

Returns

Boolean

Supported Clients

SmartClient,WebClient,NGClient

Sample

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

styleClass

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

Returns

String

Supported Clients

SmartClient,WebClient,NGClient

Sample

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

Methods Details

getPartType()

The type of this part.

Returns

Number

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

getPartYOffset()

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

Returns

Number

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

getUUID()

Returns the UUID of this component.

Returns

UUID

Supported Clients

SmartClient,WebClient,NGClient

Sample

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