controller

Boolean

enabled
Gets or sets the enabled state of a form; also known as "grayed-out".

Boolean

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.

Number

view
Get/Set the current type of view of this form.

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()
Duplicate current record or record at index in the form foundset.

Boolean

duplicateRecord(location)
Duplicate current record or record at index in the form foundset.

Boolean

duplicateRecord(location)
Duplicate current record or record at index in the form foundset.

Boolean

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.

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.

Object

getDesignTimeProperty()
Get a design-time property of a form.

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.

JSWindow

getWindow()
Returns the JSWindow that the form is shown in, or null if the form is not currently showing in a window.

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()
Loads all accessible records from the datasource into the form foundset.

Boolean

loadRecords(foundset)
Loads a (related) foundset into the form.

Boolean

loadRecords(pkdataset)
Loads a primary key dataset, will remove related sort.

Boolean

loadRecords(UUIDpk)
Loads a single record by primary key, will remove related sort.

Boolean

loadRecords(singlenNmber_pk)
Loads a single record by primary key, will remove related sort.

Boolean

loadRecords(queryString)
Loads records into form foundset based on a query (also known as 'Form by query').

Boolean

loadRecords(queryString, queryArgumentsArray)
Loads records into form foundset based on a query (also known as 'Form by query').

Boolean

newRecord()
Create a new record in the form foundset.

Boolean

newRecord(insertOnTop)
Create a new record in the form foundset.

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()
Print this form with current foundset, without preview.

void

print(printCurrentRecordOnly)
Print this form with current foundset, without preview.

void

print(printCurrentRecordOnly, showPrinterSelectDialog)
Print this form with current foundset, without preview.

void

print(printCurrentRecordOnly, showPrinterSelectDialog, printerJob)
Print this form with current foundset, without preview.

String

printXML()
Print this form with current foundset records to xml format.

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()

Number

search(clearLastResults)
Start the database search and use the results, returns the number of records, make sure you did "find" function first.

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(designMode)
Sets this form in designmode with param true, false will return to normal browse/edit mode.

void

setDesignMode(ondrag)
Sets this form in designmode with one or more callback methods.

void

setDesignMode(ondrag, ondrop)
Sets this form in designmode with one or more callback methods.

void

setDesignMode(ondrag, ondrop, onselect)
Sets this form in designmode with one or more callback methods.

void

setDesignMode(ondrag, ondrop, onselect, onresize)
Sets this form in designmode with one or more callback methods.

void

setDesignMode(ondrag, ondrop, onselect, onresize, ondblclick)
Sets this form in designmode with one or more callback methods.

void

setDesignMode(ondrag, ondrop, onselect, onresize, ondblclick, onrightclick)
Sets this form in designmode with one or more callback methods.

void

setPageFormat(width, height, leftmargin, rightmargin, topmargin, bottommargin)
Set the page format to use when printing.

void

setPageFormat(width, height, leftmargin, rightmargin, topmargin, bottommargin, orientation)
Set the page format to use when printing.

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()
Shows the form (makes the form visible)
This function does not affect the form foundset in any way.

void

show(window)
Shows the form (makes the form visible)
This function does not affect the form foundset in any way.

void

show(window)
Shows the form (makes the form visible)
This function does not affect the form foundset in any way.

void

showPrintPreview()
Show this form in print preview.

void

showPrintPreview(printCurrentRecordOnly)
Show this form in print preview.

void

showPrintPreview(printCurrentRecordOnly, printerJob)
Show this form in print preview.

void

showPrintPreview(printCurrentRecordOnly, printerJob, zoomFactor)
Show this form in print preview.

void

showRecords(foundset)
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.

void

showRecords(foundset, window)
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.

void

showRecords(foundset, window)
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.

void

showRecords(pkdataset)
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.

void

showRecords(pkdataset, window)
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.

void

showRecords(pkdataset, window)
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.

void

showRecords(query)
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.

void

showRecords(query, window)
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.

void

showRecords(query, window)
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.

void

showRecords(UUIDpk)
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.

void

showRecords(UUIDpk, window)
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.

void

showRecords(UUIDpk, window)
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.

void

showRecords(singleNumber_pk)
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.

void

showRecords(singleNumber_pk, window)
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.

void

showRecords(singleNumber_pk, window)
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.

void

showRecords(query)
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.

void

showRecords(query, window)
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.

void

showRecords(query, argumentsArray)
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.

void

showRecords(query, argumentsArray, window)
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.

void

showRecords(query, argumentsArray, window)
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.

void

showRecords(query, window)
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.

void

sort(sortString)
Sorts the form foundset based on the given sort string.

void

sort(sortString, defer)
Sorts the form foundset based on the given sort string.

void

sortDialog()
Show the sort dialog to the user a preselection sortString can be passed, to sort the form foundset.

void

sortDialog(sortString)

enabled

Returns

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

Returns

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

Returns

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

deleteAllRecords

Returns

Sample

var success = forms.customer.controller.deleteAllRecords();

deleteRecord

Returns

Sample

var success = forms.customer.controller.deleteRecord();

duplicateRecord

Returns

Sample

forms.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

duplicateRecord

Parameters

Returns

Sample

forms.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

duplicateRecord

Parameters

Returns

Sample

forms.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

Returns

Sample

if (forms.customer.controller.find()) //find will fail if autosave is disabled and there are unsaved records
{
	columnTextDataProvider = 'a search value'
	columnNumberDataProvider = '>10'
	columnDateDataProvider = '31-12-2010|dd-MM-yyyy'
	forms.customer.controller.search()
}

focusField

