servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClientsWordListMobileClientservoy sSummary12%30%58%height: 30px;3Constants SummaryConstant to set the valueListType of a JSValueList.Constant to set the valueListType of a JSValueList.Constant to set/get the addEmptyValue property of a JSValueList.Constant to set/get the addEmptyValue property of a JSValueList.servoy sSummary12%30%58%height: 30px;3Property SummaryProperty that tells if an empty value must be shown next to the items in the value list.A string with the elements in the valuelist.Compact representation of the names of the server and table that are used for loading the data from the database.Gets or sets the fallback valuelist.A The global method that provides the data for the valuelistof the valuelist is called to fill in or adjust the values of the valuelist.A property special for NGClient and GlobalValuelist to only query the global valuelist when it is needed.The name of the value list.The name of the relation that is used for loading data from the database.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.The name of the database server that is used for loading the values when the value list has the type set to database/table values.voidSort options that are applied when the valuelist loads its data from the database.The name of the database table that is used for loading the values when the value list has the type set to database/table values.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.The type of the valuelist.servoy sSummary12%30%58%height: 30px;3Methods SummaryReturns an array of the dataproviders that will be used to display the valuelist value.Returns an array of the dataproviders that will be used to define the valuelist value that is saved.Returns the UUID of the value listvoidSet the display dataproviders.voidSet the display dataproviders.voidSet the display dataproviders.voidSet the display dataproviders.voidSet the return dataproviders.voidSet the return dataproviders.voidSet the return dataproviders.voidSet the return dataproviders.constantservoy sDetail2100%height:30px2Constants DetailsEMPTYCUSTOM_VALUE_ALWAYSVALUESnameEMPTY
data
as a JSDataSet.
It is called when the valuelist needs data, it has 3 modes.
real and display params both null: return the whole list
only display is specified, called by a typeahead, return a filtered list
only real value is specified, called when the list doesnt contain the real value for the give record value, this will insert this value into the existing list.
In find mode the record with be the FindRecord which is just like a normal JSRecord (DataRecord) it has the same properties (column/dataproviders) but doesnt have its methods (like isEditing())
The last argument is rawDisplayValue which contains the same text as displayValue but without converting it to lowercase
linefeeds (custom1
custom2), optional with realvalues ((custom1|1
custom2|2)).
The global method of the valuelist is called to fill in or adjust the values of the valuelist.
The method returns a dataset with one or two columns, first column is the display value, second column is real value(if present).
The valuelist will be filled in with the dataset data. If second column is not present real value and display value will be the same.
The method has to handle three different scenarios:
1. 'displayValue' parameter is not null, this parameter should be used to filter the list of values(in a typeahead fashion)
2. 'realValue' parameter is specified, that means value was not found in current list, so must be specified manually.
In this case method should return only one row in the dataset, with the missing value, that will be added to the valuelist
3. 'realValue' and 'displayValue' are both null , in this case the complete list of values should be returned.
Scenario 1 and 3 will completely replace any older results in the valuelist while scenario 2 will append results.
In find mode the record will be the FindRecord which is just like a normal JSRecord (DataRecord) it has the same properties (column/dataproviders) but doesnt have its methods (like isEditing())
The last argument is rawDisplayValue which contains the same text as displayValue but without converting it to lowercase.
ret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowlazyLoadingname
lazyLoading
dessIndent
A property special for NGClient and GlobalValuelist to only query the global valuelist when it is needed.
This flag has to be set both on valuelist and in component spec, on the valuelist property.
IMPORTANT: Usage of real & display values is not fully supported with lazy loading. Don't set lazy load if your method returns both real and display values
This is because very likely we do need directly the display value for the given real to dispaly its value..
The name of the relation that is used for loading data from the database.
ret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowseparatorname
separator
dessIndent
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.
ret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowserverNamename
serverName
dessIndent
The name of the database server that is used for loading the values when
the value list has the type set to database/table values.
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.
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.
prs
Parameters
sIndentdataprovider1The first display dataprovider.clients
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.
prs
Parameters
sIndentdataprovider1The first display dataprovider.dataprovider2The second display dataprovider.clients
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.
prs
Parameters
sIndentdataprovider1The first display dataprovider.dataprovider2The second display dataprovider.dataprovider3The third display dataprovider.clients
Set the return dataproviders. 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.
Set the return dataproviders. 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.
prs
Parameters
sIndentdataprovider1The first return dataprovider.clients
Set the return dataproviders. 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.
prs
Parameters
sIndentdataprovider1The first return dataprovider.dataprovider2The second return dataprovider.clients
Set the return dataproviders. 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.
prs
Parameters
sIndentdataprovider1The first return dataprovider.dataprovider2The second return dataprovider.dataprovider3The third return dataprovider.clients