Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 4.0
Wiki Markup
{div:style=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.\\		\\		Enter additional information related to this 'class' inside the \{div} macro with 'id=description'{div}
{div:id=description}{div}\\ 

{table:id=|class=servoy sSummary}{colgroup}{column:width=80px|padding=0px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Event Summary{th}{tr}{tbody}{tr}{td}[Boolean]{td}{td}[#onClose]
The method that is executed when a solution closes.{td}{tr}{tbody}{tbody}{tr}{td}{td}{td}[#onDataBroadcast]
Method that is executed when data broadcast occurs.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#onError]
The method that is executed when a solution opens and an error occurs.{td}{tr}{tbody}{tbody}{tr}{td}{td}{td}[#onOpen]
The method that is executed when a solution opens.{td}{tr}{tbody}{table}\\ 

{table:id=|class=servoy sSummary}{colgroup}{column:width=80px|padding=0px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Property Summary{th}{tr}{tbody}{tr}{td}[Number]{td}{td}[#firstForm]
The first form that loads when a solution is deployed.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#i18nDataSource]
The i18n database server connection and database table that stores the i18n keys for a solution.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#loginForm]
The name of the login form that loads when a solution is deployed.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#loginSolutionName]
Get the first module that is also a login solution.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#modulesNames]
The list of modules that have been added to a solution.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#mustAuthenticate]
Flag that tells if authentication is needed in order to access the solution.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{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".{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#textOrientation]
The direction that text is displayed.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#titleText]
The menu bar title of a solution.{td}{tr}{tbody}{table}\\ 

{table:id=event|class=servoy sDetail}{colgroup}{column:width=100%|padding=0px}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Event Details{th}{tr}{tbody:id=onClose-Boolean}{tr:id=name}{td}h6.onClose{td}{tr}{tr:id=des}{td}{div:class=sIndent}The method that is executed when a solution closes. The default is \-none\-.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Boolean]} force -- if false then solution close can be stopped by returning false
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=onDataBroadcast-String_Number_JSDataSet_Boolean}{tr:id=name}{td}h6.onDataBroadcast{td}{tr}{tr:id=des}{td}{div:class=sIndent}Method that is executed when data broadcast occurs. The default is \-none\-.{div}{td}{tr}{tr:id=prs}{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
{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=onError-}{tr:id=name}{td}h6.onError{td}{tr}{tr:id=des}{td}{div:class=sIndent}The method that is executed when a solution opens and an error occurs. The default is \-none.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}ex -- exception to handle
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=onOpen}{tr:id=name}{td}h6.onOpen{td}{tr}{tr:id=des}{td}{div:class=sIndent}The method that is executed when a solution opens. The default is \-none\-.{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}\\ 

{table:id=property|class=servoy sDetail}{colgroup}{column:width=100%|padding=0px}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Property Details{th}{tr}{tbody:id=firstForm}{tr:id=name}{td}h6.firstForm{td}{tr}{tr:id=des}{td}{div:class=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.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=i18nDataSource}{tr:id=name}{td}h6.i18nDataSource{td}{tr}{tr:id=des}{td}{div:class=sIndent}The i18n database server connection and database table that stores the i18n keys for a solution.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=loginForm}{tr:id=name}{td}h6.loginForm{td}{tr}{tr:id=des}{td}{div:class=sIndent}The name of the login form that loads when a solution is deployed.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=loginSolutionName}{tr:id=name}{td}h6.loginSolutionName{td}{tr}{tr:id=des}{td}{div:class=sIndent}Get the first module that is also a login solution.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=modulesNames}{tr:id=name}{td}h6.modulesNames{td}{tr}{tr:id=des}{td}{div:class=sIndent}The list of modules that have been added to a solution.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=mustAuthenticate}{tr:id=name}{td}h6.mustAuthenticate{td}{tr}{tr:id=des}{td}{div:class=sIndent}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.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=solutionType}{tr:id=name}{td}h6.solutionType{td}{tr}{tr:id=des}{td}{div:class=sIndent}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.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=textOrientation}{tr:id=name}{td}h6.textOrientation{td}{tr}{tr:id=des}{td}{div:class=sIndent}The direction that text is displayed. 

Options include: 
DEFAULT
left to right
right to left
locale specific{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=titleText}{tr:id=name}{td}h6.titleText{td}{tr}{tr:id=des}{td}{div:class=sIndent}The menu bar title of a solution.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}