JSForm
Constants Summary
Type | Name | Summary |
---|---|---|
Constant used for form namedFoundset property.. | ||
The constants to set or get the view property of a JSForm.. | ||
The constants to set or get the view property of a JSForm.. | ||
The constants to set or get the view property of a JSForm.. | ||
The constants to set or get the view property of a JSForm.. | ||
The constants to set or get the view property of a JSForm.. | ||
Constant used for form selectionMode property.. | ||
Constant used for form selectionMode property.. | ||
Constant used for form selectionMode property.. | ||
Constant used for form namedFoundset property.. |
Property Summary
Type | Name | Summary |
---|---|---|
The type, color and style of border of the component.. | ||
The names of the database server and table that this form is linked to.. | ||
Get or set the encapsulation level for the form.. | ||
A JSForm instance representing the super form of this form, if this form has a super form.. | ||
The default sort order only when the form loads.. | ||
The name of the form.. | ||
Property that tells the form to use a named foundset instead of the default foundset.. | ||
The navigator (previously named "controller") that is used to control/navigate to the form.. | ||
Get or set the ngReadonlyMode for the form.. | ||
This method is triggered when the form wants to hide; this will be called before onHide, and should be used to return if this form can be hidden or not.. | ||
The method that overrides the Servoy menu item Select > Delete All.. | ||
The method that overrides the Servoy menu item Select > Delete Record (or keyboard shortcut).. | ||
The method that overrides the Servoy menu item Select > Duplicate Record (or keyboard shortcut).. | ||
Method that is executed when the data in one of the form's component is successfully changed and the onDataChange callback from the component does not exist or exists and returned true. | ||
The method that is triggered when focus is gained by a component inside the form.. | ||
The method that gets triggered when focus is lost by a component inside the form.. | ||
The method that overrides the Servoy menu item Select > Find (or keyboard shortcut) in Data (ready) mode.. | ||
This method is triggered when the form gets hidden.. | ||
The method that overrides the Servoy menu item Select > Invert Records.. | ||
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.. | ||
The method that overrides the Servoy menu item Select > New Record (or keyboard shortcut).. | ||
The method that overrides the Servoy menu item Select > Next Record.. | ||
The method that overrides the Servoy menu item Select > Omit Record.. | ||
The method that overrides the Servoy menu item Select > Previous Record.. | ||
The method that is triggered when a user clicks into a column on the form.. | ||
The method that is triggered when a record is being saved.. | ||
The method that is triggered each time a record is selected.. | ||
The method that gets triggered when resize occurs.. | ||
The method that overrides the Servoy menu item Select > Search (or keyboard shortcut) in Find mode.. | ||
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.. | ||
The method that overrides the Servoy menu item Select > Show All (or keyboard shortcut).. | ||
The method that overrides the Servoy menu item Select > Show Omitted Records.. | ||
The method that overrides the Servoy menu item Select > Sort.. | ||
The method that is triggered when a form is unloaded from the repository.. | ||
Returns true if this form is in responsive mode. | ||
Scrollbar options for the vertical and horizontal scrollbars.. | ||
Returns the value of the form's selectionMode property.. | ||
Get the server name used by this form.. | ||
When set, the form is displayed under the Window menu.. | ||
The Cascading Style Sheet (CSS) class name applied to the form.. | ||
The [name of the table/SQL view].. | ||
The text that displays in the title bar of the form window.. | ||
When set, the form is transparent.. | ||
Get or set the positioning (either use anchoring or use css position) for the form.. | ||
The default form view mode.. | ||
The width of the form in pixels.. |
Methods Summary
Type | Name | Summary |
---|---|---|
Returns a JSLayoutContainer that has the given name throughout the whole form hierarchy.. | ||
Returns a JSWebComponent that has the given name through the whole hierarchy of JSLayoutContainers. | ||
Returns a JSBean that has the given name.. | ||
Returns all JSBeans of this form.. | ||
Returns all JSBeans of this form.. | ||
Retrieves the Body part of the form.. | ||
Returns a JSButton that has the given name.. | ||
Returns all JSButtons of this form, including the ones without a name.. | ||
Returns all JSButtons of this form, including the ones without a name.. | ||
Returns the comment of this container.. | ||
Returns a JSComponent that has the given name; if found it will be a JSField, JSLabel, JSButton, JSPortal, JSBean, JSWebComponent or JSTabPanel.. | ||
Returns a array of all the JSComponents that a form has; they are of type JSField,JSLabel,JSButton,JSPortal,JSBean, JSWebComponents or JSTabPanel.. | ||
Returns a array of all the JSComponents that a form has; they are of type JSField,JSLabel,JSButton,JSPortal,JSBean, JSWebComponent or JSTabPanel.. | ||
Get a design-time property of a form.. | ||
Get the design-time properties of a form.. | ||
The field with the specified name.. | ||
Returns all JSField objects of this form, including the ones without a name.. | ||
Returns all JSField objects of this form, including the ones without a name.. | ||
Retrieves the Footer part of the form.. | ||
Retrieves the Header part of the form.. | ||
Returns a JSLabel that has the given name.. | ||
Returns all JSLabels of this form (not including its super form), including the ones without a name.. | ||
Returns all JSLabels of this form (optionally including it super forms labels), including the ones without a name.. | ||
Returns a JSLayoutContainer that has the given name of this container.. | ||
Returns all JSLayoutContainers objects of this container.. | ||
Returns all JSLayoutContainers objects of this container. | ||
Retrieves the Leading Grand Summary part of the form.. | ||
Gets an array of the Leading Subsummary parts of the form, ordered by their height from top == 0 to bottom.. | ||
Gets an existing form method for the given name.. | ||
Returns all existing form methods for this form.. | ||
Returns all existing form methods for this form.. | ||
Gets a part of the form from the given type (see JSPart constants).. | ||
Gets a part of the form from the given type (see JSPart constants).. | ||
Returns the Y offset of a given part (see JSPart) of the form.. | ||
Returns the Y offset of a given part (see JSPart) of the form.. | ||
Gets all the parts from the form (not including the parts of the parent form), ordered by there height (lowerbound) property, from top == 0 to bottom.. | ||
Gets all the parts from the form (optionally also from the parent form), ordered by there height (lowerbound) property, from top == 0 to bottom.. | ||
Returns a JSPortal that has the given name.. | ||
Returns all JSPortal objects of this form (not including the ones from the parent form), including the ones without a name.. | ||
Returns all JSPortal objects of this form (optionally also the ones from the parent form), including the ones without a name.. | ||
Returns a JSTabPanel that has the given name.. | ||
Returns all JSTabPanels of this form (not including the ones from the parent form), including the ones without a name.. | ||
Returns all JSTabPanels of this form (optionally the ones from the parent form), including the ones without a name.. | ||
Retrieves the Title Footer part of the form.. | ||
Retrieves the Title Header part of the form.. | ||
Retrieves the Trailing Grand Summary part of the form.. | ||
Gets an array of the Trailing Subsummary parts of the form, ordered by their height from top == 0 to bottom.. | ||
Returns the UUID of this form.. | ||
Gets an existing form variable for the given name.. | ||
An array consisting of all form variables for this form.. | ||
An array consisting of all form variables for this form.. | ||
Returns a JSWebComponent that has the given name that is a child of this layout container.. | ||
Returns all JSWebComponents of this form/container.. | ||
Returns all JSWebComponents of this form/container.. | ||
Creates a new JSBean object on the form - including the name of the JSBean object; the classname the JSBean object is based on, the "x" and "y" position of the JSBean object in pixels, as well as the width and height of the JSBean object in pixels.. | ||
Creates a new button on the form with the given text, place, size and JSMethod as the onAction event triggered action.. | ||
Creates a new button on the form with the given text and JSMethod as the onAction event triggered action.. | ||
Creates a new JSField object on the form with the displayType of CALENDAR - including the dataprovider/JSVariable of the JSField object.. | ||
Creates a new JSField object on the form with the displayType of CALENDAR - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.. | ||
Creates a new JSField object on the form with the displayType of CHECK (checkbox) - including the dataprovider/JSVariable of the JSField object.. | ||
Creates a new JSField object on the form with the displayType of CHECK (checkbox) - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.. | ||
Creates a new JSField object on the form with the displayType of COMBOBOX - including the dataprovider/JSVariable of the JSField object.. | ||
Creates a new JSField object on the form with the displayType of COMBOBOX - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.. | ||
Creates a new JSField object on the form - including the dataprovider/JSVariable of the JSField object.. | ||
Creates a new JSField object on the form - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.. | ||
Creates a new Footer part on the form.. | ||
Creates a new Header part on the form.. | ||
Creates a new JSField object on the form with the displayType of HTML_AREA - including the dataprovider/JSVariable of the JSField object.. | ||
Creates a new JSField object on the form with the displayType of HTML_AREA - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.. | ||
Creates a new JSField object on the form with the displayType of IMAGE_MEDIA - including the dataprovider/JSVariable of the JSField object.. | ||
Creates a new JSField object on the form with the displayType of IMAGE_MEDIA - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.. | ||
Creates a new JSLabel object on the form - including the text of the label.. | ||
Creates a new JSLabel object on the form - including the text of the label, the "x" and "y" position of the label object in pixels, the width and height of the label object in pixels.. | ||
Creates a new JSLabel object on the form - including the text of the label, the "x" and "y" position of the label object in pixels, the width and height of the label object in pixels and a JSMethod action such as the method for an onAction event.. | ||
Create a new layout container as the last child of its parent container.. | ||
Create a new layout container.. | ||
Create a new layout container.. | ||
Create a new layout container as the last child in its parent container.. | ||
Creates a new Leading Grand Summary part on the form.. | ||
Creates a new Leading Subsummary part on the form.. | ||
Creates a new JSField object on the form with the displayType of LISTBOX - including the dataprovider/JSVariable of the JSField object.. | ||
Creates a new JSField object on the form with the displayType of LISTBOX - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.. | ||
Creates a new form JSMethod - based on the specified code.. | ||
Creates a new JSField object on the form with the displayType of MULTISELECT_LISTBOX - including the dataprovider/JSVariable of the JSField object.. | ||
Creates a new JSField object on the form with the displayType of MULTISELECT_LISTBOX - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.. | ||
Creates a new part on the form.. | ||
Creates a new JSField object on the form with the displayType of PASSWORD - including the dataprovider/JSVariable of the JSField object.. | ||
Creates a new JSField object on the form with the displayType of PASSWORD - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.. | ||
Creates a new JSPortal object on the form - including the name of the JSPortal object and the relation the JSPortal object is based on.. | ||
Creates a new JSPortal object on the form - including the name of the JSPortal object; the relation the JSPortal object is based on, the "x" and "y" position of the JSPortal object in pixels, as well as the width and height of the JSPortal object in pixels.. | ||
Creates a new JSField object on the form with the displayType of RADIOS (radio buttons) - including the dataprovider/JSVariable of the JSField object.. | ||
Creates a new JSField object on the form with the displayType of RADIOS (radio buttons) - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.. | ||
Creates a new JSField object on the form with the displayType of RTF_AREA (enables more than one line of text to be displayed in a field) - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.. | ||
Creates a new JSField object on the form with the displayType of SPINNER - including the dataprovider/JSVariable of the JSField object.. | ||
Creates a new JSField object on the form with the displayType of SPINNER - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.. | ||
Creates a new JSTabPanel object on the form - including the name of the JSTabPanel object.. | ||
Creates a new JSTabPanel object on the form - including the name of the JSTabPanel object, the "x" and "y" position of the JSTabPanel object in pixels, as well as the width and height of the JSTabPanel object in pixels.. | ||
Creates a new JSField object on the form with the displayType of TEXT_AREA - including the dataprovider/JSVariable of the JSField object.. | ||
Creates a new JSField object on the form with the displayType of TEXT_AREA - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.. | ||
Creates a new JSField object on the form with the displayType of TEXT_FIELD - including the dataprovider/JSVariable of the JSField object.. | ||
Creates a new JSField object on the form with the displayType of TEXT_FIELD - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.. | ||
Creates a new Title Footer part on the form.. | ||
Creates a new Title Header part on the form.. | ||
Creates a new Trailing Grand Summary part on the form.. | ||
Creates a new Trailing Subsummary part on the form.. | ||
Creates a new JSField object on the form with the displayType of TYPE_AHEAD - including the dataprovider/JSVariable of the JSField object.. | ||
Creates a new JSField object on the form with the displayType of TYPE_AHEAD - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.. | ||
Creates a new form JSVariable - based on the name of the variable object and the number type, uses the SolutionModel JSVariable constants.. | ||
Creates a new form JSVariable - based on the name of the variable object , the type and it's default value , uses the SolutionModel JSVariable constants.. | ||
Creates a new JSWebComponent (spec based component) object on the RESPONSIVE form.. | ||
Creates a new JSWebComponent (spec based component) object on the RESPONSIVE form.. | ||
Creates a new JSWebComponent (spec based component) object on a form.. | ||
Creates a new JSWebComponent (spec based component) object on the RESPONSIVE form.. | ||
Creates a new JSWebComponent (spec based component) object on the form.. | ||
Set a design-time property of a form.. | ||
Removes a JSBean that has the specified name.. | ||
Removes a JSButton that has the specified name.. | ||
Removes a component (JSLabel, JSButton, JSField, JSPortal, JSBean, JSTabpanel, JSWebComponent) that has the given name.. | ||
Clear a design-time property of a form.. | ||
Removes a JSField that has the given name.. | ||
Removes a JSLabel that has the given name.. | ||
Removes a form JSMethod - based on the specified code.. | ||
Removes a JSPart of the given type.. | ||
Removes a JSPart of the given type.. | ||
Removes a JSPortal that has the given name.. | ||
Removes a JSTabPanel that has the given name.. | ||
Removes a form JSVariable - based on the name of the variable object.. | ||
Removes a JSWebComponent that has the specified name.. |
Constants Details
EMPTY_FOUNDSET
Constant used for form namedFoundset property. The form that uses empty namedFoundset will initially have an empty (cleared) foundset.
Returns String
Sample
LIST_VIEW
The constants to set or get the view property of a JSForm. They are as follows: JSForm.LIST_VIEW, JSForm.LOCKED_LIST_VIEW, JSForm.LOCKED_RECORD_VIEW, JSForm.LOCKED_TABLE_VIEW, JSForm.RECORD_VIEW.
Returns Number
Sample
LOCKED_LIST_VIEW
The constants to set or get the view property of a JSForm. They are as follows: JSForm.LIST_VIEW, JSForm.LOCKED_LIST_VIEW, JSForm.LOCKED_RECORD_VIEW, JSForm.LOCKED_TABLE_VIEW, JSForm.RECORD_VIEW.
Returns Number
Sample
LOCKED_RECORD_VIEW
The constants to set or get the view property of a JSForm. They are as follows: JSForm.LIST_VIEW, JSForm.LOCKED_LIST_VIEW, JSForm.LOCKED_RECORD_VIEW, JSForm.LOCKED_TABLE_VIEW, JSForm.RECORD_VIEW.
Returns Number
Sample
LOCKED_TABLE_VIEW
The constants to set or get the view property of a JSForm. They are as follows: JSForm.LIST_VIEW, JSForm.LOCKED_LIST_VIEW, JSForm.LOCKED_RECORD_VIEW, JSForm.LOCKED_TABLE_VIEW, JSForm.RECORD_VIEW.
Returns Number
Sample
RECORD_VIEW
The constants to set or get the view property of a JSForm. They are as follows: JSForm.LIST_VIEW, JSForm.LOCKED_LIST_VIEW, JSForm.LOCKED_RECORD_VIEW, JSForm.LOCKED_TABLE_VIEW, JSForm.RECORD_VIEW.
Returns Number
Sample
SELECTION_MODE_DEFAULT
Constant used for form selectionMode property. It means that the foundset's multiSelect property is used.
Returns Number
Sample
SELECTION_MODE_MULTI
Constant used for form selectionMode property. It means that the form will force multiSelect to true on the foundset it uses.
Returns Number
Sample
SELECTION_MODE_SINGLE
Constant used for form selectionMode property. It means that the form will force multiSelect to false on the foundset it uses.
Returns Number
Sample
SEPARATE_FOUNDSET
Constant used for form namedFoundset property. The form that uses a separate namedFoundset will initially have an separate (not shared with other forms) foundset.
Returns String
Sample
Properties Details
borderType
The type, color and style of border of the component.
Returns String
Sample
dataSource
The names of the database server and table that this form is linked to.
Returns String
Sample
encapsulation
Get or set the encapsulation level for the form.
Encapsulation is one of constants JSForm.DEFAULT_ENCAPSULATION, JSForm.PRIVATE_ENCAPSULATION, JSForm.MODULE_PRIVATE_ENCAPSULATION, JSForm.HIDE_DATAPROVIDERS_ENCAPSULATION, JSForm.HIDE_FOUNDSET_ENCAPSULATION, JSForm.HIDE_CONTROLLER_ENCAPSULATION or JSForm.HIDE_ELEMENTS_ENCAPSULATION
Returns Number
Sample
extendsForm
A JSForm instance representing the super form of this form, if this form has a super form.
Returns JSForm
Sample
initialSort
The default sort order only when the form loads. This is applied each time an internal SQL query is being executed (find, find-all, open form); and is only executed when no other manual sort has been performed on the foundset.
Returns String
Sample
name
The name of the form.
Returns String
Sample
namedFoundSet
Property that tells the form to use a named foundset instead of the default foundset. When JSForm.SEPARATE_FOUNDSET is specified the form will always create a copy of assigned foundset and therefore become separated from other foundsets. When JSForm.EMPTY_FOUNDSET, the form will have an initially empty foundset.
The namedFoundset can be based on a global relation; in this case namedFoundset is the relation's name. You can also set the namedFoundset to a JSRelation object directly. It will tell this form to initially load a global relation based foundset. The global relation's foreign datasource must match the form's datasource. Do not use relations named "empty" or "separate" to avoid confusions.
Returns String
Sample
navigator
The navigator (previously named "controller") that is used to control/navigate to the form. The navigator is shown at the left or at the right side of the form, depending on the page orientation.
The following options are available: -none- - no navigator is assigned. DEFAULT - the Servoy default navigator is assigned. IGNORE - the navigator last assigned to a previous form. Custom - a custom navigator based on a selected form.
Returns Object
Sample
ngReadOnlyMode
Get or set the ngReadonlyMode for the form. This flag is a performance optimization for tableview/listview to show labels instead of editable fields.
Returns Boolean
Sample
onBeforeHide
This method is triggered when the form wants to hide; this will be called before onHide, and should be used to return if this form can be hidden or not. Before the form is really going to hide, this form and all the forms that this form is also showing in its ui hierarchy must allow the hide (return true in onBeforeHide - if present). For example, when using onBeforeHide with showFormInDialog, the form will not close by clicking the dialog close box (X) if the main form in the dialog or any of the other visible forms in tabpanels/containers are nested in the main are returning false.
If the hide operation is allowed for all the forms that are in the affected visible hierarchy, then the onHide handler/method will get called on them as well afterwards.
So this handler (on each form) can be used to validate input in the main form and/or any nested visible forms - that are getting ready to hide.
Returns JSMethod
Sample
onDeleteAllRecordsCmd
The method that overrides the Servoy menu item Select > Delete All. This property is automatically set to "DEFAULT" (no override) when the form is created.
Returns JSMethod
Sample
onDeleteRecordCmd
The method that overrides the Servoy menu item Select > Delete Record (or keyboard shortcut). This property is automatically set to "DEFAULT" (no override) when the form is created.
Returns JSMethod
Sample
onDuplicateRecordCmd
The method that overrides the Servoy menu item Select > Duplicate Record (or keyboard shortcut). This property is automatically set to "DEFAULT" (no override) when the form is created.
Returns JSMethod
Sample
onElementDataChange
Method that is executed when the data in one of the form's component is successfully changed and the onDataChange callback from the component does not exist or exists and returned true
Returns JSMethod
Sample
onElementFocusGained
The method that is triggered when focus is gained by a component inside the form.
Returns JSMethod
Sample
onElementFocusLost
The method that gets triggered when focus is lost by a component inside the form.
Returns JSMethod
Sample
onFindCmd
The method that overrides the Servoy menu item Select > Find (or keyboard shortcut) in Data (ready) mode. This property is automatically set to "DEFAULT" (no override) when the form is created.
Returns JSMethod
Sample
onHide
This method is triggered when the form gets hidden.
Return value is DEPRECATED: false return value should no longer be used. In the past, if the onHide method returned false, the form hide could be prevented from happening in some cases (for example, when using onHide with showFormInDialog, the form will not close by clicking the dialog close box (X)). But that lead to unexpected situations when the form being hidden had visible nested children it it (tab panels, splits etc.) because only the current form would decide if hide could be denied, and all other forms, even if they returned false in their on-hide, would not be able to block the hide if this form allowed it. So those nested forms might think that they are still visible even though they are not.
Please use the new onBeforeHide method/handler instead if you want to prevent forms from hiding.
Returns JSMethod
Sample
onInvertRecordsCmd
The method that overrides the Servoy menu item Select > Invert Records. This property is automatically set to "DEFAULT" (no override) when the form is created.
Returns JSMethod
Sample
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)
Returns JSMethod
Sample
onNewRecordCmd
The method that overrides the Servoy menu item Select > New Record (or keyboard shortcut). This property is automatically set to "DEFAULT" (no override) when the form is created.
Returns JSMethod
Sample
onNextRecordCmd
The method that overrides the Servoy menu item Select > Next Record. This property is automatically set to "DEFAULT" (no override) when the form is created.
Returns JSMethod
Sample
onOmitRecordCmd
The method that overrides the Servoy menu item Select > Omit Record. This property is automatically set to "DEFAULT" (no override) when the form is created.
Returns JSMethod
Sample
onPreviousRecordCmd
The method that overrides the Servoy menu item Select > Previous Record. This property is automatically set to "DEFAULT" (no override) when the form is created.
Returns JSMethod
Sample
onRecordEditStart
The method that is triggered when a user clicks into a column on the form. NOTE: There is a small "e" displayed in the lower left side of the Servoy Client screen in the status area at the bottom of the window when the record is being edited.
Returns JSMethod
Sample
onRecordEditStop
The method that is triggered when a record is being saved. A record is saved when a user clicks out of it (for example on an empty part of the layout or to another form). When the method returns false (for example as part of a validation), the user cannot leave the record, for example in a table view a user cannot move to another record when the callback returns false.
Returns JSMethod
Sample
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. NOTE: this will also fire if the selection goes to -1 because the foundset is cleared. So foundset.getSelectedRecord() can return null.
Returns JSMethod
Sample
onResize
The method that gets triggered when resize occurs.
Returns JSMethod
Sample
onSearchCmd
The method that overrides the Servoy menu item Select > Search (or keyboard shortcut) in Find mode. This property is automatically set to "DEFAULT" (no override) when the form is created.
Returns JSMethod
Sample
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.
Returns JSMethod
Sample
onShowAllRecordsCmd
The method that overrides the Servoy menu item Select > Show All (or keyboard shortcut). This property is automatically set to "DEFAULT" (no override) when the form is created.
Returns JSMethod
Sample
onShowOmittedRecordsCmd
The method that overrides the Servoy menu item Select > Show Omitted Records. This property is automatically set to "DEFAULT" (no override) when the form is created.
Returns JSMethod
Sample
onSortCmd
The method that overrides the Servoy menu item Select > Sort. This property is automatically set to "DEFAULT" (no override) when the form is created.
Returns JSMethod
Sample
onUnLoad
The method that is triggered when a form is unloaded from the repository. NOTE: Forms can be prevented from being removed from memory by referencing the form object in a global variable or inside an array inside a global variable. Do take care using this technique. Forms take up memory and if too many forms are in memory and cannot be unloaded, there is a possibility of running out of memory.
Returns JSMethod
Sample
responsiveLayout
Returns true if this form is in responsive mode
Returns Boolean
Sample
scrollbars
Scrollbar options for the vertical and horizontal scrollbars. Each of the vertical and horizontal scrollbars can be configured to display all the time, to display only when needed or to never display.
Returns Number
Sample
selectionMode
Returns the value of the form's selectionMode property. Selection mode is applied when necessary to the foundset used by the form (through it's multiSelect property), even if the foundset changes. If two or more forms with non-default and different selectionMode values share the same foundset, the visible one decides. If two or more non-visible forms with non-default and different selectionMode values share the same foundset, one of them (always the same from a set of forms) decides. If two or more visible forms with non-default and different selectionMode values share the same foundset, one of them (always the same from a set of forms) decides what the foundset's selectionMode should be.
Can be one of SELECTION_MODE_DEFAULT, SELECTION_MODE_SINGLE or SELECTION_MODE_MULTI.
Returns Number
Sample
serverName
Get the server name used by this form.
Returns String
Sample
showInMenu
When set, the form is displayed under the Window menu. If it is not set, the form will be 'hidden'. NOTE: This is only applicable for Servoy Client. Servoy Developer always shows all forms so that developers have access to all forms within a solution during development.
Returns Boolean
Sample
styleClass
The Cascading Style Sheet (CSS) class name applied to the form.
Returns String
Sample
tableName
The [name of the table/SQL view].[the name of the database server connection] the form is based on.
Returns String
Sample
titleText
The text that displays in the title bar of the form window. NOTE: Data tags and Servoy tags can be used as part of the title text.
Returns String
Sample
transparent
When set, the form is transparent.
Returns Boolean
Sample
useCssPosition
Get or set the positioning (either use anchoring or use css position) for the form. This is only working for absolute layout forms in NGClient.
Returns Boolean
Sample
view
The default form view mode.
The view can be changed using a method at runtime. The following views are available:
Record view
List view
Record view (locked)
List view (locked)
Table View (locked)
NOTE: Only Table View (locked) uses asynchronized related data loading. This feature defers all related foundset data loading to the background - enhancing the visual display of a related foundset.
Returns Number
Sample
width
The width of the form in pixels.
Returns Number
Sample
Methods Details
findLayoutContainer(name)
Returns a JSLayoutContainer that has the given name throughout the whole form hierarchy.
Parameters String name the specified name of the container
Returns JSLayoutContainer a JSLayoutContainer object
Sample
findWebComponent(name)
Returns a JSWebComponent that has the given name through the whole hierarchy of JSLayoutContainers
Parameters String name the specified name of the web component
Returns JSComponent a JSWebComponent object
Sample
getBean(name)
Returns a JSBean that has the given name.
Parameters String name the specified name of the bean
Returns JSComponent a JSBean object
Sample
getBeans()
Returns all JSBeans of this form.
Returns Array the list of all JSBeans on this forms
Sample
getBeans(returnInheritedElements)
Returns all JSBeans of this form.
Parameters Boolean returnInheritedElements true to also return the elements from parent form
Returns Array the list of all JSBeans on this forms
Sample
getBodyPart()
Retrieves the Body part of the form.
Returns JSPart A JSPart instance corresponding to the Body part of the form.
Sample
getButton(name)
Returns a JSButton that has the given name.
Parameters String name the specified name of the button
Returns JSComponent a JSButton object
Sample
getButtons()
Returns all JSButtons of this form, including the ones without a name.
Returns Array the list of all JSButtons on this forms
Sample
getButtons(returnInheritedElements)
Returns all JSButtons of this form, including the ones without a name.
Parameters Boolean returnInheritedElements true to also return the elements from parent form
Returns Array the list of all JSButtons on this forms
Sample
getComment()
Returns the comment of this container.
Returns String
Sample
getComponent(name)
Returns a JSComponent that has the given name; if found it will be a JSField, JSLabel, JSButton, JSPortal, JSBean, JSWebComponent or JSTabPanel.
Parameters String name the specified name of the component
Returns JSComponent a JSComponent object (might be a JSField, JSLabel, JSButton, JSPortal, JSBean, JSWebComponent or JSTabPanel)
Sample
getComponents()
Returns a array of all the JSComponents that a form has; they are of type JSField,JSLabel,JSButton,JSPortal,JSBean, JSWebComponents or JSTabPanel.
Returns Array an array of all the JSComponents on the form.
Sample
getComponents(returnInheritedElements)
Returns a array of all the JSComponents that a form has; they are of type JSField,JSLabel,JSButton,JSPortal,JSBean, JSWebComponent or JSTabPanel.
Parameters Boolean returnInheritedElements true to also return the elements from the parent form
Returns Array an array of all the JSComponents on the form.
Sample
getDesignTimeProperty(key)
Get a design-time property of a form.
Parameters String key the property name
Returns Object
Sample
getDesignTimePropertyNames()
Get the design-time properties of a form.
Returns Array
Sample
getField(name)
The field with the specified name.
Parameters String name the specified name of the field
Returns JSField a JSField object
Sample
getFields()
Returns all JSField objects of this form, including the ones without a name.
Returns Array all JSField objects of this form
Sample
getFields(returnInheritedElements)
Returns all JSField objects of this form, including the ones without a name.
Parameters Boolean returnInheritedElements true to also return the elements from the parent form
Returns Array all JSField objects of this form
Sample
getFooterPart()
Retrieves the Footer part of the form.
Returns JSPart A JSPart instance corresponding to the Footer part of the form.
Sample
getHeaderPart()
Retrieves the Header part of the form.
Returns JSPart A JSPart instance corresponding to the Header part of the form.
Sample
getLabel(name)
Returns a JSLabel that has the given name.
Parameters String name the specified name of the label
Returns JSComponent a JSLabel object (or null if the label with the specified name does not exist)
Sample
getLabels()
Returns all JSLabels of this form (not including its super form), including the ones without a name.
Returns Array all JSLabels on this form
Sample
getLabels(returnInheritedElements)
Returns all JSLabels of this form (optionally including it super forms labels), including the ones without a name.
Parameters Boolean returnInheritedElements true to also return the elements from parent form
Returns Array all JSLabels on this form
Sample
getLayoutContainer(name)
Returns a JSLayoutContainer that has the given name of this container. Use findLayoutContainer() method to find a JSLayoutContainter through the hierarchy
Parameters String name the specified name of the container
Returns JSLayoutContainer a JSLayoutContainer object
Sample
getLayoutContainers()
Returns all JSLayoutContainers objects of this container. Does not return the inherited containers, use #getLayoutContainers(true) to get the inherited as well.
Returns Array all JSLayoutContainers objects of this container
Sample
getLayoutContainers(returnInheritedElements)
Returns all JSLayoutContainers objects of this container
Parameters Boolean returnInheritedElements true to also return the elements from parent form
Returns Array all JSLayoutContainers objects of this container
Sample
getLeadingGrandSummaryPart()
Retrieves the Leading Grand Summary part of the form.
Returns JSPart A JSPart instance corresponding to the Leading Grand Summary part of the form.
Sample
getLeadingSubSummaryParts()
Gets an array of the Leading Subsummary parts of the form, ordered by their height from top == 0 to bottom.
Returns Array An array of JSPart instances corresponding to the Leading Subsummary parts of the form.
Sample
getMethod(name)
Gets an existing form method for the given name.
Parameters String name the specified name of the method
Returns JSMethod a JSMethod object (or null if the method with the specified name does not exist)
Sample
getMethods()
Returns all existing form methods for this form.
Returns Array all form methods for the form
Sample
getMethods(returnInheritedElements)
Returns all existing form methods for this form.
Parameters Boolean returnInheritedElements true to also return the elements from the parent form
Returns Array all form methods for the form
Sample
getPart(type)
Gets a part of the form from the given type (see JSPart constants).
Parameters Number type The type of the part to retrieve.
Returns JSPart A JSPart instance representing the retrieved form part.
Sample
getPart(type, height)
Gets a part of the form from the given type (see JSPart constants). Use the height if you want to get a specific LEADING_SUBSUMMARY or TRAILING_SUBSUMMARY.
Parameters Number type The type of the part to retrieve. Number height The height of the part to retrieve. Use this parameter when retrieving one of multiple Leading/Trailing Subsummary parts.
Returns JSPart A JSPart instance representing the retrieved form part.
Sample
getPartYOffset(type)
Returns the Y offset of a given part (see JSPart) of the form. This will include all the super forms parts if this form extends a form.
Parameters Number type The type of the part whose Y offset will be returned.
Returns Number A number holding the Y offset of the specified form part.
Sample
getPartYOffset(type, height)
Returns the Y offset of a given part (see JSPart) of the form. This will include all the super forms parts if this form extends a form. Use the height parameter for targetting one of multiple subsummary parts.
Parameters Number type The type of the part whose Y offset will be returned. Number height The height of the part whose Y offset will be returned. This is used when one of multiple Leading/Trailing Sumsummary parts is retrieved.
Returns Number A number holding the Y offset of the specified form part.
Sample
getParts()
Gets all the parts from the form (not including the parts of the parent form), ordered by there height (lowerbound) property, from top == 0 to bottom.
Returns Array An array of JSPart instances corresponding to the parts of the form.
Sample
getParts(returnInheritedElements)
Gets all the parts from the form (optionally also from the parent form), ordered by there height (lowerbound) property, from top == 0 to bottom.
Parameters Boolean returnInheritedElements true to also return the parts from parent form
Returns Array An array of JSPart instances corresponding to the parts of the form.
Sample
getPortal(name)
Returns a JSPortal that has the given name.
Parameters String name the specified name of the portal
Returns JSComponent a JSPortal object
Sample
getPortals()
Returns all JSPortal objects of this form (not including the ones from the parent form), including the ones without a name.
Returns Array an array of all JSPortal objects on this form
Sample
getPortals(returnInheritedElements)
Returns all JSPortal objects of this form (optionally also the ones from the parent form), including the ones without a name.
Parameters Boolean returnInheritedElements true to also return the elements from parent form
Returns Array an array of all JSPortal objects on this form
Sample
getTabPanel(name)
Returns a JSTabPanel that has the given name.
Parameters String name the specified name of the tabpanel
Returns JSComponent a JSTabPanel object
Sample
getTabPanels()
Returns all JSTabPanels of this form (not including the ones from the parent form), including the ones without a name.
Returns Array an array of all JSTabPanel objects on this form
Sample
getTabPanels(returnInheritedElements)
Returns all JSTabPanels of this form (optionally the ones from the parent form), including the ones without a name.
Parameters Boolean returnInheritedElements true to also return the elements from parent form
Returns Array an array of all JSTabPanel objects on this form
Sample
getTitleFooterPart()
Retrieves the Title Footer part of the form.
Returns JSPart A JSPart instance corresponding to the Title Footer part of the form.
Sample
getTitleHeaderPart()
Retrieves the Title Header part of the form.
Returns JSPart A JSPart instance corresponding to the Title Header part of the form.
Sample
getTrailingGrandSummaryPart()
Retrieves the Trailing Grand Summary part of the form.
Returns JSPart A JSPart instance corresponding to the Trailing Grand Summary part of the form.
Sample
getTrailingSubSummaryParts()
Gets an array of the Trailing Subsummary parts of the form, ordered by their height from top == 0 to bottom.
Returns Array An array of JSPart instances corresponding to the Trailing Subsummary parts of the form.
Sample
getUUID()
Returns the UUID of this form.
Returns UUID
Sample
getVariable(name)
Gets an existing form variable for the given name.
Parameters String name the specified name of the variable
Returns JSVariable a JSVariable object
Sample
getVariables()
An array consisting of all form variables for this form.
Returns Array an array of all variables on this form
Sample
getVariables(returnInheritedElements)
An array consisting of all form variables for this form.
Parameters Boolean returnInheritedElements true to also return the elements from the parent form
Returns Array an array of all variables on this form
Sample
getWebComponent(name)
Returns a JSWebComponent that has the given name that is a child of this layout container. Use findWebComponent() to find a webcomponent through the hierarchy
Parameters String name the specified name of the web component
Returns JSComponent a JSWebComponent object
Sample
getWebComponents()
Returns all JSWebComponents of this form/container. If this method is called on a form, then it will return all web components on that form. If the form is responsive, it will return the web components from all the containers. It does not return the inherited components, use #getWebComponents(true) to get the inherited as well.
Returns Array the list of all JSWebComponent on this forms
Sample
getWebComponents(returnInheritedElements)
Returns all JSWebComponents of this form/container. If this method is called on a form, then it will return all web components on that form. If the form is responsive, it will return the web components from all the containers.
Parameters Boolean returnInheritedElements true to also return the elements from parent form
Returns Array the list of all JSWebComponents on this forms
Sample
newBean(name, className, x, y, width, height)
Creates a new JSBean object on the form - including the name of the JSBean object; the classname the JSBean object is based on, the "x" and "y" position of the JSBean object in pixels, as well as the width and height of the JSBean object in pixels.
Parameters String name the specified name of the JSBean object String className the class name of the JSBean object Number x the horizontal "x" position of the JSBean object in pixels Number y the vertical "y" position of the JSBean object in pixels Number width the width of the JSBean object in pixels Number height the height of the JSBean object in pixels
Returns JSComponent a JSBean object
Sample
newButton(txt, x, y, width, height, action)
Creates a new button on the form with the given text, place, size and JSMethod as the onAction event triggered action.
Parameters String txt the text on the button Number x the x coordinate of the button location on the form Number y the y coordinate of the button location on the form Number width the width of the button Number height the height of the button Object action the method assigned to handle an onAction event
Returns JSComponent a new JSButton object
Sample
newButton(txt, action)
Creates a new button on the form with the given text and JSMethod as the onAction event triggered action. You must set location/dimension or css position afterwards
Parameters String txt the text on the button Object action the method assigned to handle an onAction event
Returns JSComponent a new JSButton object
Sample
newCalendar(dataprovider)
Creates a new JSField object on the form with the displayType of CALENDAR - including the dataprovider/JSVariable of the JSField object. You must set location/dimension or css position afterwards
Parameters Object dataprovider the specified dataprovider name/JSVariable of the JSField object
Returns JSField a new JSField object on the form with the displayType of CALENDAR
Sample
newCalendar(dataprovider, x, y, width, height)
Creates a new JSField object on the form with the displayType of CALENDAR - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.
Parameters Object dataprovider the specified dataprovider name/JSVariable of the JSField object Number x the horizontal "x" position of the JSfield object in pixels Number y the vertical "y" position of the JSField object in pixels Number width the width of the JSField object in pixels Number height the height of the JSField object in pixels
Returns JSField a new JSField object on the form with the displayType of CALENDAR
Sample
newCheck(dataprovider)
Creates a new JSField object on the form with the displayType of CHECK (checkbox) - including the dataprovider/JSVariable of the JSField object. You must set location/dimension or css position afterwards
Parameters Object dataprovider the specified dataprovider name/JSVariable of the JSField object
Returns JSField a new JSField object on the form with the displayType of CHECK (checkbox)
Sample
newCheck(dataprovider, x, y, width, height)
Creates a new JSField object on the form with the displayType of CHECK (checkbox) - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.
Parameters Object dataprovider the specified dataprovider name/JSVariable of the JSField object Number x the horizontal "x" position of the JSfield object in pixels Number y the vertical "y" position of the JSField object in pixels Number width the width of the JSField object in pixels Number height the height of the JSField object in pixels
Returns JSField a new JSField object on the form with the displayType of CHECK (checkbox)
Sample
newComboBox(dataprovider)
Creates a new JSField object on the form with the displayType of COMBOBOX - including the dataprovider/JSVariable of the JSField object. You must set location/dimension or css position afterwards
Parameters Object dataprovider the specified dataprovider name/JSVariable of the JSField object
Returns JSField a new JSField object on the form with the displayType of COMBOBOX
Sample
newComboBox(dataprovider, x, y, width, height)
Creates a new JSField object on the form with the displayType of COMBOBOX - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.
Parameters Object dataprovider the specified dataprovider name/JSVariable of the JSField object Number x the horizontal "x" position of the JSfield object in pixels Number y the vertical "y" position of the JSField object in pixels Number width the width of the JSField object in pixels Number height the height of the JSField object in pixels
Returns JSField a new JSField object on the form with the displayType of COMBOBOX
Sample
newField(dataprovider, type)
Creates a new JSField object on the form - including the dataprovider/JSVariable of the JSField object. You must set location/dimension or css position afterwards
Parameters Object dataprovider the specified dataprovider name/JSVariable of the JSField object Number type the display type of the JSField object (see the Solution Model -> JSField node for display types)
Returns JSField
Sample
newField(dataprovider, type, x, y, width, height)
Creates a new JSField object on the form - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.
Parameters Object dataprovider the specified dataprovider name/JSVariable of the JSField object Number type the display type of the JSField object (see the Solution Model -> JSField node for display types) Number x the horizontal "x" position of the JSField object in pixels Number y the vertical "y" position of the JSField object in pixels Number width the width of the JSField object in pixels Number height the height of the JSField object in pixels
Returns JSField a new JSField object (of the specified display type)
Sample
newFooterPart(height)
Creates a new Footer part on the form.
Parameters Number height The height of the new part
Returns JSPart A JSFooter instance corresponding to the newly created Footer form part.
Sample
newHeaderPart(height)
Creates a new Header part on the form.
Parameters Number height The height of the new part
Returns JSPart A JSPart instance corresponding to the newly created Header form part.
Sample
newHtmlArea(dataprovider)
Creates a new JSField object on the form with the displayType of HTML_AREA - including the dataprovider/JSVariable of the JSField object. You must set location/dimension or css position afterwards
Parameters Object dataprovider the specified dataprovider name/JSVariable of the JSField object
Returns JSField a JSField object on the form with the displayType of HTML_AREA
Sample
newHtmlArea(dataprovider, x, y, width, height)
Creates a new JSField object on the form with the displayType of HTML_AREA - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.
Parameters Object dataprovider the specified dataprovider name/JSVariable of the JSField object Number x the horizontal "x" position of the JSfield object in pixels Number y the vertical "y" position of the JSField object in pixels Number width the width of the JSField object in pixels Number height the height of the JSField object in pixels
Returns JSField a JSField object on the form with the displayType of HTML_AREA
Sample
newImageMedia(dataprovider)
Creates a new JSField object on the form with the displayType of IMAGE_MEDIA - including the dataprovider/JSVariable of the JSField object. You must set location/dimension or css position afterwards
Parameters Object dataprovider the specified dataprovider name/JSVariable of the JSField object
Returns JSField a new JSField object on the form with the displayType of IMAGE_MEDIA
Sample
newImageMedia(dataprovider, x, y, width, height)
Creates a new JSField object on the form with the displayType of IMAGE_MEDIA - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.
Parameters Object dataprovider the specified dataprovider name/JSVariable of the JSField object Number x the horizontal "x" position of the JSfield object in pixels Number y the vertical "y" position of the JSField object in pixels Number width the width of the JSField object in pixels Number height the height of the JSField object in pixels
Returns JSField a new JSField object on the form with the displayType of IMAGE_MEDIA
Sample
newLabel(txt)
Creates a new JSLabel object on the form - including the text of the label. You must set location/dimension or css position afterwards
Parameters String txt the specified text of the label object
Returns JSComponent a JSLabel object
Sample
newLabel(txt, x, y, width, height)
Creates a new JSLabel object on the form - including the text of the label, the "x" and "y" position of the label object in pixels, the width and height of the label object in pixels.
Parameters String txt the specified text of the label object Number x the horizontal "x" position of the label object in pixels Number y the vertical "y" position of the label object in pixels Number width the width of the label object in pixels Number height the height of the label object in pixels
Returns JSComponent a JSLabel object
Sample
newLabel(txt, x, y, width, height, action)
Creates a new JSLabel object on the form - including the text of the label, the "x" and "y" position of the label object in pixels, the width and height of the label object in pixels and a JSMethod action such as the method for an onAction event.
Parameters String txt the specified text of the label object Number x the horizontal "x" position of the label object in pixels Number y the vertical "y" position of the label object in pixels Number width the width of the label object in pixels Number height the height of the label object in pixels Object action the event action JSMethod of the label object
Returns JSComponent a JSLabel object
Sample
newLayoutContainer()
Create a new layout container as the last child of its parent container. This method can only be used in responsive forms.
If you want to use default values and so on from a layout package (like 12grid) or if you use the solution model to create a form that is saved back into the workspace (servoyDeveloper.save(form)) then you have to set the packageName and specName properties. So that it works later on in the designer.
If the packageName and specName are not provided, then: the packageName is the same as for the parent container the specName is the first allowed child defined in the specification of the parent container
If the specification of the parent container does not defined allowed children, then if it is not empty the packageName and the specName are copied from the first child layout container.
Returns JSLayoutContainer the new layout container
Sample
newLayoutContainer(position)
Create a new layout container. The position is used to determine the generated order in html markup. This method can only be used in responsive forms.
If you want to use default values and so on from a layout package (like 12grid) or if you use the solution model to create a form that is saved back into the workspace (servoyDeveloper.save(form)) then you have to set the packageName and specName properties. So that it works later on in the designer.
If the packageName and specName are not provided, then: the packageName is the same as for the parent container the specName is the first allowed child defined in the specification of the parent container
If the specification of the parent container does not defined allowed children, then if it is not empty the packageName and the specName are copied from the first child layout container.
Parameters Number position the position of JSWebComponent object in its parent container
Returns JSLayoutContainer the new layout container
Sample
newLayoutContainer(position, spec)
Create a new layout container. The position is used to determine the generated order in html markup. This method can only be used in responsive forms.
Parameters Number position the position of JSWebComponent object in its parent container String spec a string of the form 'packageName-layoutName', or 'layoutName'
Returns JSLayoutContainer the new layout container
Sample
newLayoutContainer(spec)
Create a new layout container as the last child in its parent container. This method can only be used in responsive forms.
Parameters String spec a string of the form 'packageName-layoutName', or 'layoutName'
Returns JSLayoutContainer the new layout container
Sample
newLeadingGrandSummaryPart(height)
Creates a new Leading Grand Summary part on the form.
Parameters Number height The height of the new part
Returns JSPart A JSPart instance corresponding to the newly created Leading Grand Summary form part.
Sample
newLeadingSubSummaryPart(height)
Creates a new Leading Subsummary part on the form.
Parameters Number height The height of the new part
Returns JSPart A JSPart instance corresponding to the newly created Leading Subsummary form part.
Sample
newListBox(dataprovider)
Creates a new JSField object on the form with the displayType of LISTBOX - including the dataprovider/JSVariable of the JSField object. You must set location/dimension or css position afterwards
Parameters Object dataprovider the specified dataprovider name/JSVariable of the JSField object
Returns JSField a new JSField object on the form with the displayType of LISTBOX
Sample
newListBox(dataprovider, x, y, width, height)
Creates a new JSField object on the form with the displayType of LISTBOX - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.
Parameters Object dataprovider the specified dataprovider name/JSVariable of the JSField object Number x the horizontal "x" position of the JSfield object in pixels Number y the vertical "y" position of the JSField object in pixels Number width the width of the JSField object in pixels Number height the height of the JSField object in pixels
Returns JSField a new JSField object on the form with the displayType of LISTBOX
Sample
newMethod(code)
Creates a new form JSMethod - based on the specified code.
Parameters String code the specified code for the new method
Returns JSMethod a new JSMethod object for this form
Sample
newMultiSelectListBox(dataprovider)
Creates a new JSField object on the form with the displayType of MULTISELECT_LISTBOX - including the dataprovider/JSVariable of the JSField object. You must set location/dimension or css position afterwards
Parameters Object dataprovider the specified dataprovider name/JSVariable of the JSField object
Returns JSField a new JSField object on the form with the displayType of MULTISELECT_LISTBOX
Sample
newMultiSelectListBox(dataprovider, x, y, width, height)
Creates a new JSField object on the form with the displayType of MULTISELECT_LISTBOX - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.
Parameters Object dataprovider the specified dataprovider name/JSVariable of the JSField object Number x the horizontal "x" position of the JSfield object in pixels Number y the vertical "y" position of the JSField object in pixels Number width the width of the JSField object in pixels Number height the height of the JSField object in pixels
Returns JSField a new JSField object on the form with the displayType of MULTISELECT_LISTBOX
Sample
newPart(type, height)
Creates a new part on the form. The type of the new part (use one of the JSPart constants) and its height must be specified.
Parameters Number type The type of the new part. Number height The height of the new part
Returns JSPart A JSPart instance corresponding to the newly created form part.
Sample
newPassword(dataprovider)
Creates a new JSField object on the form with the displayType of PASSWORD - including the dataprovider/JSVariable of the JSField object. You must set location/dimension or css position afterwards
Parameters Object dataprovider the specified dataprovider name/JSVariable of the JSField object
Returns JSField a new JSField object on the form with the displayType of PASSWORD
Sample
newPassword(dataprovider, x, y, width, height)
Creates a new JSField object on the form with the displayType of PASSWORD - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.
Parameters Object dataprovider the specified dataprovider name/JSVariable of the JSField object Number x the horizontal "x" position of the JSfield object in pixels Number y the vertical "y" position of the JSField object in pixels Number width the width of the JSField object in pixels Number height the height of the JSField object in pixels
Returns JSField a new JSField object on the form with the displayType of PASSWORD
Sample
newPortal(name, relation)
Creates a new JSPortal object on the form - including the name of the JSPortal object and the relation the JSPortal object is based on. You must set location/dimension or css position afterwards
Parameters String name the specified name of the JSPortal object Object relation the relation of the JSPortal object
Returns JSComponent a JSPortal object
Sample
newPortal(name, relation, x, y, width, height)
Creates a new JSPortal object on the form - including the name of the JSPortal object; the relation the JSPortal object is based on, the "x" and "y" position of the JSPortal object in pixels, as well as the width and height of the JSPortal object in pixels.
Parameters String name the specified name of the JSPortal object Object relation the relation of the JSPortal object Number x the horizontal "x" position of the JSPortal object in pixels Number y the vertical "y" position of the JSPortal object in pixels Number width the width of the JSPortal object in pixels Number height the height of the JSPortal object in pixels
Returns JSComponent a JSPortal object
Sample
newRadios(dataprovider)
Creates a new JSField object on the form with the displayType of RADIOS (radio buttons) - including the dataprovider/JSVariable of the JSField object. You must set location/dimension or css position afterwards
Parameters Object dataprovider the specified dataprovider name/JSVariable of the JSField object
Returns JSField a JSField object with the displayType of RADIOS (radio buttons)
Sample
newRadios(dataprovider, x, y, width, height)
Creates a new JSField object on the form with the displayType of RADIOS (radio buttons) - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.
Parameters Object dataprovider the specified dataprovider name/JSVariable of the JSField object Number x the horizontal "x" position of the JSfield object in pixels Number y the vertical "y" position of the JSField object in pixels Number width the width of the JSField object in pixels Number height the height of the JSField object in pixels
Returns JSField a JSField object with the displayType of RADIOS (radio buttons)
Sample
newRtfArea(dataprovider, x, y, width, height)
Creates a new JSField object on the form with the displayType of RTF_AREA (enables more than one line of text to be displayed in a field) - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.
Parameters Object dataprovider the specified dataprovider name/JSVariable of the JSField object Number x the horizontal "x" position of the JSfield object in pixels Number y the vertical "y" position of the JSField object in pixels Number width the width of the JSField object in pixels Number height the height of the JSField object in pixels
Returns JSField a JSField object with the displayType of RTF_AREA
Sample
newSpinner(dataprovider)
Creates a new JSField object on the form with the displayType of SPINNER - including the dataprovider/JSVariable of the JSField object. You must set location/dimension or css position afterwards
Parameters Object dataprovider the specified dataprovider name/JSVariable of the JSField object
Returns JSField a new JSField object on the form with the displayType of SPINNER
Sample
newSpinner(dataprovider, x, y, width, height)
Creates a new JSField object on the form with the displayType of SPINNER - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.
Parameters Object dataprovider the specified dataprovider name/JSVariable of the JSField object Number x the horizontal "x" position of the JSfield object in pixels Number y the vertical "y" position of the JSField object in pixels Number width the width of the JSField object in pixels Number height the height of the JSField object in pixels
Returns JSField a new JSField object on the form with the displayType of SPINNER
Sample
newTabPanel(name)
Creates a new JSTabPanel object on the form - including the name of the JSTabPanel object. You must set location/dimension or css position afterwards
Parameters String name the specified name of the JSTabPanel object
Returns JSComponent a JSTabPanel object
Sample
newTabPanel(name, x, y, width, height)
Creates a new JSTabPanel object on the form - including the name of the JSTabPanel object, the "x" and "y" position of the JSTabPanel object in pixels, as well as the width and height of the JSTabPanel object in pixels.
Parameters String name the specified name of the JSTabPanel object Number x the horizontal "x" position of the JSTabPanel object in pixels Number y the vertical "y" position of the JSTabPanel object in pixels Number width the width of the JSTabPanel object in pixels Number height the height of the JSTabPanel object in pixels
Returns JSComponent a JSTabPanel object
Sample
newTextArea(dataprovider)
Creates a new JSField object on the form with the displayType of TEXT_AREA - including the dataprovider/JSVariable of the JSField object. You must set location/dimension or css position afterwards
Parameters Object dataprovider the specified dataprovider name/JSVariable of the JSField object
Returns JSField a JSField object with the displayType of TEXT_AREA
Sample
newTextArea(dataprovider, x, y, width, height)
Creates a new JSField object on the form with the displayType of TEXT_AREA - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.
Parameters Object dataprovider the specified dataprovider name/JSVariable of the JSField object Number x the horizontal "x" position of the JSTabPanel object in pixels Number y the vertical "y" position of the JSTabPanel object in pixels Number width the width of the JSTabPanel object in pixels Number height the height of the JSTabPanel object in pixels
Returns JSField a JSField object with the displayType of TEXT_AREA
Sample
newTextField(dataprovider)
Creates a new JSField object on the form with the displayType of TEXT_FIELD - including the dataprovider/JSVariable of the JSField object. You must set location/dimension or css position afterwards
Parameters Object dataprovider the specified dataprovider name/JSVariable of the JSField object
Returns JSField a JSField object with the displayType of TEXT_FIELD
Sample
newTextField(dataprovider, x, y, width, height)
Creates a new JSField object on the form with the displayType of TEXT_FIELD - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.
Parameters Object dataprovider the specified dataprovider name/JSVariable of the JSField object Number x the horizontal "x" position of the JSfield object in pixels Number y the vertical "y" position of the JSField object in pixels Number width the width of the JSField object in pixels Number height the height of the JSField object in pixels
Returns JSField a JSField object with the displayType of TEXT_FIELD
Sample
newTitleFooterPart(height)
Creates a new Title Footer part on the form.
Parameters Number height The height of the new part
Returns JSPart A JSPart instance corresponding to the newly created Title Footer form part.
Sample
newTitleHeaderPart(height)
Creates a new Title Header part on the form.
Parameters Number height The height of the new part
Returns JSPart A JSPart instance corresponding to the newly created Title Header form part.
Sample
newTrailingGrandSummaryPart(height)
Creates a new Trailing Grand Summary part on the form.
Parameters Number height The height of the new part
Returns JSPart A JSPart instance corresponding to the newly created Trailing Grand Summary form part.
Sample
newTrailingSubSummaryPart(height)
Creates a new Trailing Subsummary part on the form.
Parameters Number height The height of the new part
Returns JSPart A JSPart instance corresponding to the newly created Trailing Subsummary form part.
Sample
newTypeAhead(dataprovider)
Creates a new JSField object on the form with the displayType of TYPE_AHEAD - including the dataprovider/JSVariable of the JSField object. You must set location/dimension or css position afterwards
Parameters Object dataprovider the specified dataprovider name/JSVariable of the JSField object
Returns JSField a JSField object with the displayType of TYPE_AHEAD
Sample
newTypeAhead(dataprovider, x, y, width, height)
Creates a new JSField object on the form with the displayType of TYPE_AHEAD - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.
Parameters Object dataprovider the specified dataprovider name/JSVariable of the JSField object Number x the horizontal "x" position of the JSfield object in pixels Number y the vertical "y" position of the JSField object in pixels Number width the width of the JSField object in pixels Number height the height of the JSField object in pixels
Returns JSField a JSField object with the displayType of TYPE_AHEAD
Sample
newVariable(name, type)
Creates a new form JSVariable - based on the name of the variable object and the number type, uses the SolutionModel JSVariable constants.
Parameters String name the specified name of the variable Number type the specified type of the variable (see Solution Model -> JSVariable node constants)
Returns JSVariable a JSVariable object
Sample
newVariable(name, type, defaultValue)
Creates a new form JSVariable - based on the name of the variable object , the type and it's default value , uses the SolutionModel JSVariable constants.
This method does not require the form to be destroyed and recreated. Use this method if you want to change the form's model without destroying the runtime form
Parameters String name the specified name of the variable Number type the specified type of the variable (see Solution Model -> JSVariable node constants) String defaultValue the default value as a javascript expression string
Returns JSVariable a JSVariable object
Sample
newWebComponent(type)
Creates a new JSWebComponent (spec based component) object on the RESPONSIVE form. Will receive a generated name. Will be added as last position in container.
Parameters String type the webcomponent name as it appears in the spec
Returns JSComponent a JSWebComponent object
Sample
newWebComponent(type, position)
Creates a new JSWebComponent (spec based component) object on the RESPONSIVE form. Will receive a generated name.
Parameters String type the webcomponent name as it appears in the spec Number position the position of JSWebComponent object in its parent container
Returns JSComponent a JSWebComponent object
Sample
newWebComponent(name, type)
Creates a new JSWebComponent (spec based component) object on a form. You must set location/dimension or css position afterwards
Parameters String name the specified name of the JSWebComponent object String type the webcomponent name as it appears in the spec
Returns JSComponent a JSWebComponent object
Sample
newWebComponent(name, type, position)
Creates a new JSWebComponent (spec based component) object on the RESPONSIVE form.
Parameters String name the specified name of the JSWebComponent object String type the webcomponent name as it appears in the spec Number position the position of JSWebComponent object in its parent container
Returns JSComponent a JSWebComponent object
Sample
newWebComponent(name, type, x, y, width, height)
Creates a new JSWebComponent (spec based component) object on the form.
Parameters String name the specified name of the JSWebComponent object String type the webcomponent name as it appears in the spec Number x the horizontal "x" position of the JSWebComponent object in pixels Number y the vertical "y" position of the JSWebComponent object in pixels Number width the width of the JSWebComponent object in pixels Number height the height of the JSWebComponent object in pixels
Returns JSComponent a JSWebComponent object
Sample
putDesignTimeProperty(key, value)
Set a design-time property of a form.
Parameters String key the property name Object value the value to set
Returns Object
Sample
removeBean(name)
Removes a JSBean that has the specified name. Returns true if removal was successful, false otherwise.
Parameters String name the specified name of the JSBean to be removed
Returns Boolean true if the JSBean has been removed; false otherwise
Sample
removeButton(name)
Removes a JSButton that has the specified name. Returns true if removal was successful, false otherwise.
Parameters String name the specified name of the JSButton to be removed
Returns Boolean true if the JSButton has been removed; false otherwise
Sample
removeComponent(name)
Removes a component (JSLabel, JSButton, JSField, JSPortal, JSBean, JSTabpanel, JSWebComponent) that has the given name. It is the same as calling "if(!removeLabel(name) && !removeButton(name) ....)". Returns true if removal was successful, false otherwise.
Parameters String name the specified name of the component to be deleted
Returns Boolean true if component has been successfully deleted; false otherwise
Sample
removeDesignTimeProperty(key)
Clear a design-time property of a form.
Parameters String key the property name
Returns Object
Sample
removeField(name)
Removes a JSField that has the given name. Returns true if removal was successful, false otherwise.
Parameters String name the specified name of the JSField to remove
Returns Boolean true is the JSField has been successfully removed; false otherwise
Sample
removeLabel(name)
Removes a JSLabel that has the given name. Returns true if removal successful, false otherwise
Parameters String name the specified name of the JSLabel to be removed
Returns Boolean true if the JSLabel with the given name has successfully been removed; false otherwise
Sample
removeMethod(name)
Removes a form JSMethod - based on the specified code.
Parameters String name the specified name of the method
Returns Boolean true if method was removed successfully , false otherwise
Sample
removePart(type)
Removes a JSPart of the given type.
Parameters Number type The type of the part that should be removed.
Returns Boolean True if the part is successfully removed, false otherwise.
Sample
removePart(type, height)
Removes a JSPart of the given type. The height parameter is for removing one of multiple subsummary parts.
Parameters Number type The type of the part that should be removed. Number height The height of the part that should be removed. This parameter is for removing one of multiple Leading/Trailing Subsummary parts.
Returns Boolean True if the part is successfully removed, false otherwise.
Sample
removePortal(name)
Removes a JSPortal that has the given name. Returns true if removal was successful, false otherwise.
Parameters String name the specified name of the JSPortal to be removed
Returns Boolean true if the JSPortal has successfully been removed; false otherwise
Sample
removeTabPanel(name)
Removes a JSTabPanel that has the given name. Returns true if removal was successful, false otherwise.
Parameters String name the specified name of the JSTabPanel to be removed
Returns Boolean true is the JSTabPanel has been successfully removed, false otherwise
Sample
removeVariable(name)
Removes a form JSVariable - based on the name of the variable object.
Parameters String name the specified name of the variable
Returns Boolean true if removed, false otherwise (ex: no var with that name)
Sample
removeWebComponent(name)
Removes a JSWebComponent that has the specified name. Returns true if removal was successful, false otherwise.
Parameters String name the specified name of the JSWebComponent to be removed
Returns Boolean true if the JSWebComponent has been removed; false otherwise
Sample
Last updated