public interface PickList
SelectItem
 and ComboBoxItem classes.| Modifier and Type | Method and Description | 
|---|---|
| ListGridRecord[] | filterClientPickListData()Returns the data to display in the pick list. | 
| java.lang.Boolean | getAnimatePickList()If true, when the pickList is shown, it will be shown via an animated reveal effect | 
| int | getAnimationTime()If this.animatePickList is true - this specifies the duration of the animation effect applied when showing the
 pickList | 
| ListGridRecord[] | getClientPickListData()Returns the set of data to be displayed in this item's PickList. | 
| java.lang.String | getDisplayField()Specifies an alternative field from which display values should be retrieved for this item. If this item is not databound ( optionDataSourceis
 unset), or bound  to the same dataSource as the form as a whole, this is implemented by picking up the value of
 the specified field from the Form's values object.Otherwise this item will attempt to map its underlying value to a display value by retrieving a record from the optionDataSourcewhere thevalueFieldmatches this item's value, and displaying thedisplayFieldvalue from that record.This essentially enables the specified optionDataSourceto be used as a server basedValueMap. | 
| java.lang.String | getDisplayFieldName()Returns the  displayFieldfor this form
 item. | 
| int | getEmptyPickListHeight()Height for an empty pick list (showing the empty message), if the pick list has no records and  hideEmptyPickListisfalse. | 
| java.lang.String | getEmptyPickListMessage()Empty message to display in the pickList if   hideEmptyPickListisfalse. | 
| java.lang.Integer | getFetchDelay()For a ComboBox or other pickList that accepts user-entered criteria, how many millseconds to wait after the last user
 keystroke before fetching data from the server. | 
| java.lang.Boolean | getFilterLocally()If  filterLocallyis set for this item, and this item is showing options  from a dataSource, fetch
 the entire set of options from the server, and use these values to map the item value to the appropriate display
 value. | 
| java.lang.Boolean | getHideEmptyPickList()If this pickList contains no options, should it be hidden? If unset, default behavior is to allow the empty
 pickList to show if it is databound. | 
| DataSource | getOptionDataSource() | 
| java.lang.String | getPickListBaseStyle()Base Style for pickList cells. | 
| int | getPickListCellHeight()Cell Height for this item's pickList. | 
| Criteria | getPickListCriteria()If this item has a databound pick-list (for example  optionDataSourceis set) this property can be used to provide static filter criteria when retrieving the data
 for the pickList. | 
| int | getPickListHeaderHeight()If this pick list is showing multiple fields, this property determines the height of the column headers for those
 fields. | 
| int | getPickListHeight()Maximum height to show the pick list before it starts to scroll. | 
| java.lang.Integer | getPickListMaxWidth()Maximum width for this item's pickList. | 
| java.lang.Integer | getPickListWidth()Default width to show the pickList. | 
| java.lang.Boolean | getShowAllOptions()If true, even non-matching options will be shown, with configurable   separatorRowsin between. | 
| java.lang.Boolean | getShowOptionsFromDataSource()If this item is part of a databound form, and has a specified  valueMapby default we show the
 valueMap options in the pickList for the item. | 
| TextMatchStyle | getTextMatchStyle()When applying filter criteria to pickList data, what type of matching to use. | 
| java.lang.String | getValueField()If this form item maps data values to display values by retrieving the   displayFieldvalues from anoptionDataSource, this property  denotes
 the the field to use as the underlying data value in records from the  optionDataSource.If unset, assumed to be the nameof this form item. | 
| java.lang.String | getValueFieldName()Getter method to retrieve the  valueFieldfor this item. | 
| java.lang.String | getValueIconField()For Databound formItems, this property determines which column   valueIconsshould show up in for this formItem's pickList.If unset valueIcons show up in the displayFieldcolumn if specified,  otherwise
 thevalueFieldcolumn.In most cases only the displayFieldorvalueFieldwill be visible. | 
| void | setAnimatePickList(java.lang.Boolean animatePickList)If true, when the pickList is shown, it will be shown via an animated reveal effect | 
| void | setAnimationTime(int animationTime)If this.animatePickList is true - this specifies the duration of the animation effect applied when showing the
 pickList | 
