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'
{column:width=80px|padding=0px}{column}{column}{column}
Constants Summary
DEFAULT_ENCAPSULATION
The constants to set or get the encapsulation property of a JSForm.
EMPTY_FOUNDSET
Constant used for form namedFoundset property.
HIDE_CONTROLLER_ENCAPSULATION
The constants to set or get the encapsulation property of a JSForm.
HIDE_DATAPROVIDERS_ENCAPSULATION
The constants to set or get the encapsulation property of a JSForm.
HIDE_ELEMENTS_ENCAPSULATION
The constants to set or get the encapsulation property of a JSForm.
HIDE_FOUNDSET_ENCAPSULATION
The constants to set or get the encapsulation property of a JSForm.
LOCKED_LIST_VIEW
The constants to set or get the view property of a JSForm.
LOCKED_RECORD_VIEW
The constants to set or get the view property of a JSForm.
LOCKED_TABLE_VIEW
The constants to set or get the view property of a JSForm.
MODULE_PRIVATE_ENCAPSULATION
The constants to set or get the encapsulation property of a JSForm.
PRIVATE_ENCAPSULATION
The constants to set or get the encapsulation property of a JSForm.
RECORD_VIEW
The constants to set or get the view property of a JSForm.
SELECTION_MODE_DEFAULT
Constant used for form selectionMode property.
SELECTION_MODE_MULTI
Constant used for form selectionMode property.
SELECTION_MODE_SINGLE
Constant used for form selectionMode property.
SEPARATE_FOUNDSET
Constant used for form namedFoundset property.
{column:width=80px|padding=0px}{column}{column}{column}
Property Summary
borderType
The type, color and style of border of the component.
dataSource
The names of the database server and table that this form is linked to.
defaultPageFormat
The default page format for the form.
encapsulation
Get or set the encapsulation level for the form.
extendsForm
A JSForm instance representing the super form of this form, if this form has a super form.
initialSort
The default sort order only when the form loads.
namedFoundSet
Property that tells the form to use a named foundset instead of the default foundset.
onDeleteAllRecordsCmd
The method that overrides the Servoy menu item Select > Delete All.
onDeleteRecordCmd
The method that overrides the Servoy menu item Select > Delete Record (or keyboard shortcut).
onDragOver
The method that is triggered when (non Design Mode) dragging over a component occurs.
onDuplicateRecordCmd
The method that overrides the Servoy menu item Select > Duplicate Record (or keyboard shortcut).
onElementFocusGained
The method that is triggered when focus is gained by a component inside the form.
onElementFocusLost
The method that gets triggered when focus is lost by a component inside the form.
onInvertRecordsCmd
The method that overrides the Servoy menu item Select > Invert Records.
onNewRecordCmd
The method that overrides the Servoy menu item Select > New Record (or keyboard shortcut).
onNextRecordCmd
The method that overrides the Servoy menu item Select > Next Record.
onOmitRecordCmd
The method that overrides the Servoy menu item Select > Omit Record.
onPreviousRecordCmd
The method that overrides the Servoy menu item Select > Previous Record.
onPrintPreviewCmd
The method that overrides the Servoy menu item File > Print Preview.
onRecordEditStart
The method that is triggered when a user clicks into a column on the form.
onRecordEditStop
The method that is triggered when a record is being saved.
onRecordSelection
The method that is triggered each time a record is selected.
onSearchCmd
The method that overrides the Servoy menu item Select > Search (or keyboard shortcut) in Find mode.
onShowAllRecordsCmd
The method that overrides the Servoy menu item Select > Show All (or keyboard shortcut).
onShowOmittedRecordsCmd
The method that overrides the Servoy menu item Select > Show Omitted Records.
paperPrintScale
The percentage value the printed page is enlarged or reduced to; the size of the printed form
is inversely proportional.
scrollbars
Scrollbar options for the vertical and horizontal scrollbars.
selectionMode
Returns the value of the form's selectionMode property.
serverName
Get the server name used by this form.
showInMenu
When set, the form is displayed under the Window menu.
styleClass
The Cascading Style Sheet (CSS) class name applied to the form.
transparent
When set, the form is transparent.
{column:width=80px|padding=0px}{column}{column}{column}
Method Summary
getBodyPart()
Retrieves the Body part of the form.
JSButton[]
getButtons()
Returns all JSButtons of this form, including the ones without a name.
JSButton[]
getButtons(returnInheritedElements)
Returns all JSButtons of this form, including the ones without a name.
getComponent(name)
Returns a JSComponent that has the given name; if found it will be a JSField, JSLabel, JSButton, JSPortal, JSBean or JSTabPanel.
getComponents()
Returns a array of all the JSComponents that a form has; they are of type JSField,JSLabel,JSButton,JSPortal,JSBean or JSTabPanel.
getComponents(returnInheritedElements)
Returns a array of all the JSComponents that a form has; they are of type JSField,JSLabel,JSButton,JSPortal,JSBean or JSTabPanel.
getDesignTimeProperty()
Get a design-time property of a form.
getFooterPart()
Retrieves the Footer part of the form.
getHeaderPart()
Retrieves the Header part of the form.
getLeadingGrandSummaryPart()
Retrieves the Leading Grand Summary part of the form.
JSPart[]
getLeadingSubSummaryParts()
Gets an array of the Leading Subsummary parts of the form, ordered by their height from top == 0 to bottom.
JSMethod[]
getMethods()
Returns all existing form methods for this form.
JSMethod[]
getMethods(returnInheritedElements)
Returns all existing form methods for this form.
getPartYOffset(type)
Returns the Y offset of a given part (see JSPart) of the form.
getPartYOffset(type, height)
Returns the Y offset of a given part (see JSPart) of the form.
JSPortal[]
getPortals()
Returns all JSPortal objects of this form (not including the ones from the parent form), including the ones without a name.
JSPortal[]
getPortals(returnInheritedElements)
Returns all JSPortal objects of this form (optionally also the ones from the parent form), including the ones without a name.
getTabPanel(name)
Returns a JSTabPanel that has the given name.
getTabPanels()
Returns all JSTabPanels of this form (not including the ones from the parent form), including the ones without a name.
getTabPanels(returnInheritedElements)
Returns all JSTabPanels of this form (optionally the ones from the parent form), including the ones without a name.
getTitleFooterPart()
Retrieves the Title Footer part of the form.
getTitleHeaderPart()
Retrieves the Title Header part of the form.
getTrailingGrandSummaryPart()
Retrieves the Trailing Grand Summary part of the form.
JSPart[]
getTrailingSubSummaryParts()
Gets an array of the Trailing Subsummary parts of the form, ordered by their height from top == 0 to bottom.
getVariable(name)
Gets an existing form variable for the given name.
getVariables()
An array consisting of all form variables for this form.
getVariables(returnInheritedElements)
An array consisting of all form variables for this form.
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.
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.
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.
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.
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.
newFooterPart(height)
Creates a new Footer part on the form.
newHeaderPart(height)
Creates a new Header part on the form.
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.
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.
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.
newLeadingGrandSummaryPart(height)
Creates a new Leading Grand Summary part on the form.
newLeadingSubSummaryPart(height)
Creates a new Leading Subsummary part on the form.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
newTitleFooterPart(height)
Creates a new Title Footer part on the form.
newTitleHeaderPart(height)
Creates a new Title Header part on the form.
newTrailingGrandSummaryPart(height)
Creates a new Trailing Grand Summary part on the form.
newTrailingSubSummaryPart(height)
Creates a new Trailing Subsummary part on the form.
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.
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.
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.
putDesignTimeProperty()
Set a design-time property of a form.
removeBean(name)
Removes a JSBean that has the specified name.
removeButton(name)
Removes a JSButton that has the specified name.
removeComponent(name)
Removes a component (JSLabel, JSButton, JSField, JSPortal, JSBean, JSTabpanel) that has the given name.
removeDesignTimeProperty()
Clear a design-time property of a form.
removeField(name)
Removes a JSField that has the given name.
removeLabel(name)
Removes a JSLabel that has the given name.
removeMethod(name)
Removes a form JSMethod - based on the specified code.
removePart(type)
Removes a JSPart of the given type.
removePart(type, height)
Removes a JSPart of the given type.
removePortal(name)
Removes a JSPortal that has the given name.
removeTabPanel(name)
Removes a JSTabPanel that has the given name.
removeVariable(name)
Removes a form JSVariable - based on the name of the variable object.
{column:width=100%|padding=0px}{column}
Constants Details
Sample
var myDefaultForm = solutionModel.newForm('newForm1', myDatasource, myStyleName, false, 800, 600); myDefaultForm.encapsulation = JSForm.DEFAULT_ENCAPSULATION; var myPrivateForm = solutionModel.newForm('newForm2', myDatasource, myStyleName, false, 800, 600); myPrivateForm.encapsulation = JSForm.PRIVATE_ENCAPSULATION; var myModulePrivateForm = solutionModel.newForm('newForm3', myDatasource, myStyleName, false, 800, 600); myModulePrivateForm.encapsulation = JSForm.MODULE_PRIVATE_ENCAPSULATION; var myHideDataprovidersForm = solutionModel.newForm('newForm4', myDatasource, myStyleName, false, 800, 600); myHideDataprovidersForm.encapsulation = JSForm.HIDE_DATAPROVIDERS_ENCAPSULATION; var myHideFoundsetForm = solutionModel.newForm('newForm5', myDatasource, myStyleName, false, 800, 600); myHideFoundsetForm.encapsulation = JSForm.HIDE_FOUNDSET_ENCAPSULATION; var myHideControllerForm = solutionModel.newForm('newForm6', myDatasource, myStyleName, false, 800, 600); myHideControllerForm.encapsulation = JSForm.HIDE_CONTROLLER_ENCAPSULATION; var myHideElementsForm = solutionModel.newForm('newForm7', myDatasource, myStyleName, false, 800, 600); myHideElementsForm.encapsulation = JSForm.HIDE_ELEMENTS_ENCAPSULATION;
Sample
// form with empty foundset var frmEmpty = solutionModel.newForm('products_empty', 'example_data', 'products', null, true, 640, 480); frmEmpty.newLabel("Empty FoundSet",10,10,200,20); frmEmpty.newField('categoryid',JSField.TEXT_FIELD,10,40,200,20); frmEmpty.newField('productname',JSField.TEXT_FIELD,10,70,200,20); frmEmpty.namedFoundSet = JSForm.EMPTY_FOUNDSET;
Sample
var myDefaultForm = solutionModel.newForm('newForm1', myDatasource, myStyleName, false, 800, 600); myDefaultForm.encapsulation = JSForm.DEFAULT_ENCAPSULATION; var myPrivateForm = solutionModel.newForm('newForm2', myDatasource, myStyleName, false, 800, 600); myPrivateForm.encapsulation = JSForm.PRIVATE_ENCAPSULATION; var myModulePrivateForm = solutionModel.newForm('newForm3', myDatasource, myStyleName, false, 800, 600); myModulePrivateForm.encapsulation = JSForm.MODULE_PRIVATE_ENCAPSULATION; var myHideDataprovidersForm = solutionModel.newForm('newForm4', myDatasource, myStyleName, false, 800, 600); myHideDataprovidersForm.encapsulation = JSForm.HIDE_DATAPROVIDERS_ENCAPSULATION; var myHideFoundsetForm = solutionModel.newForm('newForm5', myDatasource, myStyleName, false, 800, 600); myHideFoundsetForm.encapsulation = JSForm.HIDE_FOUNDSET_ENCAPSULATION; var myHideControllerForm = solutionModel.newForm('newForm6', myDatasource, myStyleName, false, 800, 600); myHideControllerForm.encapsulation = JSForm.HIDE_CONTROLLER_ENCAPSULATION; var myHideElementsForm = solutionModel.newForm('newForm7', myDatasource, myStyleName, false, 800, 600); myHideElementsForm.encapsulation = JSForm.HIDE_ELEMENTS_ENCAPSULATION;
Sample
var myDefaultForm = solutionModel.newForm('newForm1', myDatasource, myStyleName, false, 800, 600); myDefaultForm.encapsulation = JSForm.DEFAULT_ENCAPSULATION; var myPrivateForm = solutionModel.newForm('newForm2', myDatasource, myStyleName, false, 800, 600); myPrivateForm.encapsulation = JSForm.PRIVATE_ENCAPSULATION; var myModulePrivateForm = solutionModel.newForm('newForm3', myDatasource, myStyleName, false, 800, 600); myModulePrivateForm.encapsulation = JSForm.MODULE_PRIVATE_ENCAPSULATION; var myHideDataprovidersForm = solutionModel.newForm('newForm4', myDatasource, myStyleName, false, 800, 600); myHideDataprovidersForm.encapsulation = JSForm.HIDE_DATAPROVIDERS_ENCAPSULATION; var myHideFoundsetForm = solutionModel.newForm('newForm5', myDatasource, myStyleName, false, 800, 600); myHideFoundsetForm.encapsulation = JSForm.HIDE_FOUNDSET_ENCAPSULATION; var myHideControllerForm = solutionModel.newForm('newForm6', myDatasource, myStyleName, false, 800, 600); myHideControllerForm.encapsulation = JSForm.HIDE_CONTROLLER_ENCAPSULATION; var myHideElementsForm = solutionModel.newForm('newForm7', myDatasource, myStyleName, false, 800, 600); myHideElementsForm.encapsulation = JSForm.HIDE_ELEMENTS_ENCAPSULATION;
Sample
var myDefaultForm = solutionModel.newForm('newForm1', myDatasource, myStyleName, false, 800, 600); myDefaultForm.encapsulation = JSForm.DEFAULT_ENCAPSULATION; var myPrivateForm = solutionModel.newForm('newForm2', myDatasource, myStyleName, false, 800, 600); myPrivateForm.encapsulation = JSForm.PRIVATE_ENCAPSULATION; var myModulePrivateForm = solutionModel.newForm('newForm3', myDatasource, myStyleName, false, 800, 600); myModulePrivateForm.encapsulation = JSForm.MODULE_PRIVATE_ENCAPSULATION; var myHideDataprovidersForm = solutionModel.newForm('newForm4', myDatasource, myStyleName, false, 800, 600); myHideDataprovidersForm.encapsulation = JSForm.HIDE_DATAPROVIDERS_ENCAPSULATION; var myHideFoundsetForm = solutionModel.newForm('newForm5', myDatasource, myStyleName, false, 800, 600); myHideFoundsetForm.encapsulation = JSForm.HIDE_FOUNDSET_ENCAPSULATION; var myHideControllerForm = solutionModel.newForm('newForm6', myDatasource, myStyleName, false, 800, 600); myHideControllerForm.encapsulation = JSForm.HIDE_CONTROLLER_ENCAPSULATION; var myHideElementsForm = solutionModel.newForm('newForm7', myDatasource, myStyleName, false, 800, 600); myHideElementsForm.encapsulation = JSForm.HIDE_ELEMENTS_ENCAPSULATION;
Sample
var myDefaultForm = solutionModel.newForm('newForm1', myDatasource, myStyleName, false, 800, 600); myDefaultForm.encapsulation = JSForm.DEFAULT_ENCAPSULATION; var myPrivateForm = solutionModel.newForm('newForm2', myDatasource, myStyleName, false, 800, 600); myPrivateForm.encapsulation = JSForm.PRIVATE_ENCAPSULATION; var myModulePrivateForm = solutionModel.newForm('newForm3', myDatasource, myStyleName, false, 800, 600); myModulePrivateForm.encapsulation = JSForm.MODULE_PRIVATE_ENCAPSULATION; var myHideDataprovidersForm = solutionModel.newForm('newForm4', myDatasource, myStyleName, false, 800, 600); myHideDataprovidersForm.encapsulation = JSForm.HIDE_DATAPROVIDERS_ENCAPSULATION; var myHideFoundsetForm = solutionModel.newForm('newForm5', myDatasource, myStyleName, false, 800, 600); myHideFoundsetForm.encapsulation = JSForm.HIDE_FOUNDSET_ENCAPSULATION; var myHideControllerForm = solutionModel.newForm('newForm6', myDatasource, myStyleName, false, 800, 600); myHideControllerForm.encapsulation = JSForm.HIDE_CONTROLLER_ENCAPSULATION; var myHideElementsForm = solutionModel.newForm('newForm7', myDatasource, myStyleName, false, 800, 600); myHideElementsForm.encapsulation = JSForm.HIDE_ELEMENTS_ENCAPSULATION;
Sample
var myListViewForm = solutionModel.newForm('newForm1', myDatasource, myStyleName, false, 800, 600); myListViewForm.view = JSForm.LIST_VIEW; var myLockedListViewForm = solutionModel.newForm('newForm2', myDatasource, myStyleName, false, 800, 600); myLockedListViewForm.view = JSForm.LOCKED_LIST_VIEW; var myLockedRecordViewForm = solutionModel.newForm('newForm3', myDatasource, myStyleName, false, 800, 600); myLockedRecordViewForm.view = JSForm.LOCKED_RECORD_VIEW; var myLockedTableViewForm = solutionModel.newForm('newForm4', myDatasource, myStyleName, false, 800, 600); myLockedTableViewForm.view = JSForm.LOCKED_TABLE_VIEW; var myRecordViewForm = solutionModel.newForm('newForm5', myDatasource, myStyleName, false, 800, 600); myRecordViewForm.view = JSForm.RECORD_VIEW;
Sample
var myListViewForm = solutionModel.newForm('newForm1', myDatasource, myStyleName, false, 800, 600); myListViewForm.view = JSForm.LIST_VIEW; var myLockedListViewForm = solutionModel.newForm('newForm2', myDatasource, myStyleName, false, 800, 600); myLockedListViewForm.view = JSForm.LOCKED_LIST_VIEW; var myLockedRecordViewForm = solutionModel.newForm('newForm3', myDatasource, myStyleName, false, 800, 600); myLockedRecordViewForm.view = JSForm.LOCKED_RECORD_VIEW; var myLockedTableViewForm = solutionModel.newForm('newForm4', myDatasource, myStyleName, false, 800, 600); myLockedTableViewForm.view = JSForm.LOCKED_TABLE_VIEW; var myRecordViewForm = solutionModel.newForm('newForm5', myDatasource, myStyleName, false, 800, 600); myRecordViewForm.view = JSForm.RECORD_VIEW;
Sample
var myListViewForm = solutionModel.newForm('newForm1', myDatasource, myStyleName, false, 800, 600); myListViewForm.view = JSForm.LIST_VIEW; var myLockedListViewForm = solutionModel.newForm('newForm2', myDatasource, myStyleName, false, 800, 600); myLockedListViewForm.view = JSForm.LOCKED_LIST_VIEW; var myLockedRecordViewForm = solutionModel.newForm('newForm3', myDatasource, myStyleName, false, 800, 600); myLockedRecordViewForm.view = JSForm.LOCKED_RECORD_VIEW; var myLockedTableViewForm = solutionModel.newForm('newForm4', myDatasource, myStyleName, false, 800, 600); myLockedTableViewForm.view = JSForm.LOCKED_TABLE_VIEW; var myRecordViewForm = solutionModel.newForm('newForm5', myDatasource, myStyleName, false, 800, 600); myRecordViewForm.view = JSForm.RECORD_VIEW;
Sample
var myListViewForm = solutionModel.newForm('newForm1', myDatasource, myStyleName, false, 800, 600); myListViewForm.view = JSForm.LIST_VIEW; var myLockedListViewForm = solutionModel.newForm('newForm2', myDatasource, myStyleName, false, 800, 600); myLockedListViewForm.view = JSForm.LOCKED_LIST_VIEW; var myLockedRecordViewForm = solutionModel.newForm('newForm3', myDatasource, myStyleName, false, 800, 600); myLockedRecordViewForm.view = JSForm.LOCKED_RECORD_VIEW; var myLockedTableViewForm = solutionModel.newForm('newForm4', myDatasource, myStyleName, false, 800, 600); myLockedTableViewForm.view = JSForm.LOCKED_TABLE_VIEW; var myRecordViewForm = solutionModel.newForm('newForm5', myDatasource, myStyleName, false, 800, 600); myRecordViewForm.view = JSForm.RECORD_VIEW;
Sample
var myDefaultForm = solutionModel.newForm('newForm1', myDatasource, myStyleName, false, 800, 600); myDefaultForm.encapsulation = JSForm.DEFAULT_ENCAPSULATION; var myPrivateForm = solutionModel.newForm('newForm2', myDatasource, myStyleName, false, 800, 600); myPrivateForm.encapsulation = JSForm.PRIVATE_ENCAPSULATION; var myModulePrivateForm = solutionModel.newForm('newForm3', myDatasource, myStyleName, false, 800, 600); myModulePrivateForm.encapsulation = JSForm.MODULE_PRIVATE_ENCAPSULATION; var myHideDataprovidersForm = solutionModel.newForm('newForm4', myDatasource, myStyleName, false, 800, 600); myHideDataprovidersForm.encapsulation = JSForm.HIDE_DATAPROVIDERS_ENCAPSULATION; var myHideFoundsetForm = solutionModel.newForm('newForm5', myDatasource, myStyleName, false, 800, 600); myHideFoundsetForm.encapsulation = JSForm.HIDE_FOUNDSET_ENCAPSULATION; var myHideControllerForm = solutionModel.newForm('newForm6', myDatasource, myStyleName, false, 800, 600); myHideControllerForm.encapsulation = JSForm.HIDE_CONTROLLER_ENCAPSULATION; var myHideElementsForm = solutionModel.newForm('newForm7', myDatasource, myStyleName, false, 800, 600); myHideElementsForm.encapsulation = JSForm.HIDE_ELEMENTS_ENCAPSULATION;
Sample
var myDefaultForm = solutionModel.newForm('newForm1', myDatasource, myStyleName, false, 800, 600); myDefaultForm.encapsulation = JSForm.DEFAULT_ENCAPSULATION; var myPrivateForm = solutionModel.newForm('newForm2', myDatasource, myStyleName, false, 800, 600); myPrivateForm.encapsulation = JSForm.PRIVATE_ENCAPSULATION; var myModulePrivateForm = solutionModel.newForm('newForm3', myDatasource, myStyleName, false, 800, 600); myModulePrivateForm.encapsulation = JSForm.MODULE_PRIVATE_ENCAPSULATION; var myHideDataprovidersForm = solutionModel.newForm('newForm4', myDatasource, myStyleName, false, 800, 600); myHideDataprovidersForm.encapsulation = JSForm.HIDE_DATAPROVIDERS_ENCAPSULATION; var myHideFoundsetForm = solutionModel.newForm('newForm5', myDatasource, myStyleName, false, 800, 600); myHideFoundsetForm.encapsulation = JSForm.HIDE_FOUNDSET_ENCAPSULATION; var myHideControllerForm = solutionModel.newForm('newForm6', myDatasource, myStyleName, false, 800, 600); myHideControllerForm.encapsulation = JSForm.HIDE_CONTROLLER_ENCAPSULATION; var myHideElementsForm = solutionModel.newForm('newForm7', myDatasource, myStyleName, false, 800, 600); myHideElementsForm.encapsulation = JSForm.HIDE_ELEMENTS_ENCAPSULATION;
Sample
var myListViewForm = solutionModel.newForm('newForm1', myDatasource, myStyleName, false, 800, 600); myListViewForm.view = JSForm.LIST_VIEW; var myLockedListViewForm = solutionModel.newForm('newForm2', myDatasource, myStyleName, false, 800, 600); myLockedListViewForm.view = JSForm.LOCKED_LIST_VIEW; var myLockedRecordViewForm = solutionModel.newForm('newForm3', myDatasource, myStyleName, false, 800, 600); myLockedRecordViewForm.view = JSForm.LOCKED_RECORD_VIEW; var myLockedTableViewForm = solutionModel.newForm('newForm4', myDatasource, myStyleName, false, 800, 600); myLockedTableViewForm.view = JSForm.LOCKED_TABLE_VIEW; var myRecordViewForm = solutionModel.newForm('newForm5', myDatasource, myStyleName, false, 800, 600); myRecordViewForm.view = JSForm.RECORD_VIEW;
Sample
var myForm = solutionModel.getForm('my_form_name'); myForm.selectionMode = JSForm.SELECTION_MODE_DEFAULT;
Sample
var myForm = solutionModel.getForm('my_form_name'); myForm.selectionMode = JSForm.SELECTION_MODE_MULTI;
Sample
var myForm = solutionModel.getForm('my_form_name'); myForm.selectionMode = JSForm.SELECTION_MODE_SINGLE;
Sample
// form with separate foundset var frmSeparate = solutionModel.newForm('products_separate', 'example_data', 'products', null, true, 640, 480); frmSeparate.newLabel("Separate FoundSet",10,10,200,20); frmSeparate.newField('categoryid',JSField.TEXT_FIELD,10,40,200,20); frmSeparate.newField('productname',JSField.TEXT_FIELD,10,70,200,20); frmSeparate.namedFoundSet = JSForm.SEPARATE_FOUNDSET; forms['products_separate'].controller.find(); forms['products_separate'].categoryid = '=2'; forms['products_separate'].controller.search();
{column:width=100%|padding=0px}{column}
Property Details
Sample
//HINT: To know exactly the notation of this property set it in the designer and then read it once out through the solution model. var field = form.newField('my_table_text', JSField.TEXT_FIELD, 10, 10, 100, 20); field.borderType = solutionModel.createLineBorder(1,'#ff0000');
Sample
var myForm = solutionModel.newForm('newForm', 'db:/a_server/a_table', 'aStyleName', false, 800, 600) myForm.dataSource = 'db:/anotherServerName/anotherTableName'
Sample
var form = solutionModel.getForm("someForm"); application.output(form.defaultPageFormat); form.defaultPageFormat = solutionModel.createPageFormat(612,792,72,72,72,72,SM_ORIENTATION.PORTRAIT,SM_UNITS.PIXELS)
Sample
var myForm = solutionModel.newForm('newForm1', myDatasource, null, true, 800, 600); myForm.encapsulation = JSForm.HIDE_CONTROLLER_ENCAPSULATION;
Sample
var subForm = solutionModel.newForm('childForm',myDatasource,null,true,800,600); var superForm = solutionModel.newForm('childForm',myDatasource,null,true,800,600); subForm.extendsForm = superForm;
Sample
var form = solutionModel.newForm('myForm',myDatasource,null,true,800,600); form.initialSort = "column1 desc, column2 asc, column3 asc";
Sample
var form = solutionModel.newForm('myForm',myDatasource,null,true,800,600); var formName = form.name; application.output(formName);
Sample
// form with separate foundset var frmSeparate = solutionModel.newForm('products_separate', 'db:/example_data/products', null, true, 640, 480); frmSeparate.newLabel("Separate FoundSet",10,10,200,20); frmSeparate.newField('categoryid',JSField.TEXT_FIELD,10,40,200,20); frmSeparate.newField('productname',JSField.TEXT_FIELD,10,70,200,20); frmSeparate.namedFoundSet = JSForm.SEPARATE_FOUNDSET; forms['products_separate'].controller.find(); forms['products_separate'].categoryid = '=2'; forms['products_separate'].controller.search(); // form with empty foundset var frmEmpty = solutionModel.newForm('products_empty', 'db:/example_data/products', null, true, 640, 480); frmEmpty.newLabel("Empty FoundSet",10,10,200,20); frmEmpty.newField('categoryid',JSField.TEXT_FIELD,10,40,200,20); frmEmpty.newField('productname',JSField.TEXT_FIELD,10,70,200,20); frmEmpty.namedFoundSet = JSForm.EMPTY_FOUNDSET; // form with an initial foundset based on a global relation var frmGlobalRel = solutionModel.newForm("categories_related", solutionModel.getForm("categories")); frmGlobalRel.namedFoundSet = "g2_to_category_name"; // form with an initial foundset based on a global relation var frmGlobalRel = solutionModel.newForm("categories_related", solutionModel.getForm("categories")); frmGlobalRel.namedFoundSet = solutionModel.getRelation("g1_to_categories");
Sample
var aForm = solutionModel.newForm('newForm1', myDatasource, null, true, 800, 600); // you can also use SM_DEFAULTS.INGORE to just reuse the navigator that is already set, or SM_DEFAULTS.DEFAULT to have the default servoy navigator. // here we assign an other new form as the navigator. var aNavigator = solutionModel.newForm('navForm', myDatasource, null, false, 800, 600); // set the navigators navigator to NONE aNavigator.navigator = SM_DEFAULTS.NONE; // Hide the navigator on the form. myListViewForm.navigator = aNavigator; application.output(myListViewForm.navigator.name);
Sample
form.onNewRecordCmd = form.newMethod('function onNewRecordCmd(event) { application.output("onNewRecordCmd intercepted on " + event.getFormName()); }'); form.onDuplicateRecordCmd = form.newMethod('function onDuplicateRecordCmd(event) { application.output("onDuplicateRecordCmd intercepted on " + event.getFormName()); }'); form.onDeleteRecordCmd = form.newMethod('function onDeleteRecordCmd(event) { application.output("onDeleteRecordCmd intercepted on " + event.getFormName()); }'); form.onDeleteAllRecordsCmd = form.newMethod('function onDeleteAllRecordsCmd(event) { application.output("onDeleteAllRecordsCmd intercepted on " + event.getFormName()); }');
Sample
form.onNewRecordCmd = form.newMethod('function onNewRecordCmd(event) { application.output("onNewRecordCmd intercepted on " + event.getFormName()); }'); form.onDuplicateRecordCmd = form.newMethod('function onDuplicateRecordCmd(event) { application.output("onDuplicateRecordCmd intercepted on " + event.getFormName()); }'); form.onDeleteRecordCmd = form.newMethod('function onDeleteRecordCmd(event) { application.output("onDeleteRecordCmd intercepted on " + event.getFormName()); }'); form.onDeleteAllRecordsCmd = form.newMethod('function onDeleteAllRecordsCmd(event) { application.output("onDeleteAllRecordsCmd intercepted on " + event.getFormName()); }');
Sample
form.onDrag = form.newMethod('function onDrag(event) { application.output("onDrag intercepted from " + event.getSource()); }'); form.onDragEnd = form.newMethod('function onDragEnd(event) { application.output("onDragEnd intercepted from " + event.getSource()); }'); form.onDragOver = form.newMethod('function onDragOver(event) { application.output("onDragOver intercepted from " + event.getSource()); }'); form.onDrop = form.newMethod('function onDrop(event) { application.output("onDrop intercepted from " + event.getSource()); }');
Sample
form.onDrag = form.newMethod('function onDrag(event) { application.output("onDrag intercepted from " + event.getSource()); }'); form.onDragEnd = form.newMethod('function onDragEnd(event) { application.output("onDragEnd intercepted from " + event.getSource()); }'); form.onDragOver = form.newMethod('function onDragOver(event) { application.output("onDragOver intercepted from " + event.getSource()); }'); form.onDrop = form.newMethod('function onDrop(event) { application.output("onDrop intercepted from " + event.getSource()); }');
Sample
form.onDrag = form.newMethod('function onDrag(event) { application.output("onDrag intercepted from " + event.getSource()); }'); form.onDragEnd = form.newMethod('function onDragEnd(event) { application.output("onDragEnd intercepted from " + event.getSource()); }'); form.onDragOver = form.newMethod('function onDragOver(event) { application.output("onDragOver intercepted from " + event.getSource()); }'); form.onDrop = form.newMethod('function onDrop(event) { application.output("onDrop intercepted from " + event.getSource()); }');
Sample
form.onDrag = form.newMethod('function onDrag(event) { application.output("onDrag intercepted from " + event.getSource()); }'); form.onDragEnd = form.newMethod('function onDragEnd(event) { application.output("onDragEnd intercepted from " + event.getSource()); }'); form.onDragOver = form.newMethod('function onDragOver(event) { application.output("onDragOver intercepted from " + event.getSource()); }'); form.onDrop = form.newMethod('function onDrop(event) { application.output("onDrop intercepted from " + event.getSource()); }');
Sample
form.onNewRecordCmd = form.newMethod('function onNewRecordCmd(event) { application.output("onNewRecordCmd intercepted on " + event.getFormName()); }'); form.onDuplicateRecordCmd = form.newMethod('function onDuplicateRecordCmd(event) { application.output("onDuplicateRecordCmd intercepted on " + event.getFormName()); }'); form.onDeleteRecordCmd = form.newMethod('function onDeleteRecordCmd(event) { application.output("onDeleteRecordCmd intercepted on " + event.getFormName()); }'); form.onDeleteAllRecordsCmd = form.newMethod('function onDeleteAllRecordsCmd(event) { application.output("onDeleteAllRecordsCmd intercepted on " + event.getFormName()); }');
Sample
form.onElementFocusGained = form.newMethod('function onElementFocusGained(event) { application.output("onElementFocusGained intercepted from " + event.getSource()); }'); form.onElementFocusLost = form.newMethod('function onElementFocusLost(event) { application.output("onElementFocusLost intercepted from " + event.getSource()); }');
Sample
form.onElementFocusGained = form.newMethod('function onElementFocusGained(event) { application.output("onElementFocusGained intercepted from " + event.getSource()); }'); form.onElementFocusLost = form.newMethod('function onElementFocusLost(event) { application.output("onElementFocusLost intercepted from " + event.getSource()); }');
Sample
form.onFindCmd = form.newMethod('function onFindCmd(event) { application.output("onFindCmd intercepted on " + event.getFormName()); }'); form.onSearchCmd = form.newMethod('function onSearchCmd(event) { application.output("onSearchCmd intercepted on " + event.getFormName()); }'); form.onShowAllRecordsCmd = form.newMethod('function onShowAllRecordsCmd(event) { application.output("onShowAllRecordsCmd intercepted on " + event.getFormName()); }');
Sample
form.onShow = form.newMethod('function onShow(firstShow, event) { application.output("onShow intercepted on " + event.getFormName() + ". first show? " + firstShow); return false; }'); form.onHide = form.newMethod('function onHide(event) { application.output("onHide blocked on " + event.getFormName()); return false; }');
Sample
form.onOmitRecordCmd = form.newMethod('function onOmitRecordCmd(event) { application.output("onOmitRecordCmd intercepted on " + event.getFormName()); }'); form.onShowOmittedRecordsCmd = form.newMethod('function onShowOmittedRecordsCmd(event) { application.output("onShowOmittedRecordsCmd intercepted on " + event.getFormName()); }'); form.onInvertRecordsCmd = form.newMethod('function onInvertRecordsCmd(event) { application.output("onInvertRecordsCmd intercepted on " + event.getFormName()); }');
Sample
form.onLoad = form.newMethod('function onLoad(event) { application.output("onLoad intercepted on " + event.getFormName()); }'); form.onUnLoad = form.newMethod('function onUnLoad(event) { application.output("onUnLoad intercepted on " + event.getFormName()); }');
Sample
form.onNewRecordCmd = form.newMethod('function onNewRecordCmd(event) { application.output("onNewRecordCmd intercepted on " + event.getFormName()); }'); form.onDuplicateRecordCmd = form.newMethod('function onDuplicateRecordCmd(event) { application.output("onDuplicateRecordCmd intercepted on " + event.getFormName()); }'); form.onDeleteRecordCmd = form.newMethod('function onDeleteRecordCmd(event) { application.output("onDeleteRecordCmd intercepted on " + event.getFormName()); }'); form.onDeleteAllRecordsCmd = form.newMethod('function onDeleteAllRecordsCmd(event) { application.output("onDeleteAllRecordsCmd intercepted on " + event.getFormName()); }');
Sample
form.onPreviousRecordCmd = form.newMethod('function onPreviousRecordCmd(event) { application.output("onPreviousRecordCmd intercepted on " + event.getFormName()); }'); form.onNextRecordCmd = form.newMethod('function onNextRecordCmd(event) { application.output("onNextRecordCmd intercepted on " + event.getFormName()); }');
Sample
form.onOmitRecordCmd = form.newMethod('function onOmitRecordCmd(event) { application.output("onOmitRecordCmd intercepted on " + event.getFormName()); }'); form.onShowOmittedRecordsCmd = form.newMethod('function onShowOmittedRecordsCmd(event) { application.output("onShowOmittedRecordsCmd intercepted on " + event.getFormName()); }'); form.onInvertRecordsCmd = form.newMethod('function onInvertRecordsCmd(event) { application.output("onInvertRecordsCmd intercepted on " + event.getFormName()); }');
Sample
form.onPreviousRecordCmd = form.newMethod('function onPreviousRecordCmd(event) { application.output("onPreviousRecordCmd intercepted on " + event.getFormName()); }'); form.onNextRecordCmd = form.newMethod('function onNextRecordCmd(event) { application.output("onNextRecordCmd intercepted on " + event.getFormName()); }');
Sample
form.onPrintPreviewCmd = form.newMethod('function onPrintPreviewCmd(event) { application.output("onPrintPreviewCmd intercepted on " + event.getFormName()); }');
Sample
form.onRecordEditStart = form.newMethod('function onRecordEditStart(event) { application.output("onRecordEditStart intercepted on " + event.getFormName()); }'); form.onRecordEditStop = form.newMethod('function onRecordEditStop(record, event) { application.output("onRecordEditStop intercepted on " + event.getFormName() + ". record is: " + record); }'); form.onRecordSelection = form.newMethod('function onRecordSelection(event) { application.output("onRecordSelection intercepted on " + event.getFormName()); }');
Sample
form.onRecordEditStart = form.newMethod('function onRecordEditStart(event) { application.output("onRecordEditStart intercepted on " + event.getFormName()); }'); form.onRecordEditStop = form.newMethod('function onRecordEditStop(record, event) { application.output("onRecordEditStop intercepted on " + event.getFormName() + ". record is: " + record); }'); form.onRecordSelection = form.newMethod('function onRecordSelection(event) { application.output("onRecordSelection intercepted on " + event.getFormName()); }');
Sample
form.onRecordEditStart = form.newMethod('function onRecordEditStart(event) { application.output("onRecordEditStart intercepted on " + event.getFormName()); }'); form.onRecordEditStop = form.newMethod('function onRecordEditStop(record, event) { application.output("onRecordEditStop intercepted on " + event.getFormName() + ". record is: " + record); }'); form.onRecordSelection = form.newMethod('function onRecordSelection(event) { application.output("onRecordSelection intercepted on " + event.getFormName()); }');
Sample
form.onRender = form.newMethod('function onRender(event) { event.getElement().bgcolor = \'#00ff00\' }');
Sample
form.onResize = form.newMethod('function onResize(event) { application.output("onResize intercepted on " + event.getFormName()); }');
Sample
form.onFindCmd = form.newMethod('function onFindCmd(event) { application.output("onFindCmd intercepted on " + event.getFormName()); }'); form.onSearchCmd = form.newMethod('function onSearchCmd(event) { application.output("onSearchCmd intercepted on " + event.getFormName()); }'); form.onShowAllRecordsCmd = form.newMethod('function onShowAllRecordsCmd(event) { application.output("onShowAllRecordsCmd intercepted on " + event.getFormName()); }');
Sample
form.onShow = form.newMethod('function onShow(firstShow, event) { application.output("onShow intercepted on " + event.getFormName() + ". first show? " + firstShow); return false; }'); form.onHide = form.newMethod('function onHide(event) { application.output("onHide blocked on " + event.getFormName()); return false; }');
Sample
form.onFindCmd = form.newMethod('function onFindCmd(event) { application.output("onFindCmd intercepted on " + event.getFormName()); }'); form.onSearchCmd = form.newMethod('function onSearchCmd(event) { application.output("onSearchCmd intercepted on " + event.getFormName()); }'); form.onShowAllRecordsCmd = form.newMethod('function onShowAllRecordsCmd(event) { application.output("onShowAllRecordsCmd intercepted on " + event.getFormName()); }');
Sample
form.onOmitRecordCmd = form.newMethod('function onOmitRecordCmd(event) { application.output("onOmitRecordCmd intercepted on " + event.getFormName()); }'); form.onShowOmittedRecordsCmd = form.newMethod('function onShowOmittedRecordsCmd(event) { application.output("onShowOmittedRecordsCmd intercepted on " + event.getFormName()); }'); form.onInvertRecordsCmd = form.newMethod('function onInvertRecordsCmd(event) { application.output("onInvertRecordsCmd intercepted on " + event.getFormName()); }');
Sample
form.onSortCmd = form.newMethod('function onSortCmd(dataProviderID, asc, event) { application.output("onSortCmd intercepted on " + event.getFormName() + ". data provider: " + dataProviderID + ". asc: " + asc); }');
Sample
form.onLoad = form.newMethod('function onLoad(event) { application.output("onLoad intercepted on " + event.getFormName()); }'); form.onUnLoad = form.newMethod('function onUnLoad(event) { application.output("onUnLoad intercepted on " + event.getFormName()); }');
Sample
var form = solutionModel.newForm('myForm',myDatasource,null,true,800,600); if (form.paperPrintScale < 100) form.paperPrintScale = 100;
Sample
var form = solutionModel.newForm('myForm',myDatasource,null,true,1000,600); form.scrollbars = SM_SCROLLBAR.VERTICAL_SCROLLBAR_NEVER; forms['newForm1'].controller.show();
Since
6.1
Sample
var myForm = solutionModel.getForm('my_form_name'); if (myForm.selectionMode == JSForm.SELECTION_MODE_MULTI) myForm.selectionMode = JSForm.SELECTION_MODE_DEFAULT;
Sample
var form = solutionModel.newForm('myForm',myDatasource,null,true,800,600); form.serverName = 'anotherServerName'; var theServerName = form.serverName; application.output(theServerName);
Sample
var aForm = solutionModel.newForm('newForm1', myDatasource, null, true, 800, 600); var anotherForm= solutionModel.newForm('newForm2', myDatasource, null, true, 800, 600); //using 'anotherForm' as navigator for aForm anotherForm.showInMenu = false; anotherForm.navigator = null; aForm.navigator = anotherForm; application.output(aForm.navigator.name);
Sample
var aForm = solutionModel.newForm('newForm1', myDatasource, null, true, 800, 600); if (aForm.styleClass == null) aForm.styleClass = someStyleClass; else application.output("The Cascading Style Sheet (CSS) class name applied to this form is " + aForm.styleClass);
Sample
var aForm = solutionModel.newForm('newForm1', myDatasource, null, true, 800, 600); if (aForm.styleName == null) aForm.styleName = someServoyStyleName; else application.output("The name of the Servoy style that is being used on the form is " + aForm.styleName);
Sample
var aForm = solutionModel.newForm('newForm1', myDatasource, null, true, 800, 600); aForm.tableName = 'anotherTableOfMine' if (forms['newForm1'].controller.find()) { columnTextDataProvider = '=aSearchedValue' columnNumberDataProvider = '>10'; forms['newForm1'].controller.search() }
Sample
var myForm = solutionModel.newForm('newForm', 'db:/a_server/a_table', 'aStyleName', false, 800, 600) forms['newForm'].controller.show(); if (myForm.titleText == null) { myForm.titleText = "My new title text should be really cool!" forms['newForm'].controller.recreateUI(); } else application.output("My text text is already cool");
Sample
var form = solutionModel.newForm('myForm',myDatasource,null,true,1000,800); if (form.transparent == false) { var style = solutionModel.newStyle('myStyle','form { background-color: yellow; }'); style.text = style.text + 'field { background-color: blue; }'; form.styleName = 'myStyle'; } var field = form.newField('columnTextDataProvider',JSField.TEXT_FIELD,100,100,100,50); forms['myForm'].controller.show();
Sample
var myForm = solutionModel.newForm('newForm1', myDatasource, null, true, 800, 600); myForm.view = JSForm.RECORD_VIEW; forms['newForm1'].controller.show();
Sample
var myForm = solutionModel.newForm('newForm1', myDatasource, null, true, 800, 600); forms['newForm1'].controller.show(); myForm.width = 120; forms['newForm1'].controller.recreateUI();
{column:width=100%|padding=0px}{column}
Method Details
getBean
(name)
Sample
var btn = myForm.getBean("mybean"); application.output(mybean.className);
JSBean[]
getBeans
()
Sample
var beans = myForm.getBeans(); for (var b in beans) { if (beans[b].name != null) application.output(beans[b].name); }
JSBean[]
getBeans
(returnInheritedElements)
Parameters
{Boolean} returnInheritedElements – true to also return the elements from parent form
Sample
var beans = myForm.getBeans(); for (var b in beans) { if (beans[b].name != null) application.output(beans[b].name); }
getBodyPart
()
Returns
JSPart – A JSPart instance corresponding to the Body part of the form.
Sample
form.getBodyPart().background = 'blue';
getButton
(name)
Parameters
{String} name – the specified name of the button
Sample
var btn = myForm.getButton("hello"); application.output(btn.text);
JSButton[]
getButtons
()
Returns
JSButton[] – the list of all JSbuttons on this forms
Sample
var buttons = myForm.getButtons(); for (var b in buttons) { if (buttons[b].name != null) application.output(buttons[b].name); else application.output(buttons[b].text + " has no name "); }
JSButton[]
getButtons
(returnInheritedElements)
Parameters
{Boolean} returnInheritedElements – true to also return the elements from parent form
Returns
JSButton[] – the list of all JSbuttons on this forms
Sample
var buttons = myForm.getButtons(); for (var b in buttons) { if (buttons[b].name != null) application.output(buttons[b].name); else application.output(buttons[b].text + " has no name "); }
getComponent
(name)
Parameters
{String} name – the specified name of the component
Returns
JSComponent – a JSComponent object (might be a JSField, JSLabel, JSButton, JSPortal, JSBean or JSTabPanel)
Sample
var frm = solutionModel.getForm("myForm"); var cmp = frm.getComponent("componentName"); application.output("Component type and name: " + cmp);
getComponents
()
Returns
JSComponent[] – an array of all the JSComponents on the form.
Sample
var form = solutionModel.getForm("myForm"); var components = form.getComponents(); for (var i in components) application.output("Component type and name: " + components[i]);
getComponents
(returnInheritedElements)
Parameters
{Boolean} returnInheritedElements – true to also return the elements from the parent form
Returns
JSComponent[] – an array of all the JSComponents on the form.
Sample
var form = solutionModel.getForm("myForm"); var components = form.getComponents(); for (var i in components) application.output("Component type and name: " + components[i]);
getDesignTimeProperty
()
Sample
var frm = solutionModel.getForm('orders') var prop = frm.getDesignTimeProperty('myprop')
getField
(name)
Sample
var form = solutionModel.getForm("myForm"); var field = form.getField("myField"); application.output(field.dataProviderID);
JSField[]
getFields
()
Sample
var frm = solutionModel.getForm("myForm"); var fields = frm.getFields(); for (var f in fields) { var fname = fields[f].name; if (fname != null) application.output(fname); }
JSField[]
getFields
(returnInheritedElements)
Parameters
{Boolean} returnInheritedElements – true to also return the elements from the parent form
Sample
var frm = solutionModel.getForm("myForm"); var fields = frm.getFields(); for (var f in fields) { var fname = fields[f].name; if (fname != null) application.output(fname); }
getFooterPart
()
Returns
JSPart – A JSPart instance corresponding to the Footer part of the form.
Sample
form.getFooterPart().background = 'magenta';
getHeaderPart
()
Returns
JSPart – A JSPart instance corresponding to the Header part of the form.
Sample
form.getHeaderPart().background = 'orange';
getLabel
(name)
Returns
JSLabel – a JSLabel object (or null if the label with the specified name does not exist)
Sample
var frm = solutionModel.getForm("myForm"); var label = frm.getLabel("myLabel"); application.output(label.text);
JSLabel[]
getLabels
()
Sample
var frm = solutionModel.getForm("myForm"); var labels = frm.getLabels(); for (var i in labels) { var lname = labels[i].name; if (lname != null) application.output(lname); }
JSLabel[]
getLabels
(returnInheritedElements)
Parameters
{Boolean} returnInheritedElements – true to also return the elements from parent form
Sample
var frm = solutionModel.getForm("myForm"); var labels = frm.getLabels(); for (var i in labels) { var lname = labels[i].name; if (lname != null) application.output(lname); }
getLeadingGrandSummaryPart
()
Returns
JSPart – A JSPart instance corresponding to the Leading Grand Summary part of the form.
Sample
form.getLeadingGrandSummaryPart().background = 'yellow';
JSPart[]
getLeadingSubSummaryParts
()
Returns
JSPart[] – An array of JSPart instances corresponding to the Leading Subsummary parts of the form.
Sample
form.getLeadingSubSummaryParts()[0].background = 'green';
getMethod
(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
var frm = solutionModel.getForm("myForm"); var method = frm.getMethod("myMethod"); application.output(method.code);
JSMethod[]
getMethods
()
Sample
var frm = solutionModel.getForm("myForm"); var methods = frm.getMethods(); for (var m in methods) application.output(methods[m].getName());
JSMethod[]
getMethods
(returnInheritedElements)
Parameters
{Boolean} returnInheritedElements – true to also return the elements from the parent form
Sample
var frm = solutionModel.getForm("myForm"); var methods = frm.getMethods(); for (var m in methods) application.output(methods[m].getName());
getPart
(type)
Parameters
{Number} type – The type of the part to retrieve.
Returns
JSPart – A JSPart instance representing the retrieved form part.
Sample
form.getPart(JSPart.HEADER).background = 'red'; form.getPart(JSPart.LEADING_SUBSUMMARY, 160).background = 'red';
getPart
(type, height)
Returns
JSPart – A JSPart instance representing the retrieved form part.
Sample
form.getPart(JSPart.HEADER).background = 'red'; form.getPart(JSPart.LEADING_SUBSUMMARY, 160).background = 'red';
getPartYOffset
(type)
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
// get the subform var form = solutionModel.getForm('SubForm'); // get the start offset of the body var height = form.getPartYOffset(JSPart.BODY); // place a new button based on the start offset. form.newButton('mybutton',50,50+height,80,20,solutionModel.getGlobalMethod('globals', 'test'));
getPartYOffset
(type, height)
Returns
Number – A number holding the Y offset of the specified form part.
Sample
// get the subform var form = solutionModel.getForm('SubForm'); // get the start offset of the body var height = form.getPartYOffset(JSPart.BODY); // place a new button based on the start offset. form.newButton('mybutton',50,50+height,80,20,solutionModel.getGlobalMethod('globals', 'test'));
JSPart[]
getParts
()
Returns
JSPart[] – An array of JSPart instances corresponding to the parts of the form.
Sample
var allParts = form.getParts() for (var i=0; i<allParts.length; i++) { if (allParts[i].getPartType() == JSPart.BODY) application.output('body Y offset: ' + allParts[i].getPartYOffset()); }
JSPart[]
getParts
(returnInheritedElements)
Parameters
{Boolean} returnInheritedElements – true to also return the parts from parent form
Returns
JSPart[] – An array of JSPart instances corresponding to the parts of the form.
Sample
var allParts = form.getParts() for (var i=0; i<allParts.length; i++) { if (allParts[i].getPartType() == JSPart.BODY) application.output('body Y offset: ' + allParts[i].getPartYOffset()); }
getPortal
(name)
Parameters
{String} name – the specified name of the portal
Sample
var frm = solutionModel.getForm("myForm"); var portal = frm.getPortal("myPortal"); portal.initialSort = 'my_table_text desc';
JSPortal[]
getPortals
()
Returns
JSPortal[] – an array of all JSPortal objects on this form
Sample
var frm = solutionModel.getForm("myForm"); var portals = frm.getPortals(); for (var i in portals) { var p = portals[i]; if (p.name != null) application.output(p.name); else application.output("unnamed portal detected"); }
JSPortal[]
getPortals
(returnInheritedElements)
Parameters
{Boolean} returnInheritedElements – true to also return the elements from parent form
Returns
JSPortal[] – an array of all JSPortal objects on this form
Sample
var frm = solutionModel.getForm("myForm"); var portals = frm.getPortals(); for (var i in portals) { var p = portals[i]; if (p.name != null) application.output(p.name); else application.output("unnamed portal detected"); }
getTabPanel
(name)
Parameters
{String} name – the specified name of the tabpanel
Sample
var frm = solutionModel.getForm("myForm"); var tabPanel = frm.getTabPanel("myTabPanel"); var tabs = tabPanel.getTabs(); for (var i=0; i<tabs.length; i++) application.output("Tab " + i + " has text " + tabs[i].text);
getTabPanels
()
Returns
JSTabPanel[] – an array of all JSTabPanel objects on this form
Sample
var frm = solutionModel.getForm("myForm"); var tabPanels = frm.getTabPanels(); for (var i in tabPanels) { var tp = tabPanels[i]; if (tp.name != null) application.output("Tab " + tp.name + " has text " + tp.text); else application.output("Tab with text " + tp.text + " has no name"); }
getTabPanels
(returnInheritedElements)
Parameters
{Boolean} returnInheritedElements – true to also return the elements from parent form
Returns
JSTabPanel[] – an array of all JSTabPanel objects on this form
Sample
var frm = solutionModel.getForm("myForm"); var tabPanels = frm.getTabPanels(); for (var i in tabPanels) { var tp = tabPanels[i]; if (tp.name != null) application.output("Tab " + tp.name + " has text " + tp.text); else application.output("Tab with text " + tp.text + " has no name"); }
getTitleFooterPart
()
Returns
JSPart – A JSPart instance corresponding to the Title Footer part of the form.
Sample
form.getTitleFooterPart().background = 'gray';
getTitleHeaderPart
()
Returns
JSPart – A JSPart instance corresponding to the Title Header part of the form.
Sample
form.getTitleHeaderPart().background = 'red';
getTrailingGrandSummaryPart
()
Returns
JSPart – A JSPart instance corresponding to the Trailing Grand Summary part of the form.
Sample
form.getTrailingGrandSummaryPart().background = 'yellow';
JSPart[]
getTrailingSubSummaryParts
()
Returns
JSPart[] – An array of JSPart instances corresponding to the Trailing Subsummary parts of the form.
Sample
form.getTrailingSubSummaryParts()[0].background = 'green';
Sample
var form_UUID = myForm.getUUID(); application.output(form_UUID.toString());
getVariable
(name)
Parameters
{String} name – the specified name of the variable
Sample
var frm = solutionModel.getForm("myForm"); var fvariable = frm.getVariable("myVarName"); application.output(fvariable.name + " has the default value of " + fvariable.defaultValue);
getVariables
()
Returns
JSVariable[] – an array of all variables on this form
Sample
var frm = solutionModel.getForm("myForm"); var variables = frm.getVariables(); for (var i in variables) application.output(variables[i].name);
getVariables
(returnInheritedElements)
Parameters
{Boolean} returnInheritedElements – true to also return the elements from the parent form
Returns
JSVariable[] – an array of all variables on this form
Sample
var frm = solutionModel.getForm("myForm"); var variables = frm.getVariables(); for (var i in variables) application.output(variables[i].name);
newBean
(name, className, x, y, width, height)
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
Sample
var form = solutionModel.newForm('newForm1', 'db:/server1/table1', null, true, 800, 600); var bean = form.newBean('bean','com.servoy.extensions.beans.dbtreeview.DBTreeView',200,200,300,300); forms['newForm1'].controller.show();
newButton
(txt, x, y, width, height, 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
Sample
var form = solutionModel.newForm('newForm1', myDatasource, null, true, 800, 600); var method = form.newMethod('function onAction(event) { application.output("onAction intercepted on " + event.getFormName()); }'); var button = form.newButton('myButton', 10, 10, 100, 30, method); application.output("The new button: " + button.name + " has the following onAction event handling method assigned " + button.onAction.getName());
newCalendar
(dataprovider, x, y, width, height)
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
var form = solutionModel.newForm('newForm1', myDatasource, null, true, 800, 600); var calendar = form.newCalendar(myDataProvider, 100, 100, 200, 200); forms['newForm1'].controller.show();
newCheck
(dataprovider, x, y, width, height)
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
var form = solutionModel.newForm('newForm1', myDatasource, null, true, 800, 600); var calendar = form.newCheck(myDataProvider, 100, 100, 200, 200); forms['newForm1'].controller.show();
newComboBox
(dataprovider, x, y, width, height)
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
var form = solutionModel.newForm('newForm1', myDatasource, null, true, 800, 600); var calendar = form.newComboBox(myDataProvider, 100, 100, 200, 200); forms['newForm1'].controller.show();
newField
(dataprovider, type, x, y, width, height)
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
var form = solutionModel.newForm('newForm1', myDatasource, null, true, 800, 600); var variable = form.newVariable('myVar', JSVariable.TEXT); variable.defaultValue = "'This is a default value (with triple quotes)!'"; var field = form.newField(variable, JSField.TEXT_FIELD, 100, 100, 200, 200); forms['newForm1'].controller.show();
newFooterPart
(height)
Returns
JSPart – A JSFooter instance corresponding to the newly created Footer form part.
Sample
var footer = form.newFooterPart(440);
newHeaderPart
(height)
Returns
JSPart – A JSPart instance corresponding to the newly created Header form part.
Sample
var header = form.newHeaderPart(80);
newHtmlArea
(dataprovider, x, y, width, height)
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
var form = solutionModel.newForm('newForm1', myDatasource, null, true, 800, 600); var textProvider = form.newVariable('myVar',JSVariable.TEXT); textProvider.defaultValue = "'This is a triple quoted text!'"; var htmlArea = myListViewForm.newHtmlArea(textProvider,100,100,100,100); forms['newForm1'].controller.show();
newImageMedia
(dataprovider, x, y, width, height)
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
var form = solutionModel.newForm('newForm1', myDatasource, null, true, 800, 600); var myMediaVar = form.newVariable("media", JSVariable.MEDIA); var imageMedia = form.newImageMedia(myMediaVar,100,100,200,200) forms['newForm1'].controller.show();
newLabel
(txt, x, y, width, height)
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
Sample
var form = solutionModel.newForm('newForm1', myDatasource, null, true, 800, 600); var label = form.newLabel('The text on the label', 140, 140, 50, 20); forms['newForm1'].controller.show();
newLabel
(txt, x, y, width, height, action)
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
Sample
var form = solutionModel.newForm('newForm1', myDatasource, null, true, 800, 600); var label = form.newLabel('The text on the label', 140, 140, 50, 20); forms['newForm1'].controller.show();
newLeadingGrandSummaryPart
(height)
Returns
JSPart – A JSPart instance corresponding to the newly created Leading Grand Summary form part.
Sample
var leadingGrandSummary = form.newLeadingGrandSummaryPart(120);
newLeadingSubSummaryPart
(height)
Returns
JSPart – A JSPart instance corresponding to the newly created Leading Subsummary form part.
Sample
var leadingSubsummary = form.newLeadingSubSummaryPart(160);
newListBox
(dataprovider, x, y, width, height)
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
var form = solutionModel.newForm('newForm1', 'myServer', 'myTable', null, true, 800, 600); var list = form.newListBox(myDataProvider, 100, 100, 200, 200); forms['newForm1'].controller.show();
newMethod
(code)
Parameters
{String} code – the specified code for the new method
Sample
var form = solutionModel.newForm('newForm1', myDatasource, null, true, 800, 600); var method = form.newMethod('function aMethod(event){application.output("Hello world!");}'); var button = myListViewForm.newButton('Show message!',50,50,100,30,method); forms['newForm1'].controller.show();
newMultiSelectListBox
(dataprovider, x, y, width, height)
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
var form = solutionModel.newForm('newForm1', 'myServer', 'myTable', null, true, 800, 600); var calendar = form.newMultiSelectListBox(myDataProvider, 100, 100, 200, 200); forms['newForm1'].controller.show();
newPart
(type, height)
Returns
JSPart – A JSPart instance corresponding to the newly created form part.
Sample
var form = solutionModel.newForm('myForm', 'db:/example_data/my_table', null, false, 1200, 800); var header = form.newPart(JSPart.HEADER, 100); header.background = 'yellow'; var body = form.newPart(JSPart.BODY, 700); body.background = 'green'; var footer = form.newPart(JSPart.FOOTER, 800); footer.background = 'orange';
newPassword
(dataprovider, x, y, width, height)
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
var form = solutionModel.newForm('newForm1', myDatasource, null, true, 800, 600); var pass = form.newPassword(scopes.globals.aVariable, 100, 100, 70, 30); forms['newForm1'].controller.show();
newPortal
(name, relation, x, y, width, height)
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
Sample
var form = solutionModel.newForm('newForm1', 'db:/server1/table1', null, true, 800, 600); var relation = solutionModel.newRelation('parentToChild','db:/server1/table1','db:/server2/table2',JSRelation.INNER_JOIN); relation.newRelationItem('another_parent_table_id', '=', 'another_child_table_parent_id'); var portal = form.newPortal('portal',relation,200,200,300,300); portal.newField('someColumn',JSField.TEXT_FIELD,200,200,120); forms['newForm1'].controller.show();
newRadios
(dataprovider, x, y, width, height)
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
var form = solutionModel.newForm('newForm1', myDatasource, null, true, 800, 600); var vlist = solutionModel.newValueList('options',JSValueList.CUSTOM_VALUES); vlist.customValues = "value1\nvalue2\nvalue3"; var radios = form.newRadios('columnDataProvider',100,100,200,200); radios.valuelist = vlist;
newRtfArea
(dataprovider, x, y, width, height)
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
var form = solutionModel.newForm('newForm1',myDatasource,null,true,800,600); var rtf_area = form.newRtfArea('columnDataProvider',100,100,100,100); forms['newForm1'].controller.show();
newSpinner
(dataprovider, x, y, width, height)
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
var form = solutionModel.newForm('newForm1', 'myServer', 'myTable', null, true, 800, 600); var spinner = form.newSpinner(myDataProvider, 10, 460, 100, 20); forms['newForm1'].controller.show();
newTabPanel
(name, x, y, width, height)
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
Sample
var form = solutionModel.newForm('parentForm','db:/server1/parent_table',null,false,640,480); var childOne = solutionModel.newForm('childOne','db:/server1/child_table',null,false,400,300); childOne.newField('child_table_text', JSField.TEXT_FIELD,10,10,100,20); var parentToChild = solutionModel.newRelation('parentToChild','db:/server1/parent_table','db:/server1/child_table',JSRelation.INNER_JOIN); parentToChild.newRelationItem('parent_table_id','=','child_table_parent_id'); var childTwo = solutionModel.newForm('childTwo','db:/server1/my_table',null,false,400,300); childTwo.newField('my_table_image', JSField.IMAGE_MEDIA,10,10,100,100); var tabPanel = form.newTabPanel('tabs',10,10,620,460); tabPanel.newTab('tab1','Child One',childOne,parentToChild); tabPanel.newTab('tab2','Child Two',childTwo); forms['parentForm'].controller.show();
newTextArea
(dataprovider, x, y, width, height)
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
var form = solutionModel.newForm('newForm1',myDatasource,null,true,800,600); var globalVar = solutionModel.newGlobalVariable('globals', 'myGlobal',JSVariable.TEXT); globalVar.defaultValue = "'Type your text in here'"; var textArea = form.newTextArea(globalVar,100,100,300,150); forms['newForm1'].controller.show();
newTextField
(dataprovider, x, y, width, height)
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
var form = solutionModel.newForm('newForm1',myDatasource,null,true,800,600); //choose the dataprovider or jsvariable you want for the Text Field var x = null; //global jsvariable as the dataprovider //x = solutionModel.newGlobalVariable('globals', 'myGlobal',JSVariable.TEXT); //x.defaultValue = "'Text from a global variable'"; //or a form jsvariable as the dataprovider //x = form.newVariable('myFormVar',JSVariable.TEXT); //x.defaultValue = "'Text from a form variable'"; var textField = form.newTextField(x,100,100,200,50); //or a column data provider as the dataprovider //textField.dataProviderID = columnTextDataProvider; forms['newForm1'].controller.show();
newTitleFooterPart
(height)
Returns
JSPart – A JSPart instance corresponding to the newly created Title Footer form part.
Sample
var titleFooter = form.newTitleFooterPart(500);
newTitleHeaderPart
(height)
Returns
JSPart – A JSPart instance corresponding to the newly created Title Header form part.
Sample
var titleHeader = form.newTitleHeaderPart(40);
newTrailingGrandSummaryPart
(height)
Returns
JSPart – A JSPart instance corresponding to the newly created Trailing Grand Summary form part.
Sample
var trailingGrandSummary = form.newTrailingGrandSummaryPart(400);
newTrailingSubSummaryPart
(height)
Returns
JSPart – A JSPart instance corresponding to the newly created Trailing Subsummary form part.
Sample
var trailingSubsummary = form.newTrailingSubSummaryPart(360);
newTypeAhead
(dataprovider, x, y, width, height)
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
var form = solutionModel.newForm('newForm1',myDatasource,null,true,800,600); var vlist = solutionModel.newValueList('options',JSValueList.CUSTOM_VALUES); vlist.customValues = "value1\nvalue2\nvalue3"; var typeAhead = form.newTypeAhead(columnTextDataProvider,100,100,300,200); typeAhead.valuelist = vlist; forms['newForm1'].controller.show();
newVariable
(name, type)
Sample
var form = solutionModel.newForm('newForm1', myDatasource, null, true, 800, 600); var variable = form.newVariable('myVar', JSVariable.TEXT , "'This is a default value (with triple quotes)!'"); //or variable = form.newVariable('myVar', JSVariable.TEXT) //variable.defaultValue = "'This is a default value (with triple quotes)!'" // setting the default value after the variable is created requires form recreation //variable.defaultValue = "{a:'First letter',b:'Second letter'}" var field = form.newField(variable, JSField.TEXT_FIELD, 100, 100, 200, 200); forms['newForm1'].controller.show();
newVariable
(name, type, defaultValue)
Sample
var form = solutionModel.newForm('newForm1', myDatasource, null, true, 800, 600); var variable = form.newVariable('myVar', JSVariable.TEXT , "'This is a default value (with triple quotes)!'"); //or variable = form.newVariable('myVar', JSVariable.TEXT) //variable.defaultValue = "'This is a default value (with triple quotes)!'" // setting the default value after the variable is created requires form recreation //variable.defaultValue = "{a:'First letter',b:'Second letter'}" var field = form.newField(variable, JSField.TEXT_FIELD, 100, 100, 200, 200); forms['newForm1'].controller.show();
putDesignTimeProperty
()
Sample
var frm = solutionModel.getForm('orders') frm.putDesignTimeProperty('myprop', 'lemon')
removeBean
(name)
Parameters
{String} name – the specified name of the JSBean to be removed
Returns
Boolean – true if the JSBean has been removed; false otherwise
Sample
var form = solutionModel.getForm('myform'); form.removeBean('mybean')
removeButton
(name)
Parameters
{String} name – the specified name of the JSButton to be removed
Returns
Boolean – true if the JSButton has been removed; false otherwise
Sample
var form = solutionModel.newForm('newFormX',myDatasource,null,true,800,600); var b1 = form.newButton('This is button1',100,100,200,50,null); b1.name = 'b1'; var jsmethod = form.newMethod("function removeMe(event) { var form = solutionModel.getForm('newFormX'); if (form.removeButton('b1') == true) application.output('Button has been removed ok'); else application.output('Button could not be deleted'); forms['newFormX'].controller.recreateUI();}"); var b2 = form.newButton('Click here to remove button1',100,230,200,50,jsmethod); b2.name = 'b2'; forms['newFormX'].controller.show();
removeComponent
(name)
Parameters
{String} name – the specified name of the component to be deleted
Returns
Boolean – true if component has been successfully deleted; false otherwise
Sample
var form = solutionModel.newForm('newFormX','db:/server1/parent_table',null,true,1000,750); var jsbutton = form.newButton('JSButton to delete',100,100,200,50,null); jsbutton.name = 'jsb'; var jslabel = form.newLabel('JSLabel to delete',100,200,200,50,null); jslabel.name = 'jsl'; jslabel.transparent = false; jslabel.background = 'green'; var jsfield = form.newField('scopes.globals.myGlobalVariable',JSField.TEXT_FIELD,100,300,200,50); jsfield.name = 'jsf'; var relation = solutionModel.newRelation('parentToChild','db:/server1/parent_table','db:/server1/child_table',JSRelation.INNER_JOIN); relation.newRelationItem('parent_table_id', '=', 'child_table_id'); var jsportal = form.newPortal('jsp',relation,100,400,300,300); jsportal.newField('child_table_id',JSField.TEXT_FIELD,200,200,120); var childOne = solutionModel.newForm('childOne','db:/server1/child_table',null,false,400,300); childOne.newField('child_table_id', JSField.TEXT_FIELD,10,10,100,20); var childTwo = solutionModel.newForm('childTwo','server1','other_table',null,false,400,300); childTwo.newField('some_table_id', JSField.TEXT_FIELD,10,10,100,100); var jstabpanel = form.newTabPanel('jst',450,30,620,460); jstabpanel.newTab('tab1','Child One',childOne,relation); jstabpanel.newTab('tab2','Child Two',childTwo); var jsmethod = form.newMethod("function removeMe(event) { var form = solutionModel.getForm('newFormX');\n if ((form.removeComponent('jsb') == true) && (form.removeComponent('jsl') == true) && (form.removeComponent('jsf') == true) && (form.removeComponent('jsp') == true) & (form.removeComponent('jst') == true)) application.output('Components removed ok'); else application.output('Some component(s) could not be deleted'); forms['newFormX'].controller.recreateUI();}"); var removerButton = form.newButton('Click here to remove form components',450,500,250,50,jsmethod); removerButton.name = 'remover'; forms['newFormX'].controller.show();
removeDesignTimeProperty
()
Sample
var frm = solutionModel.getForm('orders') frm.removeDesignTimeProperty('myprop')
removeField
(name)
Parameters
{String} name – the specified name of the JSField to remove
Returns
Boolean – true is the JSField has been successfully removed; false otherwise
Sample
var form = solutionModel.newForm('newFormX',myDatasource,null,true,800,600); var jsfield = form.newField(scopes.globals.myGlobalVariable,JSField.TEXT_FIELD,100,300,200,50); jsfield.name = 'jsf'; var jsmethod = form.newMethod("function removeMe(event) { var form = solutionModel.getForm('newFormX');\n if (form.removeComponent('jsf') == true) application.output('Field has been removed ok'); else application.output('Field could not be deleted'); forms['newFormX'].controller.recreateUI();}"); var removerButton = form.newButton('Click here to remove the field',450,500,250,50,jsmethod); removerButton.name = 'remover'; forms['newFormX'].controller.show();
removeLabel
(name)
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
var form = solutionModel.newForm('newFormX',myDatasource,null,true,1000,750); var jslabel = form.newLabel('JSLabel to delete',100,200,200,50,null); jslabel.name = 'jsl'; jslabel.transparent = false; jslabel.background = 'green'; var jsmethod = form.newMethod("function removeMe(event) { var form = solutionModel.getForm('newFormX'); if (form.removeComponent('jsl') == true) application.output('Label has been removed'); else application.output('Label could not be deleted'); forms['newFormX'].controller.recreateUI();}"); var removerButton = form.newButton('Click here to remove the green label',450,500,250,50,jsmethod); removerButton.name = 'remover'; forms['newFormX'].controller.show();
removeMethod
(name)
Parameters
{String} name – the specified name of the method
Returns
Boolean – true if method was removed successfully , false otherwise
Sample
var form = solutionModel.newForm('newForm1', null, null, true, 800, 600); var hello = form.newMethod('function aMethod(event){application.output("Hello world!");}'); var removeMethod = form.newMethod('function removeMethod(event){ \ solutionModel.getForm(event.getFormName()).removeMethod("aMethod"); \ forms[event.getFormName()].controller.recreateUI();\ }'); var button1 = form.newButton('Call method!',50,50,120,30,hello); var button2 = form.newButton('Remove Mehtod!',200,50,120,30,removeMethod); forms['newForm1'].controller.show();
removePart
(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
form.removePart(JSPart.HEADER); form.removePart(JSPart.LEADING_SUBSUMMARY, 160);
removePart
(type, height)
Returns
Boolean – True if the part is successfully removed, false otherwise.
Sample
form.removePart(JSPart.HEADER); form.removePart(JSPart.LEADING_SUBSUMMARY, 160);
removePortal
(name)
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
var form = solutionModel.newForm('newFormX',myDatasource,null,true,800,600); var relation = solutionModel.newRelation('parentToChild','db:/server1/myTable','db:/server1/myOtherTable',JSRelation.INNER_JOIN); relation.newRelationItem('parent_table_id', '=', 'child_table_id'); var jsportal = form.newPortal('jsp',relation,100,400,300,300); jsportal.newField('child_table_id',JSField.TEXT_FIELD,200,200,120); var jsmethod = form.newMethod("function removeMe(event) { var form = solutionModel.getForm('newFormX');\n if (form.removeComponent('jsp') == true) application.output('Portal removed ok'); else application.output('Portal could not be deleted'); forms['newFormX'].controller.recreateUI();}"); var removerButton = form.newButton('Click here to remove the portal',450,500,250,50,jsmethod); removerButton.name = 'remover'; forms['newFormX'].controller.show();
removeTabPanel
(name)
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
var form = solutionModel.newForm('newFormX','db:/server1/parent_table',null,false,800,600); var childOne = solutionModel.newForm('childOne','db:/server1/child_table',null,false,400,300); childOne.newField('child_table_text', JSField.TEXT_FIELD,10,10,100,20); var parentToChild = solutionModel.newRelation('parentToChild','db:/server1/parent_table','db:/server1/child_table',JSRelation.INNER_JOIN); parentToChild.newRelationItem('parent_table_id','=','child_table_id'); var childTwo = solutionModel.newForm('childTwo','db:/server1/another_table',null,false,400,300); childTwo.newField('columnDataProvider', JSField.TEXT_FIELD,10,10,100,100); var tabPanel = form.newTabPanel('jst',10,10,620,460); tabPanel.newTab('tab1','Child One',childOne,parentToChild); tabPanel.newTab('tab2','Child Two',childTwo); var jsmethod = form.newMethod("function removeMe(event) { var form = solutionModel.getForm('newFormX');\n if (form.removeComponent('jst') == true)\n application.output('TabPanel has been removed ok');\n else\n application.output('TabPanel could not be deleted');\n forms['newFormX'].controller.recreateUI();\n}"); var removerButton = form.newButton('Click here to remove the tab panel',450,500,250,50,jsmethod); removerButton.name = 'remover'; forms['newFormX'].controller.show();
removeVariable
(name)
Parameters
{String} name – the specified name of the variable
Returns
Boolean – true if removed, false otherwise (ex: no var with that name)
Sample
var form = solutionModel.newForm('newForm1', null, null, true, 800, 600); var variable = form.newVariable('myVar', JSVariable.TEXT); variable.defaultValue = "'This is a default value (with triple quotes)!'"; //variable.defaultValue = "{a:'First letter',b:'Second letter'}" var field = form.newField(variable, JSField.TEXT_FIELD, 100, 100, 200, 200); forms['newForm1'].controller.show(); variable = form.removeVariable('myVar'); application.sleep(4000); forms['newForm1'].controller.recreateUI();