Page History

Div

style	display:none

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.

Div

id	description

HTML Table

id
class	servoy sSummary

Colgroup Tag

Col

width	80px

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Constants Summary

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
BODY Constant use for specifying the type of form parts.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
FOOTER Constant use for specifying the type of form parts.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
HEADER Constant use for specifying the type of form parts.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
LEADING_GRAND_SUMMARY Constant use for specifying the type of form parts.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
LEADING_SUBSUMMARY Constant use for specifying the type of form parts.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
TITLE_FOOTER Constant use for specifying the type of form parts.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
TITLE_HEADER Constant use for specifying the type of form parts.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
TRAILING_GRAND_SUMMARY Constant use for specifying the type of form parts.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
TRAILING_SUBSUMMARY Constant use for specifying the type of form parts.

HTML Table

id
class	servoy sSummary

Colgroup Tag

Col

width	80px

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Property Summary

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
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.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
background The background color of the form part.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
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.

Table Row (tr)

Table Cell (td)
String

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

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
height The height of a selected part; specified in pixels.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
pageBreakAfterOccurrence A page break will be inserted after a specified number of occurences of a selected part.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
pageBreakBefore When set, a page break will be inserted before each occurrence of a selected part.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
restartPageNumber When set, page numbering will be restarted after each occurrence of a selected part.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
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.

Table Row (tr)

Table Cell (td)
String

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

HTML Table

id
class	servoy sSummary

Colgroup Tag

Col

width	80px

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Summary

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
getPartType() The type of this part.

Table Row (tr)

Table Cell (td)
Number

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

Table Row (tr)

Table Cell (td)
UUID

Table Cell (td)
getUUID() Returns the UUID of this component.

HTML Table

id	constant
class	servoy sDetail

Colgroup Tag

Col

colspan	2
width	100%

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Constants Details

Table Body (tbody)

id	BODY

Table Row (tr)

id	name

Table Cell (td)
BODY

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	FOOTER

Table Row (tr)

id	name

Table Cell (td)
FOOTER

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	HEADER

Table Row (tr)

id	name

Table Cell (td)
HEADER

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	LEADING_GRAND_SUMMARY

Table Row (tr)

id	name

Table Cell (td)
LEADING_GRAND_SUMMARY

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Constant use for specifying the type of form parts.

A Leading Grand Summary can be placed before the body part. It can contain
summary fields that will generate summaries for the entire foundset.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	LEADING_SUBSUMMARY

Table Row (tr)

id	name

Table Cell (td)
LEADING_SUBSUMMARY

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Constant use for specifying the type of form parts.

A Leading Subsummary can be placed before the body part. There can be multiple Leading Subsummaries
per form. Each Subsummary part has a set of Group By fields which are used to group data together.
Each Subsummary part can contain summary fields, which will be printed once for each group of data.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	TITLE_FOOTER

Table Row (tr)

id	name

Table Cell (td)
TITLE_FOOTER

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Constant use for specifying the type of form parts.

Appears once on the first page of a printed report. If a Footer is available, it is
replaced by the Title Footer on the first page.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	TITLE_HEADER

Table Row (tr)

id	name

Table Cell (td)
TITLE_HEADER

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	TRAILING_GRAND_SUMMARY

Table Row (tr)

id	name

Table Cell (td)
TRAILING_GRAND_SUMMARY

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Constant use for specifying the type of form parts.

A Trailing Grand Summary can be placed after the body part. It can contain
summary fields that will generate summaries for the entire foundset.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	TRAILING_SUBSUMMARY

Table Row (tr)

id	name

Table Cell (td)
TRAILING_SUBSUMMARY

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Constant use for specifying the type of form parts.

A Trailing Subsummary can be placed before the body part. There can be multiple Trailing Subsummaries
per form. Each Subsummary part has a set of Group By fields which are used to group data together.
Each Subsummary part can contain summary fields, which will be printed once for each group of data.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

HTML Table

id	property
class	servoy sDetail

Colgroup Tag

Col

colspan	2
width	100%

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Property Details

Table Body (tbody)

id	allowBreakAcrossPageBounds

Table Row (tr)

id	name

Table Cell (td)
allowBreakAcrossPageBounds

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	background

Table Row (tr)

id	name

Table Cell (td)
background

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	discardRemainderAfterBreak

Table Row (tr)

id	name

Table Cell (td)
discardRemainderAfterBreak

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	groupbyDataProviderIDs

Table Row (tr)

id	name

Table Cell (td)
groupbyDataProviderIDs

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	height

Table Row (tr)

id	name

Table Cell (td)
height

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	pageBreakAfterOccurrence

Table Row (tr)

id	name

Table Cell (td)
pageBreakAfterOccurrence

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	pageBreakBefore

Table Row (tr)

id	name

Table Cell (td)
pageBreakBefore

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	restartPageNumber

Table Row (tr)

id	name

Table Cell (td)
restartPageNumber

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	sinkWhenLast

Table Row (tr)

id	name

Table Cell (td)
sinkWhenLast

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	styleClass

Table Row (tr)

id	name

Table Cell (td)
styleClass

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

HTML Table

id	function
class	servoy sDetail

Colgroup Tag

Col

colspan	2
width	100%

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Details

Table Body (tbody)

id	getPartType

Table Row (tr)

id	name

Table Cell (td)
getPartType

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Number

Span

style	font-weight: bold;

getPartType

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The type of this part.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number - A number representing the type of the form part.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getPartYOffset

Table Row (tr)

id	name

Table Cell (td)
getPartYOffset

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Number

Span

style	font-weight: bold;

getPartYOffset

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number - A number holding the Y offset of the form part.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getUUID

Table Row (tr)

id	name

Table Cell (td)
getUUID

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

UUID

Span

style	font-weight: bold;

getUUID

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns the UUID of this component.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

UUID

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Child pages

Versions Compared

Old Version 23

New Version Current

Key

BODY

FOOTER

HEADER

LEADING_GRAND_SUMMARY

LEADING_SUBSUMMARY

TITLE_FOOTER

TITLE_HEADER

TRAILING_GRAND_SUMMARY

TRAILING_SUBSUMMARY

allowBreakAcrossPageBounds

background

discardRemainderAfterBreak

groupbyDataProviderIDs

height

pageBreakAfterOccurrence

pageBreakBefore

restartPageNumber

sinkWhenLast

styleClass

getPartType

getPartYOffset

getUUID