| PickList | setDisplayField(java.lang.String displayField)Specifies an alternative field from which display values should be retrieved for this item. If this item is not databound ( optionDataSourceis
 unset), or bound  to the same dataSource as the form as a whole, this is implemented by picking up the value of
 the specified field from the Form's values object.Otherwise this item will attempt to map its underlying value to a display value by retrieving a record from the optionDataSourcewhere thevalueFieldmatches this item's value, and displaying thedisplayFieldvalue from that record.This essentially enables the specified optionDataSourceto be used as a server basedValueMap. | 
| void | setEmptyPickListHeight(int emptyPickListHeight)Height for an empty pick list (showing the empty message), if the pick list has no records and  hideEmptyPickListisfalse. | 
| PickList | setEmptyPickListMessage(java.lang.String emptyPickListMessage)Empty message to display in the pickList if   hideEmptyPickListisfalse. | 
| void | setFetchDelay(java.lang.Integer fetchDelay)For a ComboBox or other pickList that accepts user-entered criteria, how many millseconds to wait after the last user
 keystroke before fetching data from the server. | 
| PickList | setFilterLocally(java.lang.Boolean filterLocally)If  filterLocallyis set for this item, and this item is showing options  from a dataSource, fetch
 the entire set of options from the server, and use these values to map the item value to the appropriate display
 value. | 
| void | setHideEmptyPickList(java.lang.Boolean hideEmptyPickList)If this pickList contains no options, should it be hidden? If unset, default behavior is to allow the empty
 pickList to show if it is databound. | 
| PickList | setOptionDataSource(DataSource dataSource) | 
| void | setOptionFilterContext(DSRequest dsRequestProperties)If this item has a specified  optionDataSource, and this property is
 not null, this will be passed to the datasource asRPCRequestproperties when
 performing the fetch operation on the dataSource to obtain a data-value to display-value
 mapping | 
| void | setPickListBaseStyle(java.lang.String pickListBaseStyle)Base Style for pickList cells. | 
| void | setPickListCellHeight(int pickListCellHeight)Cell Height for this item's pickList. | 
| PickList | setPickListCriteria(Criteria pickListCriteria)If this item has a databound pick-list (for example  optionDataSourceis set) this property can be used to provide static filter criteria when retrieving the data
 for the pickList. | 
| void | setPickListFilterCriteriaFunction(FilterCriteriaFunction filterCriteriaFunction)Set the pick list filter criteria function / handler. | 
| void | setPickListHeaderHeight(int pickListHeaderHeight)If this pick list is showing multiple fields, this property determines the height of the column headers for those
 fields. | 
| void | setPickListHeight(int pickListHeight)Maximum height to show the pick list before it starts to scroll. | 
| void | setPickListMaxWidth(java.lang.Integer pickListMaxWidth)Maximum width for this item's pickList. | 
| void | setPickListWidth(java.lang.Integer pickListWidth)Default width to show the pickList. | 
| PickList | setSeparatorRows(ListGridRecord[] separatorRows)Array of records to show between matching and non-matching rows in the PickList. | 
| PickList | setShowAllOptions(java.lang.Boolean showAllOptions)If true, even non-matching options will be shown, with configurable   separatorRowsin between. | 
| PickList | setShowOptionsFromDataSource(java.lang.Boolean showOptionsFromDataSource)If this item is part of a databound form, and has a specified  valueMapby default we show the
 valueMap options in the pickList for the item. | 
| PickList | setTextMatchStyle(TextMatchStyle textMatchStyle)When applying filter criteria to pickList data, what type of matching to use. | 
| PickList | setValueField(java.lang.String valueField)If this form item maps data values to display values by retrieving the   displayFieldvalues from anoptionDataSource, this property  denotes
 the the field to use as the underlying data value in records from the  optionDataSource.If unset, assumed to be the nameof this form item. | 
| void | setValueIconField(java.lang.String valueIconField)For Databound formItems, this property determines which column   valueIconsshould show up in for this formItem's pickList.If unset valueIcons show up in the displayFieldcolumn if specified,  otherwise
 thevalueFieldcolumn.In most cases only the displayFieldorvalueFieldwill be visible. | 
