JSPart

Constants Summarized

Type	Name	Summary
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	TITLE_HEADER	Constant use for specifying the type of form parts.

Properties Summarized

Type	Name	Summary
String	background	The background color of the form part.
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.
String	styleClass	The Cascading Style Sheet (CSS) class name applied to the part.

Methods Summarized

Type	Name	Summary
String	getComment()	Returns the comment of this component.
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.

Constants Detailed

BODY

Constant use for specifying the type of form parts.

This is the default part that is repeated for each record (being displayed and/or printed).

Type Number

Sample

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

FOOTER

Constant use for specifying the type of form parts.

A footer is displayed at the bottom of each page when printed ad can contain summaries of the current selection of records. In List view, the footer is displayed at the bottom of the list of records.

Type Number

Sample

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

HEADER

Constant use for specifying the type of form parts.

A header is displayed at the top of each page when printed and can contain summaries of the current selection of records. In List view the header is displayed above the list of records. In tableview the default column headers will not be there if this is specified.

Type Number

Sample

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

TITLE_HEADER

Constant use for specifying the type of form parts.

Appears only once on the first page of a printed report or on top of the first screen of a foundset. If a Header is available it is replace by the Title Header on the first page. This part is also shown in a normal none printing form, because it can be used to place components in a tableview form and keep the default table header columns. Other parts as the HEADER will remove the default header columns.

Type Number

Sample

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

Properties Detailed

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.

Type String

Sample

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

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.

Type String

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

Type Number

Sample

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

styleClass

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

Type String

Sample

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

Methods Detailed

getComment()

Returns the comment of this component.

Returns: String

Sample

var comment = solutionModel.getForm("my_form").getButton("my_button").getComment();
application.output(comment);

getPartType()

The type of this part.

Returns: Number A number representing the type of the form part.

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 A number holding the Y offset of the form part.

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

Sample

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