Supported Clients
SmartClient
WebClient
NGClient
MobileClient

Property Summary
Number
firstForm
The first form that loads when a solution is deployed.
String
i18nDataSource
The i18n database server connection and database table that stores the i18n keys for a solution.
Number
loginForm
The name of the login form that loads when a solution is deployed.
String
loginSolutionName
Get the first module that is also a login solution.
String
modulesNames
The list of modules that have been added to a solution.
Boolean
mustAuthenticate
Flag that tells if authentication is needed in order to access the solution.
Number
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".
Number
styleSheet
The custom CSS used by the solution (a MEDIA lib entry).
Number
textOrientation
The direction that text is displayed.
String
titleText
The menu bar title of a solution.

Event Summary
Boolean
onClose(force)
The method that is executed when a solution closes.
onDataBroadcast(dataSource, action, pks, cached)
Method that is executed when data broadcast occurs.
Boolean
onError(ex)
The method that is executed when a solution opens and an error occurs.
onOpen(arg, queryParams)
The method that is executed when a solution opens.

Property Details

firstForm

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.

Returns

Number

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

 

i18nDataSource

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

Returns

String

Supported Clients

SmartClient,WebClient,NGClient

Sample

 

loginForm

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

Returns

Number

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

 

loginSolutionName

Get the first module that is also a login solution.

Returns

String

Supported Clients

SmartClient,WebClient,NGClient

Sample

 

modulesNames

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

Returns

String

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

 

mustAuthenticate

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.

Returns

Boolean

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

 

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". These constants are defined in SolutionMetaData class.

Returns

Number

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

 

styleSheet

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.

Returns

Number

Supported Clients

NGClient

Sample

 

textOrientation

The direction that text is displayed. Options include: DEFAULT left to right right to left locale specific

Returns

Number

Supported Clients

SmartClient,WebClient,NGClient

Sample

 

titleText

The menu bar title of a solution.

Returns

String

Supported Clients

SmartClient,WebClient,NGClient

Sample

 

Event Details

onClose(force)

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

Parameters

Boolean
force
if false then solution close can be stopped by returning false

Returns

Boolean

Supported Clients

SmartClient,WebClient,NGClient

Sample

 

onDataBroadcast(dataSource, action, pks, cached)

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

Parameters

String
dataSource
table data source
Number
action
see SQL_ACTION_TYPES constants
JSDataSet
pks
affected primary keys
Boolean
cached
data was cached

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

 

onError(ex)

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

Parameters

ex
exception to handle

Returns

Boolean

Supported Clients

SmartClient,WebClient,NGClient

Sample

 

onOpen(arg, queryParams)

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

Parameters

String
arg
startup argument part of the deeplink url with which the Client was started
queryParams
all query parameters of the deeplink url with which the Client was started

Returns

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample