Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
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'
Divcache
styleindexdisplay:none

...

iddescription

...

padding0px
width80px

...

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Event Summary
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#onClose
The method that is executed when a solution closes.

...

Table Cell (td)
#onDataBroadcast
Method that is executed when data broadcast occurs.
Table Body (tbody)
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 Cell (td)
#onOpen
The method that is executed when a solution opens.

...

padding0px
width80px

...

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Property Summary

...

Table Cell (td)
Number

...

true
refresh100d
showRefreshtrue
iddoc
titleRefresh page
showDatetrue
retryEnable

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClientsWordListMobileClient

servoy sSummary12%30%58%height: 30px;3Property SummaryThe first form that loads when a solution is deployed.

...

Table Cell (td)
String

...

Table Cell (td)
Number

...

The i18n database server connection and database table that stores the i18n keys for a solution.

...

...

Table Cell (td)
String

...

The name of the login form that loads when a solution is deployed.

...

Get the first module that is also a login solution.

...

Table Cell (td)
String

...

The list of modules that have been added to a solution.

...

Table Cell (td)
Boolean

...

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

...

Table Cell (td)
Number

...

The type of a solution; can be "Normal" (non-module), "Module", "Web client only", "Smart client only",

...

Table Cell (td)
Number

...

"Login", "Authenticator", "Pre-import hook module", "Post-import hook module", "Mobile".

...

The custom CSS used by the solution (a MEDIA lib entry).The direction that text is displayed.

...

Table Cell (td)
String

...

The menu bar title of a solution.

...

idevent
classservoy sDetail

...

padding0px
width100%

...

servoy sSummary12%30%58%height: 30px;

...

Table Head (th)
colspan1
Event Details

...

idonClose-Boolean
Table Row (tr)
idname
Table Cell (td)
onClose

...

iddes

...

classsIndent
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

...

classlastDetailRow

...

idonDataBroadcast-String_Number_JSDataSet_Boolean
Table Row (tr)
idname
Table Cell (td)
onDataBroadcast

...

iddes

...

classsIndent
3Event SummaryThe method that is executed when a solution closes.

...

voidMethod that is executed when data broadcast occurs.The

...

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

...

classlastDetailRow

...

idonError-
Table Row (tr)
idname
Table Cell (td)
onError

...

iddes

...

classsIndent

...

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

...

classlastDetailRow

...

idonOpen
Table Row (tr)
idname
Table Cell (td)
onOpen

...

iddes

...

classsIndent

...

method that is executed when a solution opens and an error occurs.

...

voidThe method that is executed when a solution opens

...

classlastDetailRow

...

id
HTML Table
.

...

servoy sDetail2Property DetailsfirstFormnametd

firstForm

id

des

sIndent
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.
id
ret

Returns

divsIndentclients

class

class

property

Colgroup Tag
Column
padding0px
width100%
Table Row (tr)
style2100%height:30px;
Table Head (th)
colspan1
Table Body (tbody)
idid
Table Row (tr)
Table Row (tr)
class
Table Cell (td)
Div
Table Row (tr)
Table Cell (td)
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
td

Supported Clients

sIndent
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
SmartClient,WebClient,NGClient,MobileClientsam

Sample

sIdentjavascript
lastDetailRow
i18nDataSourcename

i18nDataSource

dessIndent
The i18n database server connection and database table that stores the i18n keys for a solution.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
loginFormname

loginForm

dessIndent
The name of the login form that loads when a solution is deployed.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
loginSolutionNamename

loginSolutionName

dessIndent
Get the first module that is also a login solution.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
modulesNamesname

modulesNames

dessIndent
The list of modules that have been added to a solution.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
mustAuthenticatename

mustAuthenticate

dessIndent
Flag that tells if authentication is needed in order to access the solution.
If unchecked, the Smart Client will always require authentication, regardless of this setting.
If checked, authentication is required, and either a provided loginSolution or otherwise the default Servoy login mechanism will be used.
If default Servoy login mechanism is used, the "servoy.webclient.basic.authentication" setting on the Admin Page can be used to enable the use of the standard browser basic authentication.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
solutionTypename

solutionType

dessIndent
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.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
styleSheetname

styleSheet

dessIndent
The custom CSS used by the solution (a MEDIA lib entry). It can reference other media resources (even additional .css through relative '@import' statements).
For NGClient - this CSS will be available directly in the browser.
ret

Returns

sIndent
clients

Supported Clients

sIndentNGClient
sam

Sample

sIdentjavascript
lastDetailRow
textOrientationname

textOrientation

dessIndent
The direction that text is displayed.

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
titleTextname

titleText

dessIndent
The menu bar title of a solution.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow

eventservoy sDetail2100%height:30px2Event DetailsonClosename

onClose(force)

dessIndent
The method that is executed when a solution closes. The default is -none-.
prs

Parameters

sIndentforceif false then solution close can be stopped by returning false
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRowonDataBroadcastname

onDataBroadcast(dataSource, action, pks, cached)

dessIndent
Method that is executed when data broadcast occurs. The default is -none-.
prs

Parameters

sIndentdataSourcetable data sourceactionsee SQL_ACTION_TYPES constantspksaffected primary keyscacheddata was cached
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
onErrorname

onError(ex)

dessIndent
The method that is executed when a solution opens and an error occurs. The default is -none.
prs

Parameters

sIndentexexception to handle
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
onOpenname

onOpen(arg, queryParams)

dessIndent
The method that is executed when a solution opens. The default is -none-.
prs

Parameters

sIndentargstartup argument part of the deeplink url with which the Client was startedqueryParamsall query parameters of the deeplink url with which the Client was started
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow