Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 36 Next »

Unknown macro: {div}

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'

Unknown macro: {div}


Unknown macro: {table}
Unknown macro: {colgroup}
Unknown macro: {tr}
Unknown macro: {th}

Event Summary

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

onClose
The method that is executed when a solution closes.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {td}

onDataBroadcast
Method that is executed when data broadcast occurs.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

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

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {td}

onOpen
The method that is executed when a solution opens.


Unknown macro: {table}
Unknown macro: {colgroup}
Unknown macro: {tr}
Unknown macro: {th}

Property Summary

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Number

Unknown macro: {td}

firstForm
The first form that loads when a solution is deployed.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

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

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Number

Unknown macro: {td}

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

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

loginSolutionName
Get the first module that is also a login solution.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

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

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

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

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Number

Unknown macro: {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".

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Number

Unknown macro: {td}

textOrientation
The direction that text is displayed.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

titleText
The menu bar title of a solution.


Unknown macro: {table}
Unknown macro: {colgroup}
Unknown macro: {tr}
Unknown macro: {th}

Event Details

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
onClose
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
onDataBroadcast
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
onError
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

ex – exception to handle

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
onOpen
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}


Unknown macro: {table}
Unknown macro: {colgroup}
Unknown macro: {tr}
Unknown macro: {th}

Property Details

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
firstForm
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

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.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Number

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
i18nDataSource
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
loginForm
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Number

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
loginSolutionName
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Get the first module that is also a login solution.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
modulesNames
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
mustAuthenticate
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

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.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
solutionType
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

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.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Number

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
textOrientation
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

The direction that text is displayed.

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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Number

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
titleText
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

The menu bar title of a solution.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String

Unknown macro: {tr}
Unknown macro: {td}
  • No labels