Page History

Divcache

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

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

Table Cell (td)firstForm

styleindex	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.

true
refresh	100d
showRefresh	true
id	doc
title	Refresh page
showDate	true
retry	Enable

idevent

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClientsWordListMobileClient

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

Table Cell (td)
String

Table Cell (td)i18nDataSource

loginForm

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)

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

Table Row (tr)

Table Cell (td)
String

Table Cell (td)loginSolutionName

Table Cell (td)modulesNames

Get the first module that is also a login solution.

Table Row (tr)

Table Cell (td)
String

mustAuthenticate

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

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)

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",

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)textOrientation

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

Table Cell (td)titleText

The custom CSS used by the solution (a MEDIA lib entry).

The direction that text is displayed.

Table Row (tr)

Table Cell (td)
String

The menu bar title of a solution.

HTML Table

classservoy sDetail

Colgroup Tag

Col

colspan	2
width	100%

Col

Table Head (thead) Table Row (tr)style

servoy sSummary

12%

30%

58%

height: 30px;

Table Head (th)

colspan	2

Event Details

Table Body (tbody)

id	onClose-Boolean

Table Row (tr)

id	name

Table Cell (td)
onClose

Table Row (tr)

id	des

Table Cell (td) Div

class	sIndent

3

Event Summary

The method that is executed when a solution closes.

The default is -none-.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

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

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	onDataBroadcast-String_Number_JSDataSet_Boolean

Table Row (tr)

id	name

Table Cell (td)
onDataBroadcast

Table Row (tr)

id	des

Table Cell (td) Div

class	sIndent

Method that is executed when data broadcast occurs.

The

default is -none-.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

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

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onError-

Table Row (tr)

id	name

Table Cell (td)
onError

Table Row (tr)

id	des

Table Cell (td) Div

class	sIndent

The

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

The

default is -none.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

ex - exception to handle

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	onOpen

Table Row (tr)

id	name

Table Cell (td)
onOpen

Table Row (tr)

id	des

Table Cell (td) Div

class	sIndent

The

method that is executed when a solution opens.

The default is -none-.

Table Row (tr)

class	lastDetailRow

Table Cell (td)

table

idclass

property Colgroup Tag Colcolspanservoy sDetail2width100%

Col

Table Head (thead) Table Row (tr)style

height:30px

; Table Head (th)colspan

2

Property Details

Table Body (tbody)idid

firstForm

Table Row (tr)

name

Table Cell (td)
firstForm
Table Row (tr)idclass
des Table Cell (td) DivsIndentThe first form that loads when a solution is deployed. Table Row (tr)id NOTE: If the Login form is specified, then the firstForm is the first form that will load next after the loginForm.ret
Table Cell (td)
Returns
divsIndentclients
class
Supported Clients
sIndentNumber
Table Row (tr)
class lastDetailRow
Table Cell (td)

Table Body (tbody)
id i18nDataSource
Table Row (tr)
id name
Table Cell (td)
i18nDataSource
Table Row (tr)
id des
Table Cell (td) Div
class sIndent
SmartClient,WebClient,NGClient,MobileClientsam
Sample
sIdentjavascriptlastDetailRow i18nDataSourcename
i18nDataSource
dessIndentThe i18n database server connection and database table that stores the i18n keys for a solution. Table Row (tr)idtdret
Returns
divsIndentclients
class
Supported Clients
sIndentString
Table Row (tr)
class lastDetailRow
Table Cell (td)

Table Body (tbody)
id loginForm
Table Row (tr)
id name
Table Cell (td)
loginForm
Table Row (tr)
id des
Table Cell (td) Div
class sIndent
SmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRow loginFormname
loginForm
dessIndentThe name of the login form that loads when a solution is deployed. Table Row (tr)idret
Table Cell (td)
Returns
divsIndentclients
class Div
class sIndent
Supported Clients
sIndentNumber
Table Row (tr)
class lastDetailRow
Table Cell (td)

Table Body (tbody)
id loginSolutionName
Table Row (tr)
id name
Table Cell (td)
loginSolutionName
Table Row (tr)
id des
Table Cell (td)SmartClient,WebClient,NGClient,MobileClientsam
Sample
sIdentjavascriptlastDetailRow loginSolutionNamename
loginSolutionName
dessIndentGet the first module that is also a login solution. Table Row (tr)idtdret
Returns
divsIndentclients
class
Supported Clients
sIndentString
Table Row (tr)
class lastDetailRow
Table Cell (td)

Table Body (tbody)
id modulesNames
Table Row (tr)
id name
Table Cell (td)
modulesNames
Table Row (tr)
id des
Table Cell (td) Div
class sIndent
SmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRow modulesNamesname
modulesNames
dessIndentThe list of modules that have been added to a solution. Table Row (tr)idret
Table Cell (td)
Returns
divsIndentclients
class
Supported Clients
sIndentString
Table Row (tr)
class lastDetailRow
Table Cell (td)

Table Body (tbody)
id mustAuthenticate
Table Row (tr)
id name
Table Cell (td)
mustAuthenticate
Table Row (tr)
id des
Table Cell (td) Div
class sIndent
SmartClient,WebClient,NGClient,MobileClientsam
Sample
sIdentjavascriptlastDetailRow mustAuthenticatename
mustAuthenticate
dessIndentFlag 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)
id ret
Table Cell (td)
Returns
Div
class sIndent
Boolean
Table Row (tr)
class lastDetailRow
Table Cell (td)

Table Body (tbody)
id solutionType
Table Row (tr)
id name
Table Cell (td)
solutionType
Table Row (tr)
id des
Table Cell (td) Div
class sIndent
. 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
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClient,MobileClientsam
Sample
sIdentjavascriptlastDetailRow solutionTypename
solutionType
dessIndentThe 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)id These constants are defined in SolutionMetaData class.ret
Table Cell (td)
Returns
divsIndentclients
class
Supported Clients
sIndentNumber
Table Row (tr)
class lastDetailRow
Table Cell (td)

Table Body (tbody)
id textOrientation
Table Row (tr)
id name
Table Cell (td)
textOrientation
Table Row (tr)
id des
Table Cell (td) Div
class sIndent
SmartClient,WebClient,NGClient,MobileClientsam
Sample
sIdentjavascriptlastDetailRow styleSheetname
styleSheet
dessIndentThe 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
sIndentclients
Supported Clients
sIndentNGClientsam
Sample
sIdentjavascriptlastDetailRow textOrientationname
textOrientation
dessIndentThe direction that text is displayed. Options include:
DEFAULT
left to right
right to left
Table Row (tr)
id ret
Table Cell (td)
Returns
Div
class sIndent
Number
Table Row (tr)
class lastDetailRow
Table Cell (td)

Table Body (tbody)
id titleText
Table Row (tr)
id name
Table Cell (td)
titleText
Table Row (tr)
id des
Table Cell (td)
Div
class sIndent
The menu bar title of a solution.
Table Row (tr)
id ret
Table Cell (td)
Returns
Div
class sIndent
String
Table Row (tr)
class lastDetailRow
Table Cell (td) locale specificret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRow titleTextname
titleText
dessIndentThe menu bar title of a solution.ret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRow 
eventservoy sDetail2100%height:30px2Event DetailsonClosename
onClose(force)
dessIndentThe method that is executed when a solution closes. The default is -none-.prs
Parameters
sIndentforceif false then solution close can be stopped by returning falseret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRow onDataBroadcastname
onDataBroadcast(dataSource, action, pks, cached)
dessIndentMethod that is executed when data broadcast occurs. The default is -none-.prs
Parameters
sIndentdataSourcetable data sourceactionsee SQL_ACTION_TYPES constantspksaffected primary keyscacheddata was cachedret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRow onErrorname
onError(ex)
dessIndentThe method that is executed when a solution opens and an error occurs. The default is -none.prs
Parameters
sIndentexexception to handleret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRow onOpenname
onOpen(arg, queryParams)
dessIndentThe 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 startedret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClient,MobileClientsam
Sample
sIdentjavascriptlastDetailRow 

Child pages

Versions Compared

Old Version 42

New Version 43

Key

onClose

onDataBroadcast

onError

onOpen

firstForm

i18nDataSource

i18nDataSource

loginForm

loginForm

loginSolutionName

loginSolutionName

modulesNames

modulesNames

mustAuthenticate

mustAuthenticate

solutionType

solutionType

textOrientation

styleSheet

textOrientation

titleText

titleText

onClose(force)

onDataBroadcast(dataSource, action, pks, cached)

onError(ex)

onOpen(arg, queryParams)