Child pages
  • JSPart

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Divcache
Div
iddescription
HTML Table
id
classservoy sSummary
Colgroup Tag
Col
width80px
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Constants Summary
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)BODY
styleindexdisplay: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.

true
refresh100d
showRefreshtrue
iddoc
titleRefresh page
showDatetrue
retryEnable
idclass

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClient

Table Row (tr)

Table Cell (td)
Number
Table Cell (td)FOOTER
servoy sSummary12%30%58%height: 30px;3Constants SummaryConstant use for specifying the type of form parts.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
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.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
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)TRAILING_SUBSUMMARY
Constant use for specifying the type of form parts.Constant use for specifying the type of form parts. HTML Table

Colgroup Tag
Col
width80px
Col
Table Head (thead) Table Row (tr)styleservoy sSummaryidclass12%30%58%height: 30px;
Table Head (th)
colspan2
Property Summary
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)allowBreakAcrossPageBounds
3Property SummaryWhen 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
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)height
dataproviders can be added as Break (GroupBy) dataproviders.The height of a selected part; specified in pixels. Table Row (tr)
Table Cell (td)
Number
Table Cell (td)pageBreakAfterOccurrence
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)pageBreakBefore
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. 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

Colgroup Tag
Col
width80px
Col
Table Head (thead) Table Row (tr)styleservoy sSummaryid Table Row (tr)
Table Cell (td)
Number
Table Cell (td)getPartType()
12%30%58%height: 30px;
Table Head (th)
colspan2
Method Summary
3Methods SummaryThe type of this part. Table Row (tr)
Table Cell (td)
Number
Table Cell (td)getPartYOffset()
Table Row (tr)
Table Cell (td)
UUID
Table Cell (td)getUUID()
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 UUID of this component. HTML Tableclass

constant Colgroup Tag Colcolspanservoy sDetail2width100%

Col
Table Head (thead) Table Row (tr)styleheight:30px; Table Head (th)colspan2Constants Details Table Body (tbody)ididBODY Table Row (tr)nametd

BODY

Table Row (tr)idclass

des Table Cell (td) DivsIndentConstant use for specifying the type of form parts. This is the default part that is repeated for each record (being
Table Row (tr)id displayed and/or printed).tdret

Returns

divsIndentclients

classtd

Supported Clients

sIndent
Number Table Row (tr)
idsam
SmartClient,WebClient,NGClientsam

Sample

Div
classsIndent
Code Block
languagejavascript
var body = form.newPart(JSPart.BODY, 320);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idFOOTER
Table Row (tr)
idname
Table Cell (td)
Table Row (tr)
iddes
Table Cell (td) Div
classsIndent
sIdentjavascriptlastDetailRow FOOTERname

FOOTER

dessIndentConstant 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
Table Row (tr)id footer is displayed at the bottom of the list of records.tdret

Returns

divsIndentclients

classtd

Supported Clients

sIndent
Number Table Row (tr)
idsam
SmartClient,WebClient,NGClientsam

Sample

Div
classsIndent
Code Block
languagejavascript
var footer = form.newPart(JSPart.FOOTER, 440);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idHEADER
Table Row (tr)
idname
Table Cell (td)

HEADER

Table Row (tr)
iddes
Table Cell (td) Div
classsIndent
sIdentjavascriptlastDetailRow HEADERname

HEADER

dessIndentConstant 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
Table Row (tr)id displayed above the list of records.tdret

Returns

divsIndentclients

classtd

Supported Clients

sIndent
Number Table Row (tr)
idsam
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)idSmartClient,WebClient,NGClientsam

Sample

Div
classsIndent
Code Block
languagejavascript
var header = form.newPart(JSPart.HEADER, 80);
sIdentjavascriptlastDetailRow LEADING_GRAND_SUMMARY Table Row (tr)idname

Table Cell (td)id

LEADING_GRAND_SUMMARY

Table Row (tr)classdes Table Cell (td) DivsIndentConstant use for specifying the type of form parts. A Leading Grand Summary can be placed before the body part. It can contain
Table Row (tr)id summary fields that will generate summaries for the entire foundset.tdret

Returns

divsIndentclients

classtd

Supported Clients

sIndent
Number Table Row (tr)
idsam
SmartClient,WebClient,NGClientsam

