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
CUSTOM_VALUES
Constant to set the valueListType of a JSValueList.
DATABASE_VALUES
Constant to set the valueListType of a JSValueList.
EMPTY_VALUE_ALWAYS
Constant to set/get the addEmptyValue property of a JSValueList.
EMPTY_VALUE_NEVER
Constant to set/get the addEmptyValue property of a JSValueList.
{column:width=80px|padding=0px}{column}{column}{column}
Property Summary
addEmptyValue
Property that tells if an empty value must be shown next to the items in the value list.
customValues
A string with the elements in the valuelist.
dataSource
Compact representation of the names of the server and table that
are used for loading the data from the database.
globalMethod
A global method that provides the data for the valuelist.
relationName
The name of the relation that is used for loading data from the database.
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.
sortOptions
Sort options that are applied when the valuelist loads its data
from the database.
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.
valueListType
The type of the valuelist.
{column:width=80px|padding=0px}{column}{column}{column}
Method Summary
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()
Set the display dataproviders.
void
setDisplayDataProviderIds(dataprovider1)
Set the display dataproviders.
void
setDisplayDataProviderIds(dataprovider1, dataprovider2)
Set the display dataproviders.
void
setDisplayDataProviderIds(dataprovider1, dataprovider2, dataprovider3)
Set the display dataproviders.
void
setReturnDataProviderIds()
Set the return dataproviders.
void
setReturnDataProviderIds(dataprovider1)
Set the return dataproviders.
void
setReturnDataProviderIds(dataprovider1, dataprovider2)
Set the return dataproviders.
void
setReturnDataProviderIds(dataprovider1, dataprovider2, dataprovider3)
Set the return dataproviders.
{column:width=100%|padding=0px}{column}
Constants Details
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";
Sample
var vlist = solutionModel.newValueList('options', JSValueList.CUSTOM_VALUES); vlist.valueListType = JSValueList.DATABASE_VALUES; // Change the type to database values. vlist.dataSource = 'db:/example_data/parent_table'; vlist.setDisplayDataProviderIds('parent_table_text'); vlist.setReturnDataProviderIds('parent_table_text', 'parent_table_id'); vlist.separator = ' ## '; vlist.sortOptions = 'parent_table_text desc';
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;
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;
{column:width=100%|padding=0px}{column}
Property Details
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;
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("scopes.globals.text",10,10,120,20); combo1.valuelist = vl1; var combo2 = form.newComboBox("scopes.globals.id",10,60,120,20); combo2.valuelist = vl2;
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');
Sample
var listProvider = solutionModel.newGlobalMethod('globals', 'function getDataSetForValueList(displayValue, realValue, record, valueListName, findMode) {' + ' ' + 'var args = null;' + '/** @type QBSelect<db:/example_data/employees> */' + 'var query = databaseManager.createSelect('db:/example_data/employees');' + '/** @type {JSDataSet} */' + 'var result = null;' + 'if (displayValue == null && realValue == null) {' + ' // TODO think about caching this result. can be called often!' + ' // return the complete list' + ' query.result.add(query.columns.firstname.concat(' ').concat(query.columns.lastname)).add(query.columns.employeeid);' + ' result = databaseManager.getDataSetByQuery(query,100);' + '} else if (displayValue != null) {' + ' // TYPE_AHEAD filter call, return a filtered list' + ' args = [displayValue + "%", displayValue + "%"]' + ' query.result.add(query.columns.firstname.concat(' ').concat(query.columns.lastname)).add(query.columns.employeeid).' + ' root.where.add(query.or.add(query.columns.firstname.lower.like(args[0] + '%')).add(query.columns.lastname.lower.like(args[1] + '%')));' + ' result = databaseManager.getDataSetByQuery(query,100);' + '} else if (realValue != null) {' + ' // TODO think about caching this result. can be called often!' + ' // real object not found in the current list, return 1 row with display,realvalue that will be added to the current list' + ' // dont return a complete list in this mode because that will be added to the list that is already there' + ' args = [realValue];' + ' query.result.add(query.columns.firstname.concat(' ').concat(query.columns.lastname)).add(query.columns.employeeid).' + ' root.where.add(query.columns.employeeid.eq(args[0]));' + ' result = databaseManager.getDataSetByQuery(query,1);' + '}' + 'return result;' + '}'); var vlist = solutionModel.newValueList('vlist', JSValueList.CUSTOM_VALUES); vlist.globalMethod = listProvider;
Sample
var vlist = solutionModel.newValueList('options', JSValueList.DATABASE_VALUES); vlist.dataSource = 'db:/example_data/valuelists'; vlist.setDisplayDataProviderIds('valuelist_data'); vlist.setReturnDataProviderIds('valuelist_data'); vlist.useTableFilter = true; vlist.name = 'two';
Sample
var rel = solutionModel.newRelation('parent_to_child', 'db:/example_data/parent_table', 'db:/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.dataSource = 'db:/example_data/parent_table'; vlist.relationName = 'parent_to_child'; vlist.setDisplayDataProviderIds('child_table_text'); vlist.setReturnDataProviderIds('child_table_text');
Sample
var vlist = solutionModel.newValueList('options', JSValueList.CUSTOM_VALUES); vlist.valueListType = JSValueList.DATABASE_VALUES; // Change the type to database values. vlist.dataSource = 'db:/example_data/parent_table'; vlist.setDisplayDataProviderIds('parent_table_text'); vlist.setReturnDataProviderIds('parent_table_text', 'parent_table_id'); vlist.separator = ' ## '; vlist.sortOptions = 'parent_table_text desc';
Sample
var vlist = solutionModel.newValueList('options', JSValueList.CUSTOM_VALUES); vlist.valueListType = JSValueList.DATABASE_VALUES; // Change the type to database values. vlist.dataSource = 'db:/example_data/parent_table'; vlist.setDisplayDataProviderIds('parent_table_text'); vlist.setReturnDataProviderIds('parent_table_text', 'parent_table_id'); vlist.separator = ' ## '; vlist.sortOptions = 'parent_table_text desc';
Sample
var vlist = solutionModel.newValueList('options', JSValueList.CUSTOM_VALUES); vlist.valueListType = JSValueList.DATABASE_VALUES; // Change the type to database values. vlist.dataSource = 'db:/example_data/parent_table'; vlist.setDisplayDataProviderIds('parent_table_text'); vlist.setReturnDataProviderIds('parent_table_text', 'parent_table_id'); vlist.separator = ' ## '; vlist.sortOptions = 'parent_table_text desc';
Sample
var vlist = solutionModel.newValueList('options', JSValueList.CUSTOM_VALUES); vlist.valueListType = JSValueList.DATABASE_VALUES; // Change the type to database values. vlist.dataSource = 'db:/example_data/parent_table'; vlist.setDisplayDataProviderIds('parent_table_text'); vlist.setReturnDataProviderIds('parent_table_text', 'parent_table_id'); vlist.separator = ' ## '; vlist.sortOptions = 'parent_table_text desc';
Sample
var vlist = solutionModel.newValueList('options', JSValueList.DATABASE_VALUES); vlist.dataSource = 'db:/example_data/valuelists'; vlist.setDisplayDataProviderIds('valuelist_data'); vlist.setReturnDataProviderIds('valuelist_data'); vlist.useTableFilter = true; vlist.name = 'two';
Sample
var vlist = solutionModel.newValueList('options', JSValueList.CUSTOM_VALUES); vlist.valueListType = JSValueList.DATABASE_VALUES; // Change the type to database values. vlist.dataSource = 'db:/example_data/parent_table'; vlist.setDisplayDataProviderIds('parent_table_text'); vlist.setReturnDataProviderIds('parent_table_text', 'parent_table_id'); vlist.separator = ' ## '; vlist.sortOptions = 'parent_table_text desc';
{column:width=100%|padding=0px}{column}
Method Details
Object[]
getDisplayDataProviderIds
()
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]);
Object[]
getReturnDataProviderIds
()
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]);
Sample
var vlist = solutionModel.newValueList('options', JSValueList.CUSTOM_VALUES); application.output(vlist.getUUID().toString());
void
setDisplayDataProviderIds
()
Returns
void
Sample
var vlist = solutionModel.newValueList('options', JSValueList.CUSTOM_VALUES); vlist.valueListType = JSValueList.DATABASE_VALUES; // Change the type to database values. vlist.dataSource = 'db:/example_data/parent_table'; vlist.setDisplayDataProviderIds('parent_table_text'); vlist.setReturnDataProviderIds('parent_table_text', 'parent_table_id'); vlist.separator = ' ## '; vlist.sortOptions = 'parent_table_text desc';
void
setDisplayDataProviderIds
(dataprovider1)
Parameters
{String} dataprovider1 – The first 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.dataSource = 'db:/example_data/parent_table'; vlist.setDisplayDataProviderIds('parent_table_text'); vlist.setReturnDataProviderIds('parent_table_text', 'parent_table_id'); vlist.separator = ' ## '; vlist.sortOptions = 'parent_table_text desc';
void
setDisplayDataProviderIds
(dataprovider1, dataprovider2)
Returns
void
Sample
var vlist = solutionModel.newValueList('options', JSValueList.CUSTOM_VALUES); vlist.valueListType = JSValueList.DATABASE_VALUES; // Change the type to database values. vlist.dataSource = 'db:/example_data/parent_table'; vlist.setDisplayDataProviderIds('parent_table_text'); vlist.setReturnDataProviderIds('parent_table_text', 'parent_table_id'); vlist.separator = ' ## '; vlist.sortOptions = 'parent_table_text desc';
void
setDisplayDataProviderIds
(dataprovider1, dataprovider2, dataprovider3)
Returns
void
Sample
var vlist = solutionModel.newValueList('options', JSValueList.CUSTOM_VALUES); vlist.valueListType = JSValueList.DATABASE_VALUES; // Change the type to database values. vlist.dataSource = 'db:/example_data/parent_table'; vlist.setDisplayDataProviderIds('parent_table_text'); vlist.setReturnDataProviderIds('parent_table_text', 'parent_table_id'); vlist.separator = ' ## '; vlist.sortOptions = 'parent_table_text desc';
void
setReturnDataProviderIds
()
Returns
void
Sample
var vlist = solutionModel.newValueList('options', JSValueList.CUSTOM_VALUES); vlist.valueListType = JSValueList.DATABASE_VALUES; // Change the type to database values. vlist.dataSource = 'db:/example_data/parent_table'; vlist.setDisplayDataProviderIds('parent_table_text'); vlist.setReturnDataProviderIds('parent_table_text', 'parent_table_id'); vlist.separator = ' ## '; vlist.sortOptions = 'parent_table_text desc';
void
setReturnDataProviderIds
(dataprovider1)
Parameters
{String} dataprovider1 – The first 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.dataSource = 'db:/example_data/parent_table'; vlist.setDisplayDataProviderIds('parent_table_text'); vlist.setReturnDataProviderIds('parent_table_text', 'parent_table_id'); vlist.separator = ' ## '; vlist.sortOptions = 'parent_table_text desc';
void
setReturnDataProviderIds
(dataprovider1, dataprovider2)
Returns
void
Sample
var vlist = solutionModel.newValueList('options', JSValueList.CUSTOM_VALUES); vlist.valueListType = JSValueList.DATABASE_VALUES; // Change the type to database values. vlist.dataSource = 'db:/example_data/parent_table'; vlist.setDisplayDataProviderIds('parent_table_text'); vlist.setReturnDataProviderIds('parent_table_text', 'parent_table_id'); vlist.separator = ' ## '; vlist.sortOptions = 'parent_table_text desc';
void
setReturnDataProviderIds
(dataprovider1, dataprovider2, dataprovider3)
Returns
void
Sample
var vlist = solutionModel.newValueList('options', JSValueList.CUSTOM_VALUES); vlist.valueListType = JSValueList.DATABASE_VALUES; // Change the type to database values. vlist.dataSource = 'db:/example_data/parent_table'; vlist.setDisplayDataProviderIds('parent_table_text'); vlist.setReturnDataProviderIds('parent_table_text', 'parent_table_id'); vlist.separator = ' ## '; vlist.sortOptions = 'parent_table_text desc';