Parameters

Returns

Sample

var 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

Returns

Sample

forms.customer.controller.focusFirstField();

getDataProviderMaxLength

Parameters

Returns

Sample

forms.customer.controller.getDataProviderMaxLength('name');

getDataProviderValue

Parameters

Returns

Sample

var val = forms.customer.controller.getDataProviderValue('contact_name');

getDataSource

Returns

Sample

var dataSource = forms.customer.controller.getDataSource();

getDesignMode

Returns

Sample

var success = forms.customer.controller.getDesignMode();

getDesignTimeProperty

Returns

Sample

var prop = forms.orders.controller.getDesignTimeProperty('myprop')

getFormContext

Returns

Sample

//dataset columns: [containername(1),formname(2),tabpanel or beanname(3),tabname(4),tabindex(5),tabindex1based(6)]
//dataset rows: mainform(1) -> parent(2)  -> current form(3) (when 3 forms deep)
/** @type {JSDataSet} */
var dataset = forms.customer.controller.getFormContext();
if (dataset.getMaxRowIndex() > 1) 
{
	// form is in a tabpanel
	var parentFormName = dataset.getValue(1,2)
}

getFormWidth

Returns

Sample

var width = forms.customer.controller.getFormWidth();

getMaxRecordIndex

Returns

Sample

for ( var i = 1 ; i <= forms.customer.controller.getMaxRecordIndex() ; i++ )
{
	forms.customer.controller.setSelectedIndex(i);
	//do some action per record
}

getName

Returns

Sample

var formName = forms.customer.controller.getName();

getPartHeight

Parameters

Returns

Sample

var height = forms.customer.controller.getPartHeight(JSPart.BODY);

getPartYOffset

Parameters

Returns

Sample

var offset = forms.customer.controller.getPartYOffset(JSPart.BODY);

getSelectedIndex

Returns

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

Returns

Sample

var 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);
}

getWindow

Returns

Sample

var currentWindow = controller.getWindow();
if (currentWindow != null) {
	currentWindow.title = 'We have a new title';
} else {
	currentWindow = application.createWindow("Window Name", JSWindow.WINDOW, null);
	currentWindow(650, 700, 450, 350);
	currentWindow = "Window Title";
	controller.show(currentWindow);
}

invertRecords

Returns

Sample

forms.customer.controller.invertRecords();

loadAllRecords

Returns

Sample

forms.customer.controller.loadAllRecords();

loadOmittedRecords

Returns

Sample

forms.customer.controller.loadOmittedRecords();

loadRecords

Returns

Sample

//to reload all last (related) records again, if for example after a search in related tabpanel
forms.customer.controller.loadRecords();

loadRecords

Parameters

Returns

Sample

//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);

loadRecords

Parameters

Returns

Sample

//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);

loadRecords

Parameters

Returns

Sample

forms.customer.controller.loadRecords(application.getUUID('6b5e2f5d-047e-45b3-80ee-3a32267b1f20'));

loadRecords

Parameters

Returns

Sample

forms.customer.controller.loadRecords(123);

loadRecords

Parameters

Returns

Sample

forms.customer.controller.loadRecords(sqlstring);

loadRecords

Parameters

Returns

Sample

forms.customer.controller.loadRecords(sqlstring,parameters);

newRecord

Returns

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

newRecord

Parameters

Returns

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

newRecord

Parameters

Returns

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

Returns

Sample

var success = forms.customer.controller.omitRecord();

print

Returns

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'));

print

Parameters

Returns

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'));

print

Parameters

Returns

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'));

print

Parameters

Returns

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

Returns

Sample

//TIP: see also plugins.file.writeXMLFile(...)
var xml = forms.customer.controller.printXML();
//print only current record 
//var xml = forms.customer.controller.printXML(true);

printXML

Parameters

Returns

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

Returns

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

Returns

Sample

forms.customer.controller.relookup();

search

Returns

Sample

var recordCount = forms.customer.controller.search();
//var recordCount = forms.customer.controller.search(false,false); //to extend foundset

search

Parameters

Returns

Sample

var recordCount = forms.customer.foundset.search();
//var recordCount = forms.customer.foundset.search(false,false); //to extend foundset

search

Parameters

Returns

Sample

var recordCount = forms.customer.foundset.search();
//var recordCount = forms.customer.foundset.search(false,false); //to extend foundset

setDataProviderValue

Parameters

Returns

Sample

forms.customer.controller.setDataProviderValue('contact_name','mycompany');

setDesignMode

Parameters

Returns

Sample

var form = forms["selectedFormName"];
if (!form.controller.getDesignMode())
{
	// Set the current form in designmode with no callbacks
	form.controller.setDesignMode(true);
	// Set the current form in designmode with callbacks
	// where onDrag, onDrop, onSelect, onResize are names of form methods (not from "selectedFormName" form)
	// form.controller.setDesignMode(onDrag, onDrop, onSelect, onResize);
}
//Set the current form out of designmode (to normal browse)
//form.controller.setDesignMode(false);

setDesignMode

Parameters

Returns

Sample

var form = forms["selectedFormName"];
if (!form.controller.getDesignMode())
{
	// Set the current form in designmode with no callbacks
	form.controller.setDesignMode(true);
	// Set the current form in designmode with callbacks
	// where onDrag, onDrop, onSelect, onResize are names of form methods (not from "selectedFormName" form)
	// form.controller.setDesignMode(onDrag, onDrop, onSelect, onResize);
}
//Set the current form out of designmode (to normal browse)
//form.controller.setDesignMode(false);

setDesignMode

Parameters

Returns