Sample

Div
classsIndent
Code Block
languagejavascript
var leadingGrandSummary = form.newPart(JSPart.LEADING_GRAND_SUMMARY, 120);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idLEADING_SUBSUMMARY
Table Row (tr)
idname
Table Cell (td)

LEADING_SUBSUMMARY

Table Row (tr)
iddes
Table Cell (td) Div
classsIndent
sIdentjavascriptlastDetailRow LEADING_SUBSUMMARYname

LEADING_SUBSUMMARY

dessIndentConstant 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.
Table Row (tr)id Each Subsummary part can contain summary fields, which will be printed once for each group of data.tdret

Returns

divsIndentclients

classtd

Supported Clients

sIndent
Number Table Row (tr)
idsam
Table Body (tbody)
idTITLE_FOOTER
Table Row (tr)
idname
tdSmartClient,WebClient,NGClientsam

Sample

Div
classsIndent
Code Block
languagejavascript
var leadingSubsummary = form.newPart(JSPart.LEADING_SUBSUMMARY, 160);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
sIdentjavascriptlastDetailRow TITLE_FOOTERname

TITLE_FOOTER

Table Row (tr)idclass

des Table Cell (td) DivsIndentConstant 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
Table Row (tr)id replaced by the Title Footer on the first page.tdret

Returns

divsIndentclients

classtd

Supported Clients

sIndent
Number Table Row (tr)
idsam
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idTITLE_HEADER
Table Row (tr)
idname
tdSmartClient,WebClient,NGClientsam

Sample

Div
classsIndent
Code Block
languagejavascript
var titleFooter = form.newPart(JSPart.TITLE_FOOTER, 500);
sIdentjavascriptlastDetailRow TITLE_HEADERname

TITLE_HEADER

Table Row (tr)idclass

des Table Cell (td) DivsIndentConstant 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
Table Row (tr)id page.tdret

Returns

divsIndentclients

classtd

Supported Clients

sIndent
Number Table Row (tr)
idsam
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)idSmartClient,WebClient,NGClientsam

Sample

Div
classsIndent
Code Block
languagejavascript
var titleHeader = form.newPart(JSPart.TITLE_HEADER, 40);
sIdentjavascriptlastDetailRow TRAILING_GRAND_SUMMARY Table Row (tr)idtdname

TRAILING_GRAND_SUMMARY

Table Row (tr)idclass

des Table Cell (td) DivsIndentConstant use for specifying the type of form parts. A Trailing Grand Summary can be placed after the body part. It can contain
Table Row (tr)id summary fields that will generate summaries for the entire foundset.tdret

Returns

divsIndentclients

classtd

Supported Clients

sIndent
Number Table Row (tr)
idsam
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idTRAILING_SUBSUMMARY
Table Row (tr)
idname
tdSmartClient,WebClient,NGClientsam

Sample

Div
classsIndent
Code Block
languagejavascript
var trailingGrandSummary = form.newPart(JSPart.TRAILING_GRAND_SUMMARY, 400);
sIdentjavascriptlastDetailRow TRAILING_SUBSUMMARYname

TRAILING_SUBSUMMARY

Table Row (tr)idclass

des Table Cell (td) DivsIndentConstant 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.
Table Row (tr)id Each Subsummary part can contain summary fields, which will be printed once for each group of data.tdret

Returns

divsIndentclients

classtd

Supported Clients

sIndent
Number Table Row (tr)
idsam
SmartClient,WebClient,NGClientsam

Sample

Div
classsIndent
Code Block
languagejavascript
var trailingSubsummary = form.newPart(JSPart.TRAILING_SUBSUMMARY, 360);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
HTML Table
idproperty
classservoy sDetail
Colgroup Tag
Col
colspan2
width100%
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Property Details
Table Body (tbody)
idallowBreakAcrossPageBounds
Table Row (tr)
idname
Table Cell (td)

allowBreakAcrossPageBounds

Table Row (tr)
iddes
Table Cell (td) Div
classsIndent
sIdentjavascriptlastDetailRow 

propertyservoy sDetail2100%height:30px2Property DetailsallowBreakAcrossPageBoundsname

allowBreakAcrossPageBounds

dessIndentWhen 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)idtdret

Returns

divsIndentclients

classtd

Supported Clients

sIndent
Boolean Table Row (tr)
idsam
SmartClient,WebClientsam

Sample

Div
classsIndent
Code Block
languagejavascript
var body = form.newPart(JSPart.BODY, 320);
body.allowBreakAcrossPageBounds = true;
body.discardRemainderAfterBreak = true;
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idbackground
Table Row (tr)
idname
Table Cell (td)

background

Table Row (tr)
iddes
Table Cell (td) Div
classsIndent
sIdentjavascriptlastDetailRow backgroundname

background

dessIndentThe 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
Table Row (tr)id in Application Preferences.tdret

Returns

divsIndentclients

classid

Supported Clients

sIndent
String Table Row (tr)SmartClient,WebClient,NGClientsam

Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var body = form.newPart(JSPart.BODY, 320);
body.background = 'green';
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
iddiscardRemainderAfterBreak
Table Row (tr)
idname
Table Cell (td)

discardRemainderAfterBreak

Table Row (tr)
iddes
Table Cell (td) Div
classsIndent
sIdentjavascriptlastDetailRow discardRemainderAfterBreakname

discardRemainderAfterBreak

dessIndentWhen set, the remainder of a selected part that is broken due to the page

Table Row (tr)id ending will not be printed on the next page - it will be discarded.tdret

Returns

divsIndentclients

classtd

Supported Clients

sIndent
Boolean Table Row (tr)
idsam
SmartClient,WebClientsam

Sample

Div
classsIndent
Code Block
languagejavascript
var body = form.newPart(JSPart.BODY, 320);
body.allowBreakAcrossPageBounds = true;
body.discardRemainderAfterBreak = true;
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgroupbyDataProviderIDs
Table Row (tr)
idname
Table Cell (td)

groupbyDataProviderIDs

Table Row (tr)
iddes
Table Cell (td) Div
classsIndent
sIdentjavascriptlastDetailRow groupbyDataProviderIDsname

groupbyDataProviderIDs

dessIndentFor 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
Table Row (tr)id resulted group of data.tdret

Returns

divsIndentclients

classtd

Supported Clients

sIndent
String Table Row (tr)
idsam
SmartClient,WebClient,NGClientsam

Sample

Div
classsIndent
Code Block
languagejavascript
var leadingSubsummary = form.newPart(JSPart.LEADING_SUBSUMMARY, 160);
leadingSubsummary.groupbyDataProviderIDs = 'my_table_text';
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idheight
Table Row (tr)
idname
Table Cell (td)

height

Table Row (tr)
iddes
Table Cell (td) Div
classsIndent
sIdentjavascriptlastDetailRow heightname

height

dessIndentThe height of a selected part; specified in pixels.
Table Row (tr)id This height property is the lowerbound as its ending Y value (0 == top of the form).tdret

Returns

divsIndentclients

classtd

Supported Clients

sIndent
Number Table Row (tr)
idsam
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idpageBreakAfterOccurrence
Table Row (tr)
idname
Table Cell (td)

pageBreakAfterOccurrence

Table Row (tr)
iddes
Table Cell (td) Div
classsIndent
SmartClient,WebClient,NGClientsam

Sample

Div
classsIndent
Code Block
languagejavascript
var part = form.newPart(JSPart.HEADER, 100);
part.height = 200;
Table Row (tr)idsIdentjavascriptlastDetailRow pageBreakAfterOccurrencename

pageBreakAfterOccurrence

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

Returns

divsIndentclients

classtd

Supported Clients

sIndent
Number Table Row (tr)
idsam
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idpageBreakBefore
Table Row (tr)
idname
Table Cell (td)

pageBreakBefore

Table Row (tr)
iddes
Table Cell (td) Div
classsIndent
SmartClient,WebClientsam

Sample

Div
classsIndent
Code Block
languagejavascript
var body = form.newPart(JSPart.BODY, 320);
body.pageBreakAfterOccurrence = 2;
Table Row (tr)idsIdentjavascriptlastDetailRow pageBreakBeforename

pageBreakBefore

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

Returns

divsIndentclients

classtd

Supported Clients

sIndent
Boolean Table Row (tr)
idsam
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idrestartPageNumber
Table Row (tr)
idname
Table Cell (td)

restartPageNumber

