Event Summary | |
---|---|
Boolean | onHide The method that is triggered when another form is being activated. |
onLoad The method that is triggered when a form is loaded/reloaded from the repository; used to alter elements, set globals, hide toolbars, etc; onShow method can also be assigned. |
|
onRecordSelection The method that is triggered each time a record is selected. |
|
onShow The method that is triggered EVERY TIME the form is displayed; an argument must be passed to the method if this is the first time the form is displayed. |
Property Summary | |
---|---|
String | dataSource The names of the database server and table that this form is linked to. |
String | deprecated Gets the deprecate info for this element |
Number | encapsulation The encapsulation mode of this persist. |
String | name The name of the form. |
Number | navigator The navigator is a form that usually handles navigation in application. |
Event Details | |
---|---|
onHide |
|
The method that is triggered when another form is being activated.
NOTE: If the onHide method returns false, the form can be prevented from hiding. For example, when using onHide with showFormInDialog, the form will not close by clicking the dialog close box (X). |
|
Parameters {JSEvent} event - the event that triggered the action
|
|
Returns |
|
onLoad |
|
The method that is triggered when a form is loaded/reloaded from the repository; used to alter elements, set globals, hide toolbars,
etc; onShow method can also be assigned. NOTE: onShow should be used to access current foundset dataproviders; onLoad cannot be used because the foundset data is not loaded until after the form is loaded. Also calls to loadRecords() should be done in the onShow method and not in the onLoad method If you call loadRecords() in the onShow method, you may want to set the namedFoundSet property of the form to 'empty' to prevent the first default form query. NOTE: the onLoad event bubbles down, meaning that the onLoad is first fired on the parent then on a tab in a tabpanel (and in tab of that tab panels if you are 3 deep) |
|
Parameters {JSEvent} event - the event that triggered the action
|
|
onRecordSelection |
|
The method that is triggered each time a record is selected.
If a form is in List view or Special table view - when the user clicks on it. In Record view - after the user navigates to another record using the slider or clicks up or down for next/previous record. NOTE: Data and Servoy tag values are returned when the onRecordSelection method is executed. |
|
Parameters {JSEvent} event - the event that triggered the action
|
|
onShow |
|
The method that is triggered EVERY TIME the form is displayed; an argument must be passed to the method if this is the first time the form is displayed. NOTE: onShow can be used to access current foundset dataproviders; onLoad cannot be used because the foundset data is not loaded until after the form is loaded. NOTE: the onShow event bubbles down, meaning that the onShow event of a form displayed in a tabPanel is fired after the onShow event of the parent. |
|
Parameters |
|
Property Details | |
---|---|
dataSource |
|
The names of the database server and table that this form is linked to.
|
|
Returns |
|
deprecated |
|
Gets the deprecate info for this element
|
|
Returns String - the deprecate info for this element or null if it is not deprecated
|
|
encapsulation |
|
The encapsulation mode of this persist. The following can be used/checked: - Public (not a separate option - if none of the below options are selected) |
|
Returns Number - the encapsulation mode/level of the persist.
|
|
name |
|
The name of the form.
|
|
Returns |
|
navigator |
|
The navigator is a form that usually handles navigation in application. It is displayed on left side of the screen. Can also have value SM_DEFAULTS.NONE (no navigator) or SM_DEFAULTS.IGNORE (reuse current form navigator).
|
|
Returns |
|