Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Rev: 1382015563792
Div
styledisplay: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 'class' inside the {div} macro with 'id=description'

Div
iddescription



HTML Table
id
classservoy sSummary
Colgroup Tag

...

Col
width80px

...

Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Event Summary
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
onClose
The method that is executed when a solution closes.
Table Row (tr)
Table Cell (td)
 
Table Cell (td)
onDataBroadcast
Method that is executed when data broadcast occurs.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
onError
The method that is executed when a solution opens and an error occurs.
Table Row (tr)
Table Cell (td)
 
Table Cell (td)
onOpen
The method that is executed when a solution opens.



HTML Table
id
classservoy sSummary
Colgroup Tag

...

Col

...

width80px

...

Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Property Summary
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
firstForm
The first form that loads when a solution is deployed.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
i18nDataSource
The i18n database server connection and database table that stores the i18n keys for a solution.
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
loginForm
The name of the login form that loads when a solution is deployed.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
loginSolutionName
Get the first module that is also a login solution.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
modulesNames
The list of modules that have been added to a solution.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
mustAuthenticate
Flag that tells if authentication is needed in order to access the solution.
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
solutionType
The type of a solution; can be "Normal" (non-module), "Module", "Web client only", "Smart client only",
"Login", "Authenticator", "Pre-import hook module", "Post-import hook module", "Mobile".
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
textOrientation
The direction that text is displayed.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
titleText
The menu bar title of a solution.



HTML Table
idevent
classservoy sDetail
Colgroup Tag

...

Col

...

colspan

...

2
width100%
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan

...

2
Event Details
Table Body (tbody)
idonClose-Boolean
Table Row (tr)
idname
Table Cell (td)

onClose

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The method that is executed when a solution closes. The default is -none-.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Boolean} force - if false then solution close can be stopped by returning false
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idonDataBroadcast-String_Number_JSDataSet_Boolean
Table Row (tr)
idname
Table Cell (td)

onDataBroadcast

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Method that is executed when data broadcast occurs. The default is -none-.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} dataSource - table data source
{Number} action - see SQL_ACTION_TYPES constants
{JSDataSet} pks - affected primary keys
{Boolean} cached - data was cached
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idonError-
Table Row (tr)
idname
Table Cell (td)

onError

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The method that is executed when a solution opens and an error occurs. The default is -none.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
ex - exception to handle
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idonOpen
Table Row (tr)
idname
Table Cell (td)

onOpen

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The method that is executed when a solution opens. The default is -none-.
Table Row (tr)
classlastDetailRow
Table Cell (td)
 



HTML Table
idproperty
classservoy sDetail
Colgroup Tag
column
Col
padding
colspan
0px
2
width100%
Col
Table Head (thead)
1
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan
2
Property Details
Table Body (tbody)
idfirstForm
Table Row (tr)
idname
Table Cell (td)

firstForm

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

The first form that loads when a solution is deployed.

NOTE: If the Login form is specified, then the firstForm is the first form that will load next after the loginForm.

Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Number
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idi18nDataSource
Table Row (tr)
idname
Table Cell (td)

i18nDataSource

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The i18n database server connection and database table that stores the i18n keys for a solution.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idloginForm
Table Row (tr)
idname
Table Cell (td)

loginForm

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The name of the login form that loads when a solution is deployed.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Number
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idloginSolutionName
Table Row (tr)
idname
Table Cell (td)

loginSolutionName

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Get the first module that is also a login solution.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idmodulesNames
Table Row (tr)
idname
Table Cell (td)

modulesNames

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The list of modules that have been added to a solution.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idmustAuthenticate
Table Row (tr)
idname
Table Cell (td)

mustAuthenticate

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

Flag that tells if authentication is needed in order to access the solution.

To enforce a default Servoy user name and password login dialog; if set a login dialog is required, if unchecked no login dialog is required.

Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsolutionType
Table Row (tr)
idname
Table Cell (td)

solutionType

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The type of a solution; can be "Normal" (non-module), "Module", "Web client only", "Smart client only",
"Login", "Authenticator", "Pre-import hook module", "Post-import hook module", "Mobile".
These constants are defined in SolutionMetaData class.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Number
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idtextOrientation
Table Row (tr)
idname
Table Cell (td)

textOrientation

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

The direction that text is displayed.

Options include:
DEFAULT
left to right
right to left
locale specific

Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Number
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idtitleText
Table Row (tr)
idname
Table Cell (td)

titleText

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The menu bar title of a solution.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String
Table Row (tr)
classlastDetailRow
Table Cell (td)