Table Row (tr)
iddes
Table Cell (td) Div
classsIndent
SmartClient,WebClientsam

Sample

Div
classsIndent
Code Block
languagejavascript
var leadingSubsummary = form.newPart(JSPart.LEADING_SUBSUMMARY, 160);
leadingSubsummary.groupbyDataProviderIDs = 'my_table_text';
leadingSubsummary.pageBreakBefore = true;
Table Row (tr)idsIdentjavascriptlastDetailRow restartPageNumbername

restartPageNumber

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

Returns

divsIndentclients

classtd

Supported Clients

sIndent
Boolean Table Row (tr)
idsam
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsinkWhenLast
Table Row (tr)
idname
Table Cell (td)

sinkWhenLast

Table Row (tr)
iddes
Table Cell (td) Div
classsIndent
SmartClient,WebClientsam

Sample

Div
classsIndent
Code Block
languagejavascript
var trailingSubsummary = form.newPart(JSPart.TRAILING_SUBSUMMARY, 360);
trailingSubsummary.groupbyDataProviderIDs = 'my_table_text';
trailingSubsummary.restartPageNumber = true;
sIdentjavascriptlastDetailRow sinkWhenLastname

sinkWhenLast

dessIndentWhen set, the last part on a page (such as a Trailing Grand Summary part) will

Table Row (tr)id "sink" to the lowest part of the page when there is free space.tdret

Returns

divsIndentclients

classid

Supported Clients

sIndent
Boolean Table Row (tr)SmartClient,WebClient,NGClientsam

Table Cell (td)

Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idstyleClass
Table Row (tr)
idname
Table Cell (td)

styleClass

Table Row (tr)
iddes
Table Cell (td) Div
classsIndent

Sample

Div
classsIndent
Code Block
languagejavascript
var trailingGrandSummary = form.newPart(JSPart.TRAILING_GRAND_SUMMARY, 400);
trailingGrandSummary.sinkWhenLast = true;
Table Row (tr)idsIdentjavascriptlastDetailRow styleClassname

styleClass

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

Returns

divsIndentclients

classid

Supported Clients

sIndent
String Table Row (tr)SmartClient,WebClient,NGClientsam

Table Cell (td)

Colgroup Tag
Col
colspan2
width100%
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Method Details
Table Body (tbody)
idgetPartType
Table Row (tr)
idname
Table Cell (td)

getPartType

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Number
Span
stylefont-weight: bold;
getPartType
Span
()
Table Row (tr)
iddes
Table Cell (td) Div
classsIndent

Sample

Div
classsIndent
Code Block
languagejavascript
var body = form.newPart(JSPart.BODY, 320);
body.styleClass = 'myBody';
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
HTML Table
idfunction
classservoy sDetail
sIdentjavascriptlastDetailRow 

functionservoy sDetail2100%height:30px2Methods DetailsgetPartTypename

getPartType()

dessIndentThe type of this part.
Table Row (tr)idrettd

Returns

div
Table Row (tr)
idname
Table Cell (td)

getPartYOffset

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Number
Span
stylefont-weight: bold;
getPartYOffset
Span
()
Table Row (tr)
iddes
Table Cell (td) Div
classsIndent
sIndentclients

classsIndent
Number - A number representing the type of the form part.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
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)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetPartYOffset

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow&nbsp;
getPartYOffsetname

getPartYOffset()

dessIndentThe 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)idtdret

Returns

div Table Row (tr)
iddes
Table Cell (td) Div
classsIndent
sIndentclients

classsIndent
Number - A number holding the Y offset of the form part.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
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)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetUUID
Table Row (tr)
idname
Table Cell (td)

getUUID

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
UUID
Span
stylefont-weight: bold;
getUUID
Span
()

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow&nbsp;
getUUIDname

getUUID()

dessIndentReturns the UUID of this component.
Table Row (tr)idtdret

Returns

divsIndentclients

classtd

Supported Clients

sIndent
UUID Table Row (tr)
idsam
Table Row (tr)
classlastDetailRow
Table Cell (td) SmartClient,WebClient,NGClientsam

Sample

Div
classsIndent
Code Block
languagejavascript
var button_uuid = solutionModel.getForm("my_form").getButton("my_button").getUUID();
application.output(button_uuid.toString());
sIdentjavascriptlastDetailRow&nbsp;