Page History

{div:style=}

Wiki Markup

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.

\\ \\ Enter additional information related to this

Enter additional information related to this 'class'

inside

the

\

{div}

macro

with

'id=description'

{div} {div:id=description}{div}\\ {table:id=|class=servoy sSummary}{colgroup}{column:width=80px|padding=0px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Command Summary{th}{tr}{table}\\ {table:id=|class=servoy sSummary}{colgroup}{column:width=80px|padding=0px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Event Summary{th}{tr}{tbody}{tr}{td}[Boolean]{td}{td}[#onHide] The method that is triggered when another form is being activated.{td}{tr}{tbody}{tbody}{tr}{td}{td}{td}[#onLoad] The method that is triggered when a form is loaded/reloaded from the repository; used to alter elements, set globals, hide toolbars, etc; onShow method can also be assigned.{td}{tr}{tbody}{tbody}{tr}{td}{td}{td}[#onRecordSelection] The method that is triggered each time a record is selected.{td}{tr}{tbody}{tbody}{tr}{td}{td}{td}[#onShow] The method that is triggered EVERY TIME the form is displayed; an argument must be passed to the method if this is the first time the form is displayed.{td}{tr}{tbody}{table}\\ {table:id=|class=servoy sSummary}{colgroup}{column:width=80px|padding=0px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Property Summary{th}{tr}{tbody}{tr}{td}[String]{td}{td}[#dataSource] The names of the database server and table that this form is linked to.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#encapsulation] The encapsulation mode for the form (see JSForm constants for encapsulation mode constants).{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#name] The name of the form.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#navigator] The navigator (previously named "controller") that is used to control/navigate to the form.{td}{tr}{tbody}{table}\\ {table:id=command|class=servoy sDetail}{colgroup}{column:width=100%|padding=0px}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Command Details{th}{tr}{table}\\ {table:id=event|class=servoy sDetail}{colgroup}{column:width=100%|padding=0px}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Event Details{th}{tr}{tbody:id=onHide-JSEvent}{tr:id=name}{td}h6.onHide{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[JSEvent]} event -- the event that triggered the action {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=onLoad-JSEvent}{tr:id=name}{td}h6.onLoad{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[JSEvent]} event -- the event that triggered the action {div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=onRecordSelection-JSEvent}{tr:id=name}{td}h6.onRecordSelection{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[JSEvent]} event -- the event that triggered the action {div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=onShow-Boolean_JSEvent}{tr:id=name}{td}h6.onShow{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Boolean]} firstShow -- form is shown first time after load \{[JSEvent]} event -- the event that triggered the action {div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}\\ {table:id=property|class=servoy sDetail}{colgroup}{column:width=100%|padding=0px}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Property Details{th}{tr}{tbody:id=dataSource}{tr:id=name}{td}h6.dataSource{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=encapsulation}{tr:id=name}{td}h6.encapsulation{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number] -- the encapsulation mode/level for the form{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=name}{tr:id=name}{td}h6.name{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=navigator}{tr:id=name}{td}h6.navigator{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}

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

Event Summary

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
onHide The method that is triggered when another form is being activated.

Table Row (tr)

Table Cell (td)

Table Cell (td)
onLoad The method that is triggered when a form is loaded/reloaded from the repository; used to alter elements, set globals, hide toolbars, etc; onShow method can also be assigned.

Table Row (tr)

Table Cell (td)

Table Cell (td)
onRecordSelection The method that is triggered each time a record is selected.

Table Row (tr)

Table Cell (td)

Table Cell (td)
onShow The method that is triggered EVERY TIME the form is displayed; an argument must be passed to the method if this is the first time the form is displayed.

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

Table Cell (td)
dataSource The names of the database server and table that this form is linked to.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
deprecated Gets the deprecate info for this element

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
encapsulation The encapsulation mode of this persist.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
name The name of the form.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
navigator The navigator is a form that usually handles navigation in application.

HTML Table

id	event
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

Event Details

Table Body (tbody)

id	onHide-JSEvent

Table Row (tr)

id	name

Table Cell (td)
onHide

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The method that is triggered when another form is being activated.
NOTE: If the onHide method returns false, the form can be prevented from hiding.
For example, when using onHide with showFormInDialog, the form will not close by clicking the dialog close box (X).

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{JSEvent} event - the event that triggered the action

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onLoad-JSEvent

Table Row (tr)

id	name

Table Cell (td)
onLoad

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The method that is triggered when a form is loaded/reloaded from the repository; used to alter elements, set globals, hide toolbars,
etc; onShow method can also be assigned.
NOTE: onShow should be used to access current foundset dataproviders; onLoad cannot be used because the foundset data is not loaded until after the form is loaded.
Also calls to loadRecords() should be done in the onShow method and not in the onLoad method
If you call loadRecords() in the onShow method, you may want to set the namedFoundSet property of the form to 'empty' to prevent the first default form query.
NOTE: the onLoad event bubbles down, meaning that the onLoad is first fired on the parent then on a tab in a tabpanel (and in tab of that tab panels if you are 3 deep)

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{JSEvent} event - the event that triggered the action

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onRecordSelection-JSEvent

Table Row (tr)

id	name

Table Cell (td)
onRecordSelection

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The method that is triggered each time a record is selected.
If a form is in List view or Special table view - when the user clicks on it.
In Record view - after the user navigates to another record using the slider or clicks up or down for next/previous record.
NOTE: Data and Servoy tag values are returned when the onRecordSelection method is executed.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{JSEvent} event - the event that triggered the action

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onShow-Boolean_JSEvent

Table Row (tr)

id	name

Table Cell (td)
onShow

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The method that is triggered EVERY TIME the form is displayed; an argument must be passed to the method if this is the first time the form is displayed.

NOTE: onShow can be used to access current foundset dataproviders; onLoad cannot be used because the foundset data is not loaded until after the form is loaded.

NOTE: the onShow event bubbles down, meaning that the onShow event of a form displayed in a tabPanel is fired after the onShow event of the parent.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Boolean} firstShow - form is shown first time after load
{JSEvent} event - the event that triggered the action

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	dataSource

Table Row (tr)

id	name

Table Cell (td)
dataSource

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The names of the database server and table that this form is linked to.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	deprecated

Table Row (tr)

id	name

Table Cell (td)
deprecated

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Gets the deprecate info for this element

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String - the deprecate info for this element or null if it is not deprecated

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	encapsulation

Table Row (tr)

id	name

Table Cell (td)
encapsulation

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The encapsulation mode of this persist. The following can be used/checked:

- Public (not a separate option - if none of the below options are selected)
- Hide in scripting; Module Scope - not available in scripting from any other context except the form itself. Available in designer for the same module.
- Module Scope - available in both scripting and designer but only in the same module.
- Hide Dataproviders (checked by default)
- Hide Foundset (checked by default)
- Hide Controller (checked by default)
- Hide Elements (checked by default)

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number - the encapsulation mode/level of the persist.

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	name

Table Row (tr)

id	name

Table Cell (td)
name

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The name of the form.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	navigator

Table Row (tr)

id	name

Table Cell (td)
navigator

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The navigator is a form that usually handles navigation in application. It is displayed on left side of the screen. Can also have value SM_DEFAULTS.NONE (no navigator) or SM_DEFAULTS.IGNORE (reuse current form navigator).

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Child pages

Versions Compared

Old Version 5

New Version Current

Key

onHide

onLoad

onRecordSelection

onShow

dataSource

deprecated

encapsulation

name

navigator