| Constants Summery | |
|---|---|
| Number | #CUSTOM_VALUES Constant to set the valueListType of a JSValueList. |
| Number | #DATABASE_VALUES Constant to set the valueListType of a JSValueList. |
| Number | #EMPTY_VALUE_ALWAYS Constant to set/get the addEmptyValue property of a JSValueList. |
| Number | #EMPTY_VALUE_NEVER Constant to set/get the addEmptyValue property of a JSValueList. |
| Property Summery | |
|---|---|
| Number | #addEmptyValue Property that tells if an empty value must be shown next to the items in the value list. |
| String | #customValues A string with the elements in the valuelist. |
| String | #dataSource Compact representation of the names of the server and table that are used for loading the data from the database. |
| JSMethod | #globalMethod A global method that provides the data for the valuelist. |
| String | #name The name of the value list. |
| String | #relationName The name of the relation that is used for loading data from the database. |
| String | #separator A String representing the separator that should be used when multiple display dataproviders are set, when the value list has the type set to database values. |
| String | #serverName The name of the database server that is used for loading the values when the value list has the type set to database values. |
| String | #sortOptions Sort options that are applied when the valuelist loads its data from the database. |
| String | #tableName The name of the database table that is used for loading the values when the value list has the type set to database values. |
| Boolean | #useTableFilter Flag that tells if the name of the valuelist should be applied as a filter on the 'valuelist_name' column when retrieving the data from the database. |
| Number | #valueListType The type of the valuelist. |
| Method Summery | |
|---|---|
| Object[] | #getDisplayDataProviderIds() Returns an array of the dataproviders that will be used to display the valuelist value. |
| Object[] | #getReturnDataProviderIds() Returns an array of the dataproviders that will be used to define the valuelist value that is saved. |
| void | #setDisplayDataProviderIds(dataprovider1, [dataprovider2], [dataprovider3]) Set the display dataproviders. |
| void | #setReturnDataProviderIds(dataprovider1, [dataprovider2], [dataprovider3]) Set the return dataprovers. |
| Constants Details |
|---|
CUSTOM_VALUES |
| Constant to set the valueListType of a JSValueList. Sets the value list to use a custom list of values. Also used in solutionModel.newValueList(...) to create new valuelists |
| Returns Number |
Sample
var vlist = solutionModel.newValueList('options', JSValueList.DATABASE_VALUES);
vlist.valueListType = JSValueList.CUSTOM_VALUES; // Change the type to custom values.
vlist.customValues = "one\ntwo\nthree\nfour";
|
DATABASE_VALUES |
| Constant to set the valueListType of a JSValueList. Sets the value list to use values loaded from a database. Also used in solutionModel.newValueList(...) to create new valuelists |
| Returns Number |
Sample
var vlist = solutionModel.newValueList('options', JSValueList.CUSTOM_VALUES);
vlist.valueListType = JSValueList.DATABASE_VALUES; // Change the type to database values.
vlist.serverName = 'example_data';
vlist.tableName = 'parent_table';
vlist.setDisplayDataProviderIds('parent_table_text');
vlist.setReturnDataProviderIds('parent_table_text', 'parent_table_id');
vlist.separator = ' ## ';
vlist.sortOptions = 'parent_table_text desc';
|
EMPTY_VALUE_ALWAYS |
| Constant to set/get the addEmptyValue property of a JSValueList. |
| Returns Number |
Sample
var vlist = solutionModel.newValueList('options', JSValueList.CUSTOM_VALUES);
vlist.customValues = "one\ntwo\nthree\nfour";
vlist.addEmptyValue = JSValueList.EMPTY_VALUE_ALWAYS;
var cmb = form.newComboBox('my_table_text', 10, 10, 100, 20);
cmb.valuelist = vlist;
|
EMPTY_VALUE_NEVER |
| Constant to set/get the addEmptyValue property of a JSValueList. |
| Returns Number |
Sample
var vlist = solutionModel.newValueList('options', JSValueList.CUSTOM_VALUES);
vlist.customValues = "one\ntwo\nthree\nfour";
vlist.addEmptyValue = JSValueList.EMPTY_VALUE_NEVER;
var cmb = form.newComboBox('my_table_text', 10, 10, 100, 20);
cmb.valuelist = vlist;
|
| Property Details |
|---|
addEmptyValue |
| Property that tells if an empty value must be shown next to the items in the value list. |
| Returns Number |
Sample
var vlist = solutionModel.newValueList('options', JSValueList.CUSTOM_VALUES);
vlist.customValues = "one\ntwo\nthree\nfour";
vlist.addEmptyValue = JSValueList.EMPTY_VALUE_NEVER;
var cmb = form.newComboBox('my_table_text', 10, 10, 100, 20);
cmb.valuelist = vlist;
|
customValues |
| A string with the elements in the valuelist. The elements can be separated by linefeeds (custom1 custom2), optional with realvalues ((custom1|1 custom2|2)). |
| Returns String |
Sample
var vl1 = solutionModel.newValueList("customtext",JSValueList.CUSTOM_VALUES);
vl1.customValues = "customvalue1\ncustomvalue2";
var vl2 = solutionModel.newValueList("customid",JSValueList.CUSTOM_VALUES);
vl2.customValues = "customvalue1|1\ncustomvalue2|2";
var form = solutionModel.newForm("customvaluelistform",controller.getDataSource(),null,true,300,300);
var combo1 = form.newComboBox("globals.text",10,10,120,20);
combo1.valuelist = vl1;
var combo2 = form.newComboBox("globals.id",10,60,120,20);
combo2.valuelist = vl2;
|
dataSource |
| Compact representation of the names of the server and table that are used for loading the data from the database. |
| Returns String |
Sample
var vlist = solutionModel.newValueList('options', JSValueList.DATABASE_VALUES);
vlist.dataSource = 'db:/example_data/parent_table';
vlist.setDisplayDataProviderIds('parent_table_text');
vlist.setReturnDataProviderIds('parent_table_text');
|
globalMethod |
| A global method that provides the data for the valuelist. The global method must provided the data as a JSDataSet. |
| Returns JSMethod |
Sample
var listProvider = solutionModel.newGlobalMethod('function myValueListProvider(displayValue, realValue, record, valueListName) ');
var vlist = solutionModel.newValueList('vlist', JSValueList.CUSTOM_VALUES);
vlist.globalMethod = listProvider;
|
name |
The name of the value list. It is relevant when the "useTableFilter" property is set. |
| Returns String |
Sample
var vlist = solutionModel.newValueList('options', JSValueList.DATABASE_VALUES);
vlist.serverName = 'example_data';
vlist.tableName = 'valuelists';
vlist.setDisplayDataProviderIds('valuelist_data');
vlist.setReturnDataProviderIds('valuelist_data');
vlist.useTableFilter = true;
vlist.name = 'two';
|
relationName |
| The name of the relation that is used for loading data from the database. |
| Returns String |
Sample
var rel = solutionModel.newRelation('parent_to_child', 'example_data', 'parent_table', 'example_data', 'child_table', JSRelation.INNER_JOIN);
rel.newRelationItem('parent_table_id', '=', 'child_table_parent_id');
var vlist = solutionModel.newValueList('options', JSValueList.DATABASE_VALUES);
vlist.serverName = 'example_data';
vlist.tableName = 'parent_table';
vlist.relationName = 'parent_to_child';
vlist.setDisplayDataProviderIds('child_table_text');
vlist.setReturnDataProviderIds('child_table_text');
|
separator |
| A String representing the separator that should be used when multiple display dataproviders are set, when the value list has the type set to database values. |
| Returns String |
Sample
var vlist = solutionModel.newValueList('options', JSValueList.CUSTOM_VALUES);
vlist.valueListType = JSValueList.DATABASE_VALUES; // Change the type to database values.
vlist.serverName = 'example_data';
vlist.tableName = 'parent_table';
vlist.setDisplayDataProviderIds('parent_table_text');
vlist.setReturnDataProviderIds('parent_table_text', 'parent_table_id');
vlist.separator = ' ## ';
vlist.sortOptions = 'parent_table_text desc';
|
serverName |
| The name of the database server that is used for loading the values when the value list has the type set to database values. |
| Returns String |
Sample
var vlist = solutionModel.newValueList('options', JSValueList.CUSTOM_VALUES);
vlist.valueListType = JSValueList.DATABASE_VALUES; // Change the type to database values.
vlist.serverName = 'example_data';
vlist.tableName = 'parent_table';
vlist.setDisplayDataProviderIds('parent_table_text');
vlist.setReturnDataProviderIds('parent_table_text', 'parent_table_id');
vlist.separator = ' ## ';
vlist.sortOptions = 'parent_table_text desc';
|
sortOptions |
| Sort options that are applied when the valuelist loads its data from the database. |
| Returns String |
Sample
var vlist = solutionModel.newValueList('options', JSValueList.CUSTOM_VALUES);
vlist.valueListType = JSValueList.DATABASE_VALUES; // Change the type to database values.
vlist.serverName = 'example_data';
vlist.tableName = 'parent_table';
vlist.setDisplayDataProviderIds('parent_table_text');
vlist.setReturnDataProviderIds('parent_table_text', 'parent_table_id');
vlist.separator = ' ## ';
vlist.sortOptions = 'parent_table_text desc';
|
tableName |
| The name of the database table that is used for loading the values when the value list has the type set to database values. |
| Returns String |
Sample
var vlist = solutionModel.newValueList('options', JSValueList.CUSTOM_VALUES);
vlist.valueListType = JSValueList.DATABASE_VALUES; // Change the type to database values.
vlist.serverName = 'example_data';
vlist.tableName = 'parent_table';
vlist.setDisplayDataProviderIds('parent_table_text');
vlist.setReturnDataProviderIds('parent_table_text', 'parent_table_id');
vlist.separator = ' ## ';
vlist.sortOptions = 'parent_table_text desc';
|
useTableFilter |
| Flag that tells if the name of the valuelist should be applied as a filter on the 'valuelist_name' column when retrieving the data from the database. |
| Returns Boolean |
Sample
var vlist = solutionModel.newValueList('options', JSValueList.DATABASE_VALUES);
vlist.serverName = 'example_data';
vlist.tableName = 'valuelists';
vlist.setDisplayDataProviderIds('valuelist_data');
vlist.setReturnDataProviderIds('valuelist_data');
vlist.useTableFilter = true;
vlist.name = 'two';
|
valueListType |
| The type of the valuelist. Can be either custom values or database values. |
| Returns Number |
Sample
var vlist = solutionModel.newValueList('options', JSValueList.CUSTOM_VALUES);
vlist.valueListType = JSValueList.DATABASE_VALUES; // Change the type to database values.
vlist.serverName = 'example_data';
vlist.tableName = 'parent_table';
vlist.setDisplayDataProviderIds('parent_table_text');
vlist.setReturnDataProviderIds('parent_table_text', 'parent_table_id');
vlist.separator = ' ## ';
vlist.sortOptions = 'parent_table_text desc';
|
| Method Details |
|---|
getDisplayDataProviderIds |
Object[] getDisplayDataProviderIds () |
| Returns an array of the dataproviders that will be used to display the valuelist value. |
| Returns Object[] – An array of Strings representing the names of the display dataproviders. |
Sample
var vlist = solutionModel.newValueList('options', JSValueList.DATABASE_VALUES);
vlist.dataSource = 'db:/example_data/parent_table';
vlist.setDisplayDataProviderIds('parent_table_text', 'parent_table_id');
vlist.setReturnDataProviderIds('parent_table_text');
var dispDP = vlist.getDisplayDataProviderIds();
for (var i=0; i<dispDP.length; i++)
application.output(dispDP[i]);
var retDP = vlist.getReturnDataProviderIds();
for (var i=0; i<retDP.length; i++)
application.output(retDP[i]);
|
getReturnDataProviderIds |
Object[] getReturnDataProviderIds () |
| Returns an array of the dataproviders that will be used to define the valuelist value that is saved. |
| Returns Object[] – An array of Strings representing the names of the return dataprovider. |
Sample
var vlist = solutionModel.newValueList('options', JSValueList.DATABASE_VALUES);
vlist.dataSource = 'db:/example_data/parent_table';
vlist.setDisplayDataProviderIds('parent_table_text', 'parent_table_id');
vlist.setReturnDataProviderIds('parent_table_text');
var dispDP = vlist.getDisplayDataProviderIds();
for (var i=0; i<dispDP.length; i++)
application.output(dispDP[i]);
var retDP = vlist.getReturnDataProviderIds();
for (var i=0; i<retDP.length; i++)
application.output(retDP[i]);
|
setDisplayDataProviderIds |
void setDisplayDataProviderIds (dataprovider1, [dataprovider2], [dataprovider3]) |
| Set the display dataproviders. There can be at most 3 of them, combined with the return dataproviders. The values taken from these dataproviders, in order, separated by the separator, will be displayed by the valuelist. |
| Parameters dataprovider1 – The first display dataprovider. [dataprovider2] – The second display dataprovider. [dataprovider3] – The third display dataprovider. |
| Returns void |
Sample
var vlist = solutionModel.newValueList('options', JSValueList.CUSTOM_VALUES);
vlist.valueListType = JSValueList.DATABASE_VALUES; // Change the type to database values.
vlist.serverName = 'example_data';
vlist.tableName = 'parent_table';
vlist.setDisplayDataProviderIds('parent_table_text');
vlist.setReturnDataProviderIds('parent_table_text', 'parent_table_id');
vlist.separator = ' ## ';
vlist.sortOptions = 'parent_table_text desc';
|
setReturnDataProviderIds |
void setReturnDataProviderIds (dataprovider1, [dataprovider2], [dataprovider3]) |
| Set the return dataprovers. There can be at most 3 of them, combined with the display dataproviders. The values taken from these dataproviders, in order, separated by the separator, will be returned by the valuelist. |
| Parameters dataprovider1 – The first return dataprovider. [dataprovider2] – The second return dataprovider. [dataprovider3] – The third return dataprovider. |
| Returns void |
Sample
var vlist = solutionModel.newValueList('options', JSValueList.CUSTOM_VALUES);
vlist.valueListType = JSValueList.DATABASE_VALUES; // Change the type to database values.
vlist.serverName = 'example_data';
vlist.tableName = 'parent_table';
vlist.setDisplayDataProviderIds('parent_table_text');
vlist.setReturnDataProviderIds('parent_table_text', 'parent_table_id');
vlist.separator = ' ## ';
vlist.sortOptions = 'parent_table_text desc';
|
Overview
Content Tools
Activity