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.



Event Summary
Boolean
onClose
The method that is executed when a solution closes.
 
onDataBroadcast
Method that is executed when data broadcast occurs.
Boolean
onError
The method that is executed when a solution opens and an error occurs.
 
onOpen
The method that is executed when a solution opens.



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
textOrientation
The direction that text is displayed.
String
titleText
The menu bar title of a solution.



Event Details

onClose

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
 

onDataBroadcast

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
 

onError

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

Parameters

ex - exception to handle

Returns

Boolean
 

onOpen

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



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
 

i18nDataSource

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

Returns

String
 

loginForm

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

Returns

Number
 

loginSolutionName

Get the first module that is also a login solution.

Returns

String
 

modulesNames

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

Returns

String
 

mustAuthenticate

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.

Returns

Boolean
 

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
 

textOrientation

The direction that text is displayed.

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

Returns

Number
 

titleText

The menu bar title of a solution.

Returns

String