void setPickListHeight(int pickListHeight)
pickListHeight - pickListHeight Default value is 300int getPickListHeight()
void setEmptyPickListHeight(int emptyPickListHeight)
hideEmptyPickList is false.emptyPickListHeight - emptyPickListHeight Default value is 100int getEmptyPickListHeight()
hideEmptyPickList is false.PickList setEmptyPickListMessage(java.lang.String emptyPickListMessage)
hideEmptyPickList is false. Note : This is an advanced setting
emptyPickListMessage - emptyPickListMessage Default value is nullPickList instance, for
 chaining setter callsjava.lang.String getEmptyPickListMessage()
hideEmptyPickList is false.void setHideEmptyPickList(java.lang.Boolean hideEmptyPickList)
hideEmptyPickList - hideEmptyPickList Default value is nulljava.lang.Boolean getHideEmptyPickList()
void setPickListWidth(java.lang.Integer pickListWidth)
pickListWidth - pickListWidth Default value is nulljava.lang.Integer getPickListWidth()
void setPickListMaxWidth(java.lang.Integer pickListMaxWidth)
setPickListWidth 
 the pickList will render wide enough to accomodate them. This property 
 allows the developer to limit how wide the pickList will render.pickListMaxWidth - pickListMaxWidth Default value is 400java.lang.Integer getPickListMaxWidth()
setPickListWidth 
 the pickList will render wide enough to accomodate them. This property 
 allows the developer to limit how wide the pickList will render.void setPickListBaseStyle(java.lang.String pickListBaseStyle)
pickListBaseStyle - pickListBaseStyle Default value is "pickListCell"java.lang.String getPickListBaseStyle()
void setAnimatePickList(java.lang.Boolean animatePickList)
Note : This is an advanced setting
animatePickList - animatePickList Default value is nulljava.lang.Boolean getAnimatePickList()
void setAnimationTime(int animationTime)
Note : This is an advanced setting
animationTime - animationTime Default value is 200int getAnimationTime()
void setPickListHeaderHeight(int pickListHeaderHeight)
pickListHeaderHeight - pickListHeaderHeight Default value is 22int getPickListHeaderHeight()
void setPickListCellHeight(int pickListCellHeight)
pickListCellHeight - pickListCellHeight Default value is 16int getPickListCellHeight()
PickList setValueField(java.lang.String valueField)
displayField values from an  optionDataSource, this property  denotes
 the the field to use as the underlying data value in records from the  optionDataSource.name of this form item. Note : This is an advanced setting
valueField - valueField Default value is nullPickList instance, for
 chaining setter callsjava.lang.String getValueField()
displayField values from an  optionDataSource, this property  denotes
 the the field to use as the underlying data value in records from the  optionDataSource.name of this form item.PickList setDisplayField(java.lang.String displayField)
optionDataSource is
 unset), or bound  to the same dataSource as the form as a whole, this is implemented by picking up the value of
 the specified field from the Form's values object.optionDataSource where the  valueField
 matches this item's value, and displaying the  displayField value from that record.optionDataSource to be used as a server based
 ValueMap.displayField - displayField Default value is nullPickList instance, for
 chaining setter callsjava.lang.String getDisplayField()
optionDataSource is
 unset), or bound  to the same dataSource as the form as a whole, this is implemented by picking up the value of
 the specified field from the Form's values object.optionDataSource where the  valueField
 matches this item's value, and displaying the  displayField value from that record.optionDataSource to be used as a server based
 ValueMap.void setValueIconField(java.lang.String valueIconField)
valueIcons should show up in for this formItem's pickList.displayField column if specified,  otherwise
 the valueField column.displayField or valueField will be visible. This property is typically only
 required if custom pickListFields have
 been specfied for this item. Note : This is an advanced setting
valueIconField - valueIconField Default value is nulljava.lang.String getValueIconField()
valueIcons should show up in for this formItem's pickList.displayField column if specified,  otherwise
 the valueField column.displayField or valueField will be visible. This property is typically only
 required if custom pickListFields have
 been specfied for this item.PickList setPickListCriteria(Criteria pickListCriteria)
optionDataSource is set) this property can be used to provide static filter criteria when retrieving the data
 for the pickList. Note : This is an advanced setting
pickListCriteria - pickListCriteria Default value is nullPickList instance, for
 chaining setter callsCriteria getPickListCriteria()
optionDataSource is set) this property can be used to provide static filter criteria when retrieving the data
 for the pickList.PickList setShowOptionsFromDataSource(java.lang.Boolean showOptionsFromDataSource)
valueMap by default we show the
 valueMap options in the pickList for the item. Setting this property to true will ensure that the options
 displayed in our pickList are derived from the form's dataSource. Note : This is an advanced setting
showOptionsFromDataSource - showOptionsFromDataSource Default value is nullPickList instance, for
 chaining setter callsjava.lang.Boolean getShowOptionsFromDataSource()
valueMap by default we show the
 valueMap options in the pickList for the item. Setting this property to true will ensure that the options
 displayed in our pickList are derived from the form's dataSource.PickList setFilterLocally(java.lang.Boolean filterLocally)
filterLocally is set for this item, and this item is showing options  from a dataSource, fetch
 the entire set of options from the server, and use these values to map the item value to the appropriate display
 value. Also use "local" type filtering on drop down list of options.Note : This is an advanced setting
filterLocally - filterLocally Default value is falsePickList instance, for
 chaining setter callsjava.lang.Boolean getFilterLocally()
filterLocally is set for this item, and this item is showing options  from a dataSource, fetch
 the entire set of options from the server, and use these values to map the item value to the appropriate display
 value. Also use "local" type filtering on drop down list of options.PickList setTextMatchStyle(TextMatchStyle textMatchStyle)
 For a databound pickList (optionDataSource set), textMatchStyle is sent to the server as textMatchStyle. 
 For a non-databound pickList,
 textMatchStyle is applied by  filterClientPickListData().
textMatchStyle - textMatchStyle Default value is "startsWith"PickList instance, for
 chaining setter callsTextMatchStyle getTextMatchStyle()
 For a databound pickList (optionDataSource set), textMatchStyle is sent to the server as textMatchStyle. 
 For a non-databound pickList,
 textMatchStyle is applied by  filterClientPickListData().
PickList setShowAllOptions(java.lang.Boolean showAllOptions)
separatorRows in between.  Not valid for optionDataSource.showAllOptions - showAllOptions Default value is nullPickList instance, for
 chaining setter callsjava.lang.Boolean getShowAllOptions()
separatorRows in between.  Not valid for optionDataSource.java.lang.String getValueFieldName()
valueField
 for this item. If unset, default behavior will return the name of this field.optionDataSourcejava.lang.String getDisplayFieldName()
displayField for this form
 item. If unset, and optionDataSource
 is explicitly specified, this method will return the title field for the optionDataSourcevoid setFetchDelay(java.lang.Integer fetchDelay)
fetchDelay - the fetch delay. defaults to 200msjava.lang.Integer getFetchDelay()
void setPickListFilterCriteriaFunction(FilterCriteriaFunction filterCriteriaFunction)
filterCriteriaFunction - the filter criteria functionListGridRecord[] filterClientPickListData()
 The default implementation applies the criteria returned by #getPickListFilterCriteria  to the data returned
 by getClientPickListData(). A record passes the filter if it has a matching value for all fields in the criteria
 object.  Matching is performed according to textMatchStyle.
 
 If showAllOptions  is set, all values are shown, with matching values shown below a
 separator.
ListGridRecord[] getClientPickListData()
This method will be called for non-databound form items implementing the PickList interface. The default implementation will derive data from the item's valueMap - can be overridden to allow a custom set of options to be displayed.
 Note that for PickLists that filter data based on user input 'ComboBox'), this method should
 return the data before filtering.
PickList setSeparatorRows(ListGridRecord[] separatorRows)
 Not valid for 'databound pickLists'.
separatorRows - separator rowsPickList instance, for
 chaining setter callsDataSource getOptionDataSource()
PickList setOptionDataSource(DataSource dataSource)
void setOptionFilterContext(DSRequest dsRequestProperties)
optionDataSource, and this property is
 not null, this will be passed to the datasource as RPCRequest properties when
 performing the fetch operation on the dataSource to obtain a data-value to display-value
 mapping
 Note : This is an advanced setting
dsRequestProperties - optionFilterContext Default value is null