Property Summery | |
---|---|
Boolean | #enabled Gets or sets the enabled state of a form; also known as "grayed-out". |
Boolean | #readOnly Note: The field(s) in a form set as read-only can be selected and the field data can be copied to clipboard. |
Number | #view Get/Set the current type of view of this form. |
Method Summery | |
---|---|
Boolean | #deleteAllRecords() Deletes all records in foundset, resulting in empty foundset. |
Boolean | #deleteRecord() Delete current selected record, deletes mulitple selected records incase the foundset is using multiselect. |
Boolean | #duplicateRecord([location]) Duplicate current record or record at index in the form foundset. |
Boolean | #find() Start a find request, use the "search" function to perform/exit the find. |
void | #focusField(fieldName, skipReadonly) Sets focus to a field specified by its name. |
void | #focusFirstField() Sets focus to the first field of the form; based on tab order sequence. |
String | #getContainerName() Get the name of the window/dialog this form is displayed in. |
Number | #getDataProviderMaxLength(name) Returns the maximum length allowed in the specified dataprovider. |
Object | #getDataProviderValue(dataProvider) Gets a value based on the specified dataprovider name. |
String | #getDataSource() Get the used datasource. |
Boolean | #getDesignMode() Returns the state of this form designmode. |
JSDataSet | #getFormContext() Gets the forms context where it resides, returns a dataset of its structure to the main controller. |
Number | #getFormWidth() Gets the form width in pixels. |
Number | #getMaxRecordIndex() Returns the current cached record count of the current foundset. |
String | #getName() Get the name of this form. |
Number | #getPartHeight(partType) Gets the part height in pixels. |
Number | #getPartYOffset(partType) Returns the Y offset of a given part of the form. |
Number | #getSelectedIndex() Gets the current record index of the current foundset. |
String[] | #getTabSequence() Get an array with the names of the components that are part of the tab sequence. |
Boolean | #invertRecords() Inverts the current foundset against all rows of the current table; all records that are not in the foundset will become the current foundset. |
Boolean | #loadAllRecords() Loads all accessible records from the datasource into the form foundset. |
Boolean | #loadOmittedRecords() Loads the records that are currently omitted in the form foundset. |
Boolean | #loadRecords([data], [queryArgumentsArray]) Load records via a (related) foundset, primary key (dataset/number/uuid) or query into the form. |
Boolean | #newRecord([location]) Create a new record in the form foundset. |
Boolean | #omitRecord() Omit current record in form foundset, to be shown with loadOmittedRecords. |
void | #print([printCurrentRecordOnly], [showPrinterSelectDialog], [printerJob]) Print this form with current foundset, without preview. |
String | #printXML([printCurrentRecordOnly]) Print this form with current foundset records to xml format. |
Boolean | #recreateUI() Recreates the forms UI components, to reflect the latest solution model. |
void | #relookup() Performs a relookup for the current foundset record dataproviders. |
Number | #search([clearLastResults], [reduceSearch]) Start the database search and use the results, returns the number of records, make sure you did "find" function first. |
void | #setDataProviderValue(dataprovider, value) Sets the value based on a specified dataprovider name. |
void | #setDesignMode([ondrag], [ondrop], [onselect], [onresize]) Sets this form in designmode with param true or one or more methods. |
void | #setPageFormat(width, height, leftmargin, rightmargin, topmargin, bottommargin, [orientation], [units]) Set the page format to use when printing. |
void | #setPreferredPrinter(printerName) Set the preferred printer name to use when printing. |
void | #setSelectedIndex(index) Sets the current record index of the current foundset. |
void | #setTabSequence(arrayOfElements) Set the tab order sequence programatically, by passing the elements references in a javascript array. |
void | #show([dialogName/windowName], [modal]) Shows the form (makes the form visible), optionally shown in the specified dialog (modal or not)/window. |
void | #showPrintPreview([printCurrentRecordOnly], [printerJob], [zoomFactor]) Show this form in print preview. |
void | #showRecords(data, [dialogName/windowName], [modal]) Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'. |
void | #sort(sortString, [defer]) Sorts the form foundset based on the given sort string. |
void | #sortDialog([sortString]) Show the sort dialog to the user a preselection sortString can be passed, to sort the form foundset. |
Property Details |
---|
enabled |
Gets or sets the enabled state of a form; also known as "grayed-out". Notes: |
Returns Boolean |
Sample//gets the enabled state of the form var state = forms.customer.controller.enabled; //enables the form for input forms.customer.controller.enabled = true; |
readOnly |
Gets or sets the read-only state of a form; also known as "editable" Note: The field(s) in a form set as read-only can be selected and the field data can be copied to clipboard. |
Returns Boolean |
Sample//gets the read-only state of the form var state = forms.customer.controller.readOnly; //sets the read-only state of the form forms.customer.controller.readOnly = true |
view |
Get/Set the current type of view of this form. |
Returns Number |
Sample//gets the type of view for this form var view = forms.customer.controller.view; //sets the form to Record view forms.customer.controller.view = 0;//RECORD_VIEW //sets the form to List view forms.customer.controller.view = 1;//LIST_VIEW |
Method Details |
---|
deleteAllRecords |
Boolean deleteAllRecords () |
Deletes all records in foundset, resulting in empty foundset. |
Returns Boolean – false incase of related foundset having records and orphans records are not allowed by the relation |
Samplevar success = forms.customer.controller.deleteAllRecords(); |
deleteRecord |
Boolean deleteRecord () |
Delete current selected record, deletes mulitple selected records incase the foundset is using multiselect. |
Returns Boolean – false incase of related foundset having records and orphans records are not allowed by the relation |
Samplevar success = forms.customer.controller.deleteRecord(); |
duplicateRecord |
Boolean duplicateRecord ([location]) |
Duplicate current record or record at index in the form foundset. |
Parameters [location] – boolean true adds the new record as the topmost record, or adds at specified index |
Returns Boolean – true if succesful |
Sampleforms.customer.controller.duplicateRecord(); //duplicate the current record, adds on top //forms.customer.controller.duplicateRecord(false); //duplicate the current record, adds at bottom //forms.customer.controller.duplicateRecord(1,2); //duplicate the first record as second record |
find |
Boolean find () |
Start a find request, use the "search" function to perform/exit the find. Syntax: Example: |
Returns Boolean – true if successful, will return false if autosave is disabled and there are unsaved records. |
Also see |
Sampleif (forms.customer.controller.find()) //find will fail if autosave is disabled and there are unsaved records { columnTextDataProvider = '=a search value'; columnNumberDataProvider = '>10'; columnDateDataProvider = '>=10-03-2009|dd-MM-yyyy'; forms.customer.controller.search() } |
focusField |
void focusField (fieldName, skipReadonly) |
Sets focus to a field specified by its name. If the second parameter is set to true, then readonly fields will be skipped (the focus will be set to the first non-readonly field located after the field with the specified name; the tab sequence is respected when searching for the non-readonly field). |
Parameters {String} fieldName – the name of the field to be focussed {Boolean} skipReadonly – boolean indication to skip read only fields, if the named field happens to be read only |
Returns void |
Samplevar tabseq = forms.customer.controller.getTabSequence(); if (tabseq.length > 1) { // If there is more than one field in the tab sequence, // focus the second one and skip over readonly fields. forms.customer.controller.focusField(tabseq[1], true); } else { // If there is at most one field in the tab sequence, then focus // whatever field is first, and don't bother to skip over readonly fields. forms.customer.controller.focusField(null, false); } |
focusFirstField |
void focusFirstField () |
Sets focus to the first field of the form; based on tab order sequence. |
Returns void |
Also see |
Sampleforms.customer.controller.focusFirstField(); |
getContainerName |
String getContainerName () |
Get the name of the window/dialog this form is displayed in. |
Returns String – the name of the window/dialog this form is displayed in. If the form is not showing in a window or dialog (other then main application frame), it returns null. |
Also see |
Samplevar dialogOrWindowName = forms.customer.controller.getContainerName(); if (dialogOrWindowName != null) { application.closeForm(dialogOrWindowName); } |
getDataProviderMaxLength |
Number getDataProviderMaxLength (name) |
Returns the maximum length allowed in the specified dataprovider. |
Parameters {String} name – the dataprovider name |
Returns Number – the length |
Sampleforms.customer.controller.getDataProviderMaxLength('name'); |
getDataProviderValue |
Object getDataProviderValue (dataProvider) |
Gets a value based on the specified dataprovider name. |
Parameters {String} dataProvider – the dataprovider name to retieve the value for |
Returns Object – the dataprovider value (null if unknown dataprovider) |
Samplevar val = forms.customer.controller.getDataProviderValue('contact_name'); |
getDataSource |
String getDataSource () |
Get the used datasource. |
Returns String – the datasource |
Samplevar dataSource = forms.customer.controller.getDataSource(); |
getDesignMode |
Boolean getDesignMode () |
Returns the state of this form designmode. |
Returns Boolean – the design mode state (true/fase) |
Samplevar success = forms.customer.controller.getDesignMode(); |
getFormContext |
JSDataSet getFormContext () |
Gets the forms context where it resides, returns a dataset of its structure to the main controller. Note: can't be called in onload, because no context is yet available at this time. |
Returns JSDataSet – the dataset with form context |
Also see |
Samplevar dataset = forms.customer.controller.getFormContext(); if (dataset.getMaxRowIndex() > 1) { // form is in a tabpanel //dataset columns: [containername(1),formname(2),tabpanel or beanname(3),tabname(4),tabindex(5)] //dataset rows: mainform(1) -> parent(2) -> current form(3) (when 3 forms deep) var parentFormName = dataset.getValue(1,2) } |
getFormWidth |
Number getFormWidth () |
Gets the form width in pixels. |
Returns Number – the width in pixels |
Samplevar width = forms.customer.controller.getFormWidth(); |
getMaxRecordIndex |
Number getMaxRecordIndex () |
Returns the current cached record count of the current foundset. To return the full foundset count, use: databaseManager.getFoundSetCount(...) Tip: get the the table count of all rows in a table, use: databaseManager.getTableCount(...) |
Returns Number – the max record index |
Also see |
Samplefor ( var i = 1 ; i <= forms.customer.controller.getMaxRecordIndex() ; i++ ) { forms.customer.controller.setSelectedIndex(i); //do some action per record } |
getName |
String getName () |
Get the name of this form. |
Returns String – the name |
Samplevar formName = forms.customer.controller.getName(); |
getPartHeight |
Number getPartHeight (partType) |
Gets the part height in pixels. |
Parameters {Number} partType – The type of the part whose height will be returned. |
Returns Number – the part height in pixels |
Samplevar height = forms.customer.controller.getPartHeight(JSPart.BODY); |
getPartYOffset |
Number getPartYOffset (partType) |
Returns the Y offset of a given part of the form. |
Parameters {Number} partType – The type of the part whose Y offset will be returned. |
Returns Number – A number holding the Y offset of the specified form part. |
Samplevar offset = forms.customer.controller.getPartYOffset(JSPart.BODY); |
getSelectedIndex |
Number getSelectedIndex () |
Gets the current record index of the current foundset. |
Returns Number – the index |
Sample//gets the current record index in the current foundset var current = forms.customer.controller.getSelectedIndex(); //sets the next record in the foundset, will be reflected in UI forms.customer.controller.setSelectedIndex(current+1); |
getTabSequence |
String[] getTabSequence () |
Get an array with the names of the components that are part of the tab sequence. The order of the names respects the order of the tab sequence. Components that are not named will not appear in the returned array, although they may be in the tab sequence. |
Returns String[] – array of names |
Samplevar tabseq = forms.customer.controller.getTabSequence(); if (tabseq.length > 1) { // If there is more than one field in the tab sequence, // focus the second one and skip over readonly fields. forms.customer.controller.focusField(tabseq[1], true); } else { // If there is at most one field in the tab sequence, then focus // whatever field is first, and don't bother to skip over readonly fields. forms.customer.controller.focusField(null, false); } |
invertRecords |
Boolean invertRecords () |
Inverts the current foundset against all rows of the current table; all records that are not in the foundset will become the current foundset. |
Returns Boolean – true if successful |
Sampleforms.customer.controller.invertRecords(); |
loadAllRecords |
Boolean loadAllRecords () |
Loads all accessible records from the datasource into the form foundset. Notes: |
Returns Boolean – true if successful |
Also see |
Sampleforms.customer.controller.loadAllRecords(); |
loadOmittedRecords |
Boolean loadOmittedRecords () |
Loads the records that are currently omitted in the form foundset. |
Returns Boolean – true if successful |
Sampleforms.customer.controller.loadOmittedRecords(); |
loadRecords |
Boolean loadRecords ([data], [queryArgumentsArray]) |
Load records via a (related) foundset, primary key (dataset/number/uuid) or query into the form. Load records can be used in 5 different ways 2) to load a primary key dataset, will remove related sort! 3) to load a single record by primary key, will remove related sort! (pk should be a number or UUID) 4) to reload all last related records again, if for example after a search in related tabpanel 5) to load records in to the form based on a query (also known as 'Form by query') |
Parameters [data] – the foundset/pkdataset/singlenNmber_pk/UUIDpk/queryString to load [queryArgumentsArray] – the arguments to replace the questions marks in the queryString |
Returns Boolean – true if successful |
Also see |
Sample//Load records can be used in 5 different ways //1) to load a (related)foundset into the form. //the form will no longer share the default foundset with forms of the same datasource, use loadAllRecords to restore the default foundset //forms.customer.controller.loadRecords(order_to_orderdetails); //2) to load a primary key dataset, will remove related sort! //var dataset = databaseManager.getDataSetByQuery(...); // dataset must match the table primary key columns (alphabetically ordered) //forms.customer.controller.loadRecords(dataset); //3) to load a single record by primary key, will remove related sort! (pk should be a number or UUID) //forms.customer.controller.loadRecords(123); //forms.customer.controller.loadRecords(application.getUUID('6b5e2f5d-047e-45b3-80ee-3a32267b1f20')); //4) to reload all last related records again, if for example after a search in related tabpanel //forms.customer.controller.loadRecords(); //5) to load records in to the form based on a query (also known as 'Form by query') //forms.customer.controller.loadRecords(sqlstring,parameters); //limitations/requirements for sqlstring are: //-must start with 'select' //-the selected columns must be the (Servoy Form) table primary key columns (alphabetically ordered like 'select a_id, b_id,c_id ...') //-can contain '?' which are replaced with values from the array supplied to parameters argument // if the sqlstring contains an 'order by' clause, the records will be sorted accordingly and additional constraints apply: //-must contain 'from' keyword //-the 'from' must be a comma separated list of table names //-must at least select from the table used in Servoy Form //-cannot contain 'group by', 'having' or 'union' //-all columns must be fully qualified like 'orders.order_id' |
newRecord |
Boolean newRecord ([location]) |
Create a new record in the form foundset. |
Parameters [location] – boolean true adds the new record as the topmost record, or adds at specified index |
Returns Boolean – true if succesful |
Sample// foreign key data is only filled in for equals (=) relation items forms.customer.controller.newRecord();//default adds on top //forms.customer.controller.newRecord(false); //adds at bottom //forms.customer.controller.newRecord(2); //adds as second record |
omitRecord |
Boolean omitRecord () |
Omit current record in form foundset, to be shown with loadOmittedRecords. Note: The omitted records are discarded when these functions are executed: loadAllRecords, loadRecords(dataset), loadRecords(sqlstring), invert |
Returns Boolean – true if successful |
Also see |
Samplevar success = forms.customer.controller.omitRecord(); |
void print ([printCurrentRecordOnly], [showPrinterSelectDialog], [printerJob]) |
Print this form with current foundset, without preview. |
Parameters [printCurrentRecordOnly] – to print the current record only [showPrinterSelectDialog] – boolean to show the printer select dialog (default printer is normally used) [printerJob] – print to plugin printer job, see pdf printer plugin for example |
Returns void |
Sample//print this form (with foundset records) forms.customer.controller.print(); //print only current record (no printerSelectDialog) to pdf plugin printer //forms.customer.controller.print(true,false,plugins.pdf_output.getPDFPrinter('c:/temp/out.pdf')); |
printXML |
String printXML ([printCurrentRecordOnly]) |
Print this form with current foundset records to xml format. |
Parameters [printCurrentRecordOnly] – to print the current record only |
Returns String – the XML |
Sample//TIP: see also plugins.file.writeXMLFile(...) var xml = forms.customer.controller.printXML(); //print only current record //var xml = forms.customer.controller.printXML(true); |
recreateUI |
Boolean recreateUI () |
Recreates the forms UI components, to reflect the latest solution model. Use this after altering the elements via solutionModel at the JSForm of this form. |
Returns Boolean – true if successful |
Also see |
Sample// get the solution model JSForm var form = solutionModel.getForm("myForm"); // get the JSField of the form var field = form.getField("myField"); // alter the field field.x = field.x + 10; // recreate the runtime forms ui to reflect the changes. forms.customer.controller.recreateUI(); |
relookup |
void relookup () |
Performs a relookup for the current foundset record dataproviders. Lookups are defined in the dataprovider (columns) auto-enter setting and are normally performed over a relation upon record creation. |
Returns void |
Sampleforms.customer.controller.relookup(); |
search |
Number search ([clearLastResults], [reduceSearch]) |
Start the database search and use the results, returns the number of records, make sure you did "find" function first. Note: Omitted records are automatically excluded when performing a search - meaning that the foundset result by default will not include omitted records. |
Parameters [clearLastResults] – boolean, clear previous search, default true [reduceSearch] – boolean, reduce (true) or extend (false) previous search results, default true |
Returns Number – the recordCount |
Also see |
Samplevar recordCount = forms.customer.controller.search(); //var recordCount = forms.customer.controller.search(false,false); //to extend foundset |
setDataProviderValue |
void setDataProviderValue (dataprovider, value) |
Sets the value based on a specified dataprovider name. |
Parameters {String} dataprovider – the dataprovider name to set the value for {Object} value – the value to set in the dataprovider |
Returns void |
Sampleforms.customer.controller.setDataProviderValue('contact_name','mycompany'); |
setDesignMode |
void setDesignMode ([ondrag], [ondrop], [onselect], [onresize]) |
Sets this form in designmode with param true or one or more methods. return to normal editmode with first parameter false. |
Parameters [ondrag] – boolean to indicate the designmode state or onDrag method reference [ondrop] – onDrop method reference [onselect] – onSelect method reference [onresize] – onResize method reference |
Returns void |
Sample//Set the current form in designmode with no callbacks forms.customer.controller.setDesignMode(true); //Set the current form in designmode with callbacks forms.customer.controller.setDesignMode(onDragMethod,onDropMethod,onSelectMethod,onResizeMethod); //Set the current form out of designmode (to normal browse) forms.customer.controller.setDesignMode(false); |
setPageFormat |
void setPageFormat (width, height, leftmargin, rightmargin, topmargin, bottommargin, [orientation], [units]) |
Set the page format to use when printing. Orientation values: Units values: Note: The unit specified for width, height and all margins MUST be the same. |
Parameters width – the specified width of the page to be printed. height – the specified height of the page to be printed. leftmargin – the specified left margin of the page to be printed. rightmargin – the specified right margin of the page to be printed. topmargin – the specified top margin of the page to be printed. bottommargin – the specified bottom margin of the page to be printed. [orientation] – the specified orientation of the page to be printed; the default is Portrait mode [units] – the specified units for the width and height of the page to be printed; the default is pixels |
Returns void |
Sample//Set page format to a custom size of 100x200 pixels with 10 pixel margins on all sides in portrait mode forms.customer.controller.setPageFormat(100, 200, 10, 10, 10, 10); //Set page format to a custom size of 100x200 mm in landscape mode forms.customer.controller.setPageFormat(100, 200, 0, 0, 0, 0, 0, 0); //Set page format to a custom size of 100x200 inch in portrait mode forms.customer.controller.setPageFormat(100, 200, 0, 0, 0, 0, 1, 1); |
setPreferredPrinter |
void setPreferredPrinter (printerName) |
Set the preferred printer name to use when printing. |
Parameters {String} printerName – The name of the printer to be used when printing. |
Returns void |
Sampleforms.customer.controller.setPreferredPrinter('HP Laser 2200'); |
setSelectedIndex |
void setSelectedIndex (index) |
Sets the current record index of the current foundset. |
Parameters {Number} index – the index to select |
Returns void |
Sample//gets the current record index in the current foundset var current = forms.customer.controller.getSelectedIndex(); //sets the next record in the foundset, will be reflected in UI forms.customer.controller.setSelectedIndex(current+1); |
setTabSequence |
void setTabSequence (arrayOfElements) |
Set the tab order sequence programatically, by passing the elements references in a javascript array. |
Parameters {Object[]} arrayOfElements – array containing the element references |
Returns void |
Sampleforms.customer.controller.setTabSequence([forms.customer.elements.fld_order_id, forms.customer.elements.fld_order_amount]); |
show |
void show ([dialogName/windowName], [modal]) |
Shows the form (makes the form visible), optionally shown in the specified dialog (modal or not)/window. This function does not affect the form foundset in any way. |
Parameters [dialogName/windowName] – the dialog/window name [modal] – boolean indicating modality for dialogs or null if it should use a window; default value is false. |
Returns void |
Sample//show the form in the current window/dialog forms.customer.controller.show(); //show the form in the named modal dialog //forms.customer.controller.show('mydialog',true); //show the form in a named window //forms.customer.controller.show('mywindow',null); |
showPrintPreview |
void showPrintPreview ([printCurrentRecordOnly], [printerJob], [zoomFactor]) |
Show this form in print preview. |
Parameters [printCurrentRecordOnly] – to print the current record only [printerJob] – print to plugin printer job, see pdf printer plugin for example (incase print is used from printpreview) [zoomFactor] – a specified number value from 10-400 |
Returns void |
Sample//shows this form (with foundset records) in print preview forms.customer.controller.showPrintPreview(); //to print preview current record only //forms.customer.controller.showPrintPreview(true); //to print preview current record only with 125% zoom factor; //forms.customer.controller.showPrintPreview(true, null, 125); |
showRecords |
void showRecords (data, [dialogName/windowName], [modal]) |
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'. |
Parameters data – the foundset/pkdataset/singlenNmber_pk/UUIDpk to load before showing the form [dialogName/windowName] – the dialog/window name [modal] – boolean indicating modality for dialogs or null if it should use a window; default value is false |
Returns void |
Also see |
Sampleforms.customer.controller.showRecords(foundset); //show the form in the named modal dialog //forms.customer.controller.show(foundset, 'mydialog', true); //show the form in the named window //forms.customer.controller.show(foundset, 'mywindow', null); |
sort |
void sort (sortString, [defer]) |
Sorts the form foundset based on the given sort string. TIP: You can use the Copy button in the developer Select Sorting Fields dialog to get the needed syntax string for the desired sort fields/order. |
Parameters sortString – the specified columns (and sort order) [defer] – the "sortString" will be just stored, without performing a query on the database (the actual sorting will be deferred until the next data loading action). |
Returns void |
Sampleforms.customer.controller.sort('columnA desc,columnB asc'); |
sortDialog |
void sortDialog ([sortString]) |
Show the sort dialog to the user a preselection sortString can be passed, to sort the form foundset. TIP: You can use the Copy button in the developer Select Sorting Fields dialog to get the needed syntax string for the desired sort fields/order. |
Parameters [sortString] – the specified columns (and sort order) |
Returns void |
Sampleforms.customer.controller.sortDialog('columnA desc,columnB asc'); |