SelectItem (Smart GWT LGPL Edition API 5.1p (2022-05-28))

java.lang.Object
- com.smartgwt.client.core.JsObject
- - com.smartgwt.client.core.DataClass
  - - com.smartgwt.client.core.RefDataClass
    - - com.smartgwt.client.widgets.form.fields.FormItem
      - com.smartgwt.client.widgets.form.fields.SelectItem

All Implemented Interfaces:

com.google.gwt.event.shared.HasHandlers, HasBlurHandlers, HasChangedHandlers, HasChangeHandlers, HasClickHandlers, HasDataArrivedHandlers, HasDoubleClickHandlers, HasEditorEnterHandlers, HasEditorExitHandlers, HasFocusHandlers, HasIconClickHandlers, HasIconKeyPressHandlers, HasItemHoverHandlers, HasKeyDownHandlers, HasKeyPressHandlers, HasKeyUpHandlers, HasPendingStatusChangedHandlers, HasPickerIconClickHandlers, HasTitleClickHandlers, HasTitleDoubleClickHandlers, HasTitleHoverHandlers, HasValueHoverHandlers, HasValueIconClickHandlers, PickList

Direct Known Subclasses:

PresetCriteriaItem, SelectOtherItem
```
public class SelectItem
extends FormItem
implements PickList, HasDataArrivedHandlers
```
FormItem that allows picking between several mutually exclusive options via a select list.
Options may be derived from a dataSource or a valueMap.
Note that to select the first option as a default value for the item, defaultToFirstOption may be set.

See Also:

com.smartgwt.client.widgets.form.fields.FormItem#getValueMap

Nested Class Summary
- Nested classes/interfaces inherited from class com.smartgwt.client.widgets.form.fields.FormItem
  FormItem.CustomStateGetter, FormItem.StateCustomizer

Field Summary
- Fields inherited from class com.smartgwt.client.widgets.form.fields.FormItem
  scClassName, warnOnEditorTypeConversion, warnOnEditorTypeConversionDefault
- Fields inherited from class com.smartgwt.client.core.RefDataClass
  id
- Fields inherited from class com.smartgwt.client.core.DataClass
  factoryCreated, factoryProperties, readOnly
- Fields inherited from class com.smartgwt.client.core.JsObject
  jsObj

Constructor Summary

Constructors
Constructor and Description
`SelectItem()`
`SelectItem(com.google.gwt.core.client.JavaScriptObject jsObj)`
`SelectItem(java.lang.String name)`
`SelectItem(java.lang.String name, java.lang.String title)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`com.google.gwt.event.shared.HandlerRegistration`	`addDataArrivedHandler(DataArrivedHandler handler)` Add a dataArrived handler.
`static void`	`changeAutoChildDefaults(java.lang.String autoChildName, Canvas defaults)` Changes the defaults for Canvas AutoChildren named `autoChildName`.
`static void`	`changeAutoChildDefaults(java.lang.String autoChildName, DrawItem defaults)` Changes the defaults for DrawItem AutoChildren named `autoChildName`.
`static void`	`changeAutoChildDefaults(java.lang.String autoChildName, FormItem defaults)` Changes the defaults for FormItem AutoChildren named `autoChildName`.
`static void`	`changePickerIconDefaults(FormItemIcon defaults)`
`void`	`defaultDynamicValue()` Expression evaluated to determine the `defaultValue` when no value is provided for this item.
`void`	`fetchData()` Only applies to databound items (see optionDataSource). Performs a fetch type operation on this item's DataSource to retrieve the set of valid options for the item, based on the current pickListCriteria.
`void`	`fetchData(DSCallback callback)`
`void`	`fetchData(DSCallback callback, DSRequest requestProperties)` Only applies to databound items (see optionDataSource). Performs a fetch type operation on this item's DataSource to retrieve the set of valid options for the item, based on the current pickListCriteria.
`ListGridRecord[]`	`filterClientPickListData()` Returns the data to display in the pick list.
`java.lang.Boolean`	`getAddUnknownValues()` If this item's value is set (via `setValue()` or similar) to a value which is not present in the `com.smartgwt.client.types.ValueMap`, should the value be rejected.
`java.lang.Boolean`	`getAllowEmptyValue()` If set to true, always show an empty option in this item's pickList, allowing the user to clear the value (even if there is no empty entry in the valueMap for the item).
`boolean`	`getAllowMultiCharSearch()` By default, if multiple keys are pressed in quick succession, a SelectItem will buffer them together and use the resulting multi-char string when searching.
`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
`java.lang.Boolean`	`getAutoFetchData()` If this select item retrieves its options from a `dataSource`, should options be fetched from the server when the item is first drawn, or should this fetch be delayed until the user opens the pickList.
`java.lang.Boolean`	`getCachePickListResults()` For databound pickLists (see PickList.optionDataSource), by default Smart GWT will cache and re-use datasets shown by pickLists in an LRU (least recently used) caching pattern.
`boolean`	`getCanSelectText()` By default SelectItems do not allow users to select the text of the selected value.
`ListGridRecord[]`	`getClientPickListData()` Returns the set of data to be displayed in this item's PickList.
`java.lang.String`	`getControlStyle()` Base CSS class name for a form item's control box (surrounds text box and picker).
`java.lang.Boolean`	`getDefaultToFirstOption()` Select the first option as the default value for this SelectItem.
`java.lang.Boolean`	`getDefaultValue()` Static default value for this SelectItem.
`java.lang.String`	`getDisplayField()` Specifies an alternative field from which display values should be retrieved for this item.
`java.lang.String`	`getDisplayFieldName()` Returns the `displayField` for this item.
`java.lang.String`	`getEditProxyConstructor()` Default class used to construct the `EditProxy` for this component when the component is `first placed into edit mode`.
`java.lang.String`	`getEmptyDisplayValue()` Text to display when this form item has a null or undefined value.
`int`	`getEmptyPickListHeight()` Height for an empty pick list (showing the empty message), if the pick list has no records and `hideEmptyPickList` is `false`.
`java.lang.String`	`getEmptyPickListMessage()` Empty message to display in the selectItem if PickList.hideEmptyPickList is `false`.
`java.lang.Boolean`	`getEscapeHTML()` By default HTML values in a selectItem will be interpreted by the browser.
`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`	`getFetchDisplayedFieldsOnly()` If this item has a specified `optionDataSource` and this property is `true`, the list of fields used by this pickList will be passed to the datasource as `DSRequest.outputs`.
`java.lang.Boolean`	`getFilterLocally()` If `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.
`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.
`PickListItemIconPlacement`	`getIconPlacement()` For PickList items with `PickListItemIconPlacement` set such that the pickList does not render near-origin, should specified `icons` be rendered inline within the formItem itself, or within the `pickerNavigationBar`.
`SortSpecifier[]`	`getInitialSort()` An array of `SortSpecifier` objects used to set up the initial sort configuration for this pickList.
`java.lang.Boolean`	`getMultiple()` If true, multiple values may be selected.
`MultipleAppearance`	`getMultipleAppearance()` How should items with `multiple` set to 'true' be displayed?
`java.lang.Boolean`	`getOpenOnDownArrow()` Causes the PickList to open when the down arrow is pressed, default false.
`java.lang.Boolean`	`getOpenOnSpace()` Causes the PickList to open when the spacebar is pressed, default false.
`DataSource`	`getOptionDataSource()`
`java.lang.String`	`getOptionOperationId()` If this item has a specified `optionDataSource`, this attribute may be set to specify an explicit `DSRequest.operationId` when performing a fetch against the option dataSource to pick up display value mapping.
`static SelectItem`	`getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)`
`NavigationButton`	`getPickerClearButton()` `NavigationButton` to clear the picker value, created when `pickListPlacement` indicates that the search interface takes over the entire panel or screen.
`java.lang.String`	`getPickerClearButtonTitle()` The title for the `pickerClearButton`.
`NavigationButton`	`getPickerExitButton()` `NavigationButton` to dismiss the picker interface, created when `pickListPlacement` indicates that the search interface takes over the entire panel or screen.
`java.lang.String`	`getPickerExitButtonTitle()` The title for the `pickerExitButton`.
`java.lang.Integer`	`getPickerIconHeight()` If `showPickerIcon` is true for this item, this property governs the size of the picker icon.
`java.lang.String`	`getPickerIconSrc()` If `showPickerIcon` is true for this item, this property governs the `src` of the picker icon image to be displayed.
`java.lang.String`	`getPickerIconStyle()` Base CSS class name for a form item's picker icon cell.
`java.lang.Integer`	`getPickerIconWidth()` If `showPickerIcon` is true for this item, this property governs the size of the picker icon.
`NavigationBar`	`getPickerNavigationBar()` `NavigationBar` created when `pickListPlacement` indicates that the search interface takes over the entire panel or screen.
`java.lang.String`	`getPickListBaseStyle()` Base Style for pickList cells.
`int`	`getPickListCellHeight()` Cell Height for this item's pickList.
`java.lang.String`	`getPickListConstructor()` The Class to use when creating the pickList for a FormItem.
`Criteria`	`getPickListCriteria()` If this item has a databound pickList (for example PickList.optionDataSource is set), this property can be used to provide static filter criteria when retrieving the data for the pickList.
`ListGridField[]`	`getPickListFields()` This property allows the developer to specify which field[s] will be displayed in the drop down list of options.
`protected Criteria`	`getPickListFilterCriteria()` Returns a set of filter criteria to be applied to the data displayed in the pickList when it is shown.
`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.
`PanelPlacement`	`getPickListPlacement()` Controls where the PickList is placed.
`Canvas`	`getPickListPlacementAsCanvas()` Controls where the PickList is placed.
`java.lang.String`	`getPickListPlacementAsString()` Controls where the PickList is placed.
`java.lang.Integer`	`getPickListWidth()` Default width to show the pickList.
`java.lang.Boolean`	`getProgressiveLoading()` Indicates whether or not this SelectItem will load its list of options `progressively`.
`java.lang.Boolean`	`getSaveOnEnter()` Select items will submit their containing form on enter keypress if `saveOnEnter` is true.
`ListGridRecord`	`getSelectedRecord()` Returns the entire record object associated with the current value for this item (or null if no matching record exists in the PickList data).
`ListGridRecord[]`	`getSelectedRecords()` For a SelectItem with an `optionDataSource` and allowing multiple selection (`via multiple:true`), returns the list of currently selected records, or null if none are selected.
`java.lang.Boolean`	`getSeparateSpecialValues()` If true, `special values` such as the empty value will be shown in a separate non-scrolling area, in the `separateValuesList`.
`ListGrid`	`getSeparateValuesList()` AutoChild used to show `specialValues`.
`java.lang.Boolean`	`getShowAllOptions()` If true, even non-matching options will be shown, with configurable `separatorRows` in between.
`java.lang.Boolean`	`getShowFocused()` When this item receives focus, should it be re-styled to indicate it has focus?
`java.lang.Boolean`	`getShowHintInField()` If showing a hint for this form item, should it be shown within the field?
`java.lang.Boolean`	`getShowOptionsFromDataSource()` If this item is part of a databound form, and has a specified `valueMap`, by default we show the valueMap options in the pickList for the item.
`java.lang.Boolean`	`getShowOver()` When the user rolls over the select item, should the pickButton display it's `Over` state?
`java.lang.Boolean`	`getShowPickerIcon()` Should we show a special 'picker' `icon` for this form item? Picker icons are customizable via `pickerIconProperties`.
`java.lang.String`	`getSortField()` Specifies one or more fields by which this item should be initially sorted.
`java.lang.Integer`	`getSortFieldAsInt()` Specifies the field by which this item should be initially sorted.
`java.util.Map`	`getSpecialValues()` A set of "special" values such as "All", "None" or "Invalid" that do not appear in the normal `com.smartgwt.client.types.ValueMap` or in the data returned by the `optionDataSource`.
`java.lang.String`	`getTextBoxStyle()` Base CSS class name for a form item's text box element.
`TextMatchStyle`	`getTextMatchStyle()` When applying filter criteria to pickList data, what type of matching to use.
`java.lang.Boolean`	`getUseClientFiltering()` For `databound` items, this property will be passed to the generated ResultSet data object for the pickList as `ResultSet.useClientFiltering`.
`java.lang.String`	`getValueAsString()` Return the value tracked by this form item.
`java.lang.String`	`getValueField()` If this form item maps data values to display values by retrieving the `FormItem.displayField` values from an `optionDataSource`, this property denotes the the field to use as the underlying data value in records from the optionDataSource. If unset, assumed to be the `FormItem.name` of this form item.
`java.lang.String`	`getValueFieldName()` Getter method to retrieve the `FormItem.valueField` for this item.
`java.lang.String`	`getValueIconField()` For Databound formItems, this property determines which column `valueIcons` should show up in for this formItem's pickList. If unset valueIcons show up in the `displayField` column if specified, otherwise the `valueField` column. In most cases only the `displayField` or `valueField` will be visible.
`java.lang.String[]`	`getValues()` Returns the values of a SelectItem with multiple=true as an array of Strings.
`java.lang.Boolean`	`isMultiple()` If true, multiple values may be selected.
`boolean`	`pendingStatusChanged(DynamicForm form, FormItem item, boolean pendingStatus, java.lang.Object newValue, java.lang.Object value)` Notification method called when `showPending` is enabled and this `SelectItem` should either clear or show its pending visual state.
`void`	`setAddUnknownValues(java.lang.Boolean addUnknownValues)` If this item's value is set (via `setValue()` or similar) to a value which is not present in the `com.smartgwt.client.types.ValueMap`, should the value be rejected.
`void`	`setAllowEmptyValue(java.lang.Boolean allowEmptyValue)` If set to true, always show an empty option in this item's pickList, allowing the user to clear the value (even if there is no empty entry in the valueMap for the item).
`void`	`setAllowMultiCharSearch(boolean allowMultiCharSearch)` By default, if multiple keys are pressed in quick succession, a SelectItem will buffer them together and use the resulting multi-char string when searching.
`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
`void`	`setAutoFetchData(java.lang.Boolean autoFetchData)` If this select item retrieves its options from a `dataSource`, should options be fetched from the server when the item is first drawn, or should this fetch be delayed until the user opens the pickList.
`void`	`setCachePickListResults(java.lang.Boolean cachePickListResults)` For databound pickLists (see PickList.optionDataSource), by default Smart GWT will cache and re-use datasets shown by pickLists in an LRU (least recently used) caching pattern.
`void`	`setCanSelectText(boolean canSelectText)` By default SelectItems do not allow users to select the text of the selected value.
`void`	`setControlStyle(java.lang.String controlStyle)` Base CSS class name for a form item's control box (surrounds text box and picker).
`static void`	`setDefaultProperties(SelectItem selectItemProperties)` Class level method to set the default properties of this class.
`void`	`setDefaultToFirstOption(java.lang.Boolean defaultToFirstOption)` Select the first option as the default value for this SelectItem.
`void`	`setDefaultValue(java.lang.Boolean defaultValue)` Static default value for this SelectItem.
`void`	`setDefaultValues(java.lang.Integer... defaultValues)` Default values used when no value is provided for this item.
`void`	`setDefaultValues(java.lang.String... defaultValues)` Default values used when no value is provided for this item.
`void`	`setDisplayField(java.lang.String displayField)` Specifies an alternative field from which display values should be retrieved for this item.
`void`	`setEditProxyConstructor(java.lang.String editProxyConstructor)` Default class used to construct the `EditProxy` for this component when the component is `first placed into edit mode`.
`void`	`setEmptyDisplayValue(java.lang.String emptyDisplayValue)` Text to display when this form item has a null or undefined value.
`void`	`setEmptyPickListHeight(int emptyPickListHeight)` Height for an empty pick list (showing the empty message), if the pick list has no records and `hideEmptyPickList` is `false`.
`void`	`setEmptyPickListMessage(java.lang.String emptyPickListMessage)` Empty message to display in the selectItem if PickList.hideEmptyPickList is `false`.
`void`	`setEscapeHTML(java.lang.Boolean escapeHTML)` By default HTML values in a selectItem will be interpreted by the browser.
`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.
`void`	`setFetchDisplayedFieldsOnly(java.lang.Boolean fetchDisplayedFieldsOnly)` If this item has a specified `optionDataSource` and this property is `true`, the list of fields used by this pickList will be passed to the datasource as `DSRequest.outputs`.
`void`	`setFilterLocally(java.lang.Boolean filterLocally)` If `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.
`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.
`void`	`setIconPlacement(PickListItemIconPlacement iconPlacement)` For PickList items with `PickListItemIconPlacement` set such that the pickList does not render near-origin, should specified `icons` be rendered inline within the formItem itself, or within the `pickerNavigationBar`.
`void`	`setInitialSort(SortSpecifier... initialSort)` An array of `SortSpecifier` objects used to set up the initial sort configuration for this pickList.
`void`	`setMultiple(java.lang.Boolean multiple)` If true, multiple values may be selected.
`void`	`setMultipleAppearance(MultipleAppearance multipleAppearance)` How should items with `multiple` set to 'true' be displayed?
`void`	`setOpenOnDownArrow(java.lang.Boolean openOnDownArrow)` Causes the PickList to open when the down arrow is pressed, default false.
`void`	`setOpenOnSpace(java.lang.Boolean openOnSpace)` Causes the PickList to open when the spacebar is pressed, default false.
`void`	`setOptionDataSource(DataSource dataSource)` If set, this FormItem will derive data to show in the PickList by fetching records from the specified `optionDataSource`.
`void`	`setOptionFilterContext(DSRequest dsRequestProperties)` If this item has a specified `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
`void`	`setOptionOperationId(java.lang.String optionOperationId)` If this item has a specified `optionDataSource`, this attribute may be set to specify an explicit `DSRequest.operationId` when performing a fetch against the option dataSource to pick up display value mapping.
`void`	`setPickerClearButtonTitle(java.lang.String pickerClearButtonTitle)` The title for the `pickerClearButton`.
`void`	`setPickerExitButtonTitle(java.lang.String pickerExitButtonTitle)` The title for the `pickerExitButton`.
`void`	`setPickerIconHeight(java.lang.Integer pickerIconHeight)` If `showPickerIcon` is true for this item, this property governs the size of the picker icon.
`void`	`setPickerIconSrc(java.lang.String pickerIconSrc)` If `showPickerIcon` is true for this item, this property governs the `src` of the picker icon image to be displayed.
`void`	`setPickerIconStyle(java.lang.String pickerIconStyle)` Base CSS class name for a form item's picker icon cell.
`void`	`setPickerIconWidth(java.lang.Integer pickerIconWidth)` If `showPickerIcon` is true for this item, this property governs the size of the picker icon.
`void`	`setPickListBaseStyle(java.lang.String pickListBaseStyle)` Base Style for pickList cells.
`void`	`setPickListCellHeight(int pickListCellHeight)` Cell Height for this item's pickList.
`void`	`setPickListConstructor(java.lang.String pickListConstructor)` The Class to use when creating the pickList for a FormItem.
`void`	`setPickListCriteria(Criteria pickListCriteria)` If this item has a databound pickList (for example PickList.optionDataSource is set), this property can be used to provide static filter criteria when retrieving the data for the pickList.
`void`	`setPickListCriteria(DSRequest optionFilterContext)` If this item has a specified `optionDataSource`, and this property is not null, this will be passed to the datasource as `RPCRequest` properties when performing the filter operation on the dataSource to obtain the set of options for the list.
`void`	`setPickListFields(ListGridField... pickListFields)` This property allows the developer to specify which field[s] will be displayed in the drop down list of options.
`void`	`setPickListFilterCriteriaFunction(FilterCriteriaFunction filterCriteriaFunction)` Deprecated. in favor of `setPickListFilterCriteriaFunction(FormItemCriteriaFunction)`
`void`	`setPickListFilterCriteriaFunction(FormItemCriteriaFunction filterCriteriaFunction)` Set up a method to return filter criteria for options displayed for this item.
`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`	`setPickListPlacement(Canvas pickListPlacement)` Controls where the PickList is placed.
`void`	`setPickListPlacement(PanelPlacement pickListPlacement)` Controls where the PickList is placed.
`void`	`setPickListPlacement(java.lang.String pickListPlacement)` Controls where the PickList is placed.
`void`	`setPickListProperties(ListGrid pickListProperties)` Set the properties to be applied to the pickList created for this Form Item.
`void`	`setPickListSort(SortSpecifier[] sortSpecifiers)` This method sorts the pickList on one or more fields, creating the underlying JS object if needed.
`void`	`setPickListWidth(java.lang.Integer pickListWidth)` Default width to show the pickList.
`void`	`setProgressiveLoading(java.lang.Boolean progressiveLoading)` Indicates whether or not this SelectItem will load its list of options `progressively`.
`void`	`setSaveOnEnter(java.lang.Boolean saveOnEnter)` Select items will submit their containing form on enter keypress if `saveOnEnter` is true.
`void`	`setSeparateSpecialValues(java.lang.Boolean separateSpecialValues)` If true, `special values` such as the empty value will be shown in a separate non-scrolling area, in the `separateValuesList`.
`void`	`setSeparatorRows(ListGridRecord[] separatorRows)` Array of records to show between matching and non-matching rows in the PickList.
`void`	`setShowAllOptions(java.lang.Boolean showAllOptions)` If true, even non-matching options will be shown, with configurable `separatorRows` in between.
`void`	`setShowFocused(java.lang.Boolean showFocused)` When this item receives focus, should it be re-styled to indicate it has focus?
`void`	`setShowHintInField(java.lang.Boolean showHintInField)` If showing a hint for this form item, should it be shown within the field?
`void`	`setShowOptionsFromDataSource(java.lang.Boolean showOptionsFromDataSource)` If this item is part of a databound form, and has a specified `valueMap`, by default we show the valueMap options in the pickList for the item.
`void`	`setShowOver(java.lang.Boolean showOver)` When the user rolls over the select item, should the pickButton display it's `Over` state?
`void`	`setShowPickerIcon(java.lang.Boolean showPickerIcon)` Should we show a special 'picker' `icon` for this form item? Picker icons are customizable via `pickerIconProperties`.
`void`	`setSortField(java.lang.Integer sortField)` Specifies one or more fields by which this item should be initially sorted.
`void`	`setSortField(java.lang.String... sortField)` Specifies one or more fields by which this item should be initially sorted.
`void`	`setSortField(java.lang.String sortField)` Specifies one or more fields by which this item should be initially sorted.
`void`	`setSpecialValues(java.util.LinkedHashMap valueMap)` Set the specialValues for this item.
`void`	`setSpecialValues(java.util.Map specialValues)` A set of "special" values such as "All", "None" or "Invalid" that do not appear in the normal `com.smartgwt.client.types.ValueMap` or in the data returned by the `optionDataSource`.
`void`	`setSpecialValues(java.lang.String... values)` Set the specialValues for this item.
`void`	`setTextBoxStyle(java.lang.String textBoxStyle)` Base CSS class name for a form item's text box element.
`void`	`setTextMatchStyle(TextMatchStyle textMatchStyle)` When applying filter criteria to pickList data, what type of matching to use.
`void`	`setUseClientFiltering(java.lang.Boolean useClientFiltering)` For `databound` items, this property will be passed to the generated ResultSet data object for the pickList as `ResultSet.useClientFiltering`.
`void`	`setValueField(java.lang.String valueField)` If this form item maps data values to display values by retrieving the `FormItem.displayField` values from an `optionDataSource`, this property denotes the the field to use as the underlying data value in records from the optionDataSource. If unset, assumed to be the `FormItem.name` of this form item.
`void`	`setValueIconField(java.lang.String valueIconField)` For Databound formItems, this property determines which column `valueIcons` should show up in for this formItem's pickList. If unset valueIcons show up in the `displayField` column if specified, otherwise the `valueField` column. In most cases only the `displayField` or `valueField` will be visible.
`void`	`setValues(java.lang.String... values)` Set the values of a SelectItem with multiple=true.
`void`	`showPicker()` Method to show a picker for this item.

Methods inherited from class com.smartgwt.client.widgets.form.fields.FormItem
_getValue, addBlurHandler, addChangedHandler, addChangeHandler, addClickHandler, addDoubleClickHandler, addEditorEnterHandler, addEditorExitHandler, addFocusHandler, addIconClickHandler, addIconKeyPressHandler, addItemHoverHandler, addKeyDownHandler, addKeyPressHandler, addKeyUpHandler, addPendingStatusChangedHandler, addPickerIconClickHandler, addTitleClickHandler, addTitleDoubleClickHandler, addTitleHoverHandler, addValueHoverHandler, addValueIconClickHandler, asSGWTComponent, blurItem, canEditCriterion, clearErrors, clearValue, disable, disableIcon, enable, enableIcon, error, error, errorIfNotCreated, focusInItem, getAccessKey, getAlign, getAllowExpressions, getAlwaysFetchMissingValues, getApplyAlignToText, getApplyHeightToTextBox, getAriaRole, getAttribute, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsFloat, getAttributeAsInt, getAttributeAsJavaScriptObject, getAttributeAsObject, getAttributeAsString, getAutoComplete, getBrowserInputType, getBrowserSpellCheck, getCanEdit, getCanEditOpaqueValues, getCanFocus, getCanvasAutoChild, getCellHeight, getCellStyle, getChangeOnKeypress, getClassName, getClipStaticValue, getClipTitle, getConfig, getContainerWidget, getCriteriaField, getCriterion, getCriterion, getCursorPosition, getCustomState, getDataPath, getDateFormatter, getDecimalPad, getDecimalPrecision, getDefaultIconSrc, getDisabled, getDisableIconsOnReadOnly, getDisplayValue, getDisplayValue, getEditorTypeConfig, getEditPendingCSSText, getEmptyValueIcon, getEndRow, getErrorIconHeight, getErrorIconSrc, getErrorIconWidth, getErrorMessageWidth, getErrors, getExportFormat, getFetchMissingValues, getFieldName, getForeignDisplayField, getForm, getFormat, getFormItemAutoChild, getFullDataPath, getGlobalTabIndex, getGridColNum, getGridRowNum, getHeight, getHeightAsString, getHidden, getHint, getHintStyle, getHoverAlign, getHoverDelay, getHoverHeight, getHoverOpacity, getHoverStyle, getHoverVAlign, getHoverWidth, getIcon, getIconHeight, getIconHSpace, getIconPageRect, getIconPrompt, getIconRect, getIconVAlign, getIconWidth, getImageURLPrefix, getImageURLSuffix, getImplicitSave, getImplicitSaveOnBlur, getInputFormat, getLeft, getLoadingDisplayValue, getLocateItemBy, getMultipleValueSeparator, getName, getOperator, getOptionCriteria, getOptionFilterContext, getOriginalValueMessage, getPageLeft, getPageRect, getPageTop, getPicker, getPickerIconName, getPickerIconPrompt, getPickerIconProperties, getPixelHeight, getPixelWidth, getPrintTextBoxStyle, getPrintTitleStyle, getPrompt, getReadOnlyDisplay, getReadOnlyHover, getReadOnlyTextBoxStyle, getRect, getRedrawOnChange, getRejectInvalidValueOnChange, getRequired, getRequiredMessage, getRowSpan, getScClassName, getSelectOnClick, getSelectOnFocus, getShouldSaveValue, getShowClippedTitleOnHover, getShowClippedValueOnHover, getShowDeletions, getShowDisabled, getShowErrorIcon, getShowErrorStyle, getShowErrorText, getShowFocusedErrorState, getShowFocusedIcons, getShowFocusedPickerIcon, getShowHint, getShowIcons, getShowOldValueInHover, getShowOverIcons, getShowPending, getShowRTL, getShowTitle, getShowValueIconOnly, getStartRow, getStaticHeight, getStopOnError, getSupportsCutPasteEvents, getSuppressValueIcon, getSynchronousValidation, getTabIndex, getTextAlign, getTimeFormatter, getTitle, getTitleAlign, getTitleColSpan, getTitleOrientation, getTitleStyle, getTitleVAlign, getTooltip, getTop, getType, getUseDisabledHintStyleForReadOnly, getValidateOnChange, getValidateOnExit, getValidOperators, getVAlign, getValue, getValueAsRecordList, getValueDeselectedCSSText, getValueIconHeight, getValueIconLeftPadding, getValueIconRightPadding, getValueIconSize, getValueIconWidth, getVisible, getVisibleHeight, getVisibleTitleWidth, getVisibleWidth, getWarnOnEditorTypeConversion, getWarnOnEditorTypeConversionDefault, getWidth, getWidthAsString, getWrapTitle, handleWarnOnEditorTypeConversion, hasAdvancedCriteria, hasErrors, hide, hideIcon, invalidateDisplayValueCache, isCreated, isCutEvent, isDisabled, isDrawn, isFocused, isInGrid, isPasteEvent, isVisible, linkToInstanceUponCreate, mapDisplayToValue, mapValueToDisplay, mapValueToDisplay, mapValueToDisplay, redraw, redraw, setAccessKey, setAlign, setAllowExpressions, setAlwaysFetchMissingValues, setApplyAlignToText, setApplyHeightToTextBox, setAriaRole, setAriaState, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAutoChildConstructor, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildVisibility, setAutoComplete, setBrowserInputType, setBrowserSpellCheck, setCanEdit, setCanEditCriterionPredicate, setCanEditOpaqueValues, setCanFocus, setCellHeight, setCellStyle, setChangeOnKeypress, setClipStaticValue, setClipTitle, setColSpan, setColSpan, setCriteriaField, setCriterion, setCriterionGetter, setCriterionSetter, setCustomStateGetter, setDataPath, setDateFormatter, setDecimalPad, setDecimalPrecision, setDefaultIconSrc, setDefaultProperties, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDisabled, setDisableIconsOnReadOnly, setDisplayFormat, setDisplayFormat, setEditorProperties, setEditorType, setEditorType, setEditorType, setEditorValueFormatter, setEditorValueParser, setEditPendingCSSText, setEmptyValueIcon, setEndRow, setErrorFormatter, setErrorIconHeight, setErrorIconSrc, setErrorIconWidth, setErrorMessageWidth, setErrorOrientation, setErrors, setErrors, setExportFormat, setFetchMissingValues, setForeignDisplayField, setFormat, setGlobalTabIndex, setHeight, setHeight, setHidden, setHint, setHintStyle, setHoverAlign, setHoverDelay, setHoverHeight, setHoverOpacity, setHoverStyle, setHoverVAlign, setHoverWidth, setIconDisabled, setIconHeight, setIconHSpace, setIconPrompt, setIcons, setIconVAlign, setIconWidth, setImageURLPrefix, setImageURLSuffix, setImplicitSave, setImplicitSaveOnBlur, setInitHandler, setInputFormat, setInputTransformer, setItemHoverFormatter, setItemTitleHoverFormatter, setItemValueHoverFormatter, setJavaScriptObject, setLeft, setLoadingDisplayValue, setLocateItemBy, setMultipleValueSeparator, setName, setNullProperty, setOperator, setOptionCriteria, setOptionFilterContext, setOriginalValueMessage, setPickerIconName, setPickerIconPrompt, setPickerIconProperties, setPrintTextBoxStyle, setPrintTitleStyle, setPrompt, setProperty, setProperty, setProperty, setProperty, setProperty, setReadOnlyDisplay, setReadOnlyHover, setReadOnlyTextBoxStyle, setRedrawOnChange, setRejectInvalidValueOnChange, setRequired, setRequiredMessage, setRowSpan, setScClassName, setSelectOnClick, setSelectOnFocus, setShouldSaveValue, setShowClippedTitleOnHover, setShowClippedValueOnHover, setShowDeletions, setShowDisabled, setShowErrorIcon, setShowErrorStyle, setShowErrorText, setShowFocusedErrorState, setShowFocusedIcons, setShowFocusedPickerIcon, setShowHint, setShowIcons, setShowIfCondition, setShowOldValueInHover, setShowOverIcons, setShowPending, setShowRTL, setShowTitle, setShowValueIconOnly, setStartRow, setStateCustomizer, setStaticHeight, setStopOnError, setSupportsCutPasteEvents, setSuppressValueIcon, setSynchronousValidation, setTabIndex, setTextAlign, setTimeFormatter, setTitle, setTitleAlign, setTitleColSpan, setTitleHoverFormatter, setTitleOrientation, setTitleStyle, setTitleVAlign, setTooltip, setTop, setType, setUseDisabledHintStyleForReadOnly, setValidateOnChange, setValidateOnExit, setValidators, setValidOperators, setVAlign, setValue, setValue, setValue, setValue, setValue, setValue, setValueDeselectedCSSText, setValueFormatter, setValueHoverFormatter, setValueIconHeight, setValueIconLeftPadding, setValueIconMapper, setValueIconRightPadding, setValueIcons, setValueIconSize, setValueIconWidth, setValueMap, setValueMap, setVisible, setWarnOnEditorTypeConversion, setWarnOnEditorTypeConversionDefault, setWidth, setWidth, setWrapTitle, shouldApplyHeightToTextBox, shouldFetchMissingValue, shouldSaveOnEnter, shouldStopKeyPressBubbling, show, showIcon, stopHover, storeValue, storeValue, updateState, validate, valueClipped

Methods inherited from class com.smartgwt.client.core.RefDataClass
getRef, getRef, internalSetID

Methods inherited from class com.smartgwt.client.core.DataClass
applyFactoryProperties, doAddHandler, fireEvent, getAttributeAsDoubleArray, getAttributeAsIntArray, getAttributeAsLong, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsStringArray, getAttributes, getHandlerCount, getReadOnly, isFactoryCreated, logConfiguration, setAttribute, setAttribute, setAttribute, setAttributeAsJavaObject, setFactoryCreated, setReadOnly

Methods inherited from class com.smartgwt.client.core.JsObject
equals, getJsObj, hashCode, setJsObj

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent

- Constructor Detail
  - SelectItem
```
public SelectItem()
```
  - SelectItem
```
public SelectItem(com.google.gwt.core.client.JavaScriptObject jsObj)
```
  - SelectItem
```
public SelectItem(java.lang.String name)
```
  - SelectItem
```
public SelectItem(java.lang.String name,
                  java.lang.String title)
```
- Method Detail
  - getOrCreateRef
```
public static SelectItem getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
```
  - changeAutoChildDefaults
```
public static void changeAutoChildDefaults(java.lang.String autoChildName,
                                           Canvas defaults)
```
    Changes the defaults for Canvas AutoChildren named autoChildName.
    
    Parameters:
    
    autoChildName - name of an AutoChild to customize the defaults for.
    
    defaults - Canvas defaults to apply. These defaults override any existing properties without destroying or wiping out non-overridden properties. For usage tips on this param, see SGWTProperties.
    
    See Also:
    
    AutoChildUsage
  - changeAutoChildDefaults
```
public static void changeAutoChildDefaults(java.lang.String autoChildName,
                                           FormItem defaults)
```
    Changes the defaults for FormItem AutoChildren named autoChildName.
    
    Parameters:
    
    autoChildName - name of an AutoChild to customize the defaults for.
    
    defaults - FormItem defaults to apply. These defaults override any existing properties without destroying or wiping out non-overridden properties. For usage tips on this param, see SGWTProperties.
    
    See Also:
    
    AutoChildUsage
  - changeAutoChildDefaults
```
public static void changeAutoChildDefaults(java.lang.String autoChildName,
                                           DrawItem defaults)
```
    Changes the defaults for DrawItem AutoChildren named autoChildName.
    
    Parameters:
    
    autoChildName - name of an AutoChild to customize the defaults for.
    
    defaults - DrawItem defaults to apply. These defaults override any existing properties without destroying or wiping out non-overridden properties. For usage tips on this param, see SGWTProperties.
    
    See Also:
    
    AutoChildUsage
  - changePickerIconDefaults
```
public static void changePickerIconDefaults(FormItemIcon defaults)
```
  - setAddUnknownValues
```
public void setAddUnknownValues(java.lang.Boolean addUnknownValues)
```
    If this item's value is set (via setValue() or similar) to a value which is not present in the com.smartgwt.client.types.ValueMap, should the value be rejected.
    If set to false the setValue() call will have no effect if the value is not a valid option.
    If set to true the item's value will be update to the new value, and the value will be added to the set of options displayed in the pick-list until the next call to setValueMap() or setValue().
    Exception: If the value is set to null but there is no null entry in the valueMap for this item, setting addUnknownValues to true will not cause a null option to show up at the top of the select item pickList. Whether an empty option is shown in the pickList is governed by allowEmptyValue instead.
    Note that this property has no effect if the selectItem has a specified optionDataSource. If setValue() is called on a databound SelectItem and the new value does not match any loaded options, the value will be accepted, but not added to the options displayed in the pickList. Also note that if a displayField exists, a fetch will be performed in an attempt to retrieve a valid display value, as described under FormItem.fetchMissingValues. If specified the FormItem.loadingDisplayValue will be displayed while the fetch is in progress, and then the real value (mapped to a display field value if a matching record was found) will be displayed when the fetch completes.
    Note : This is an advanced setting
    
    Parameters:
    
    addUnknownValues - Default value is true
    
    See Also:
    
    Dependent Selects Example
  - getAddUnknownValues
```
public java.lang.Boolean getAddUnknownValues()
```
    If this item's value is set (via setValue() or similar) to a value which is not present in the com.smartgwt.client.types.ValueMap, should the value be rejected.
    If set to false the setValue() call will have no effect if the value is not a valid option.
    If set to true the item's value will be update to the new value, and the value will be added to the set of options displayed in the pick-list until the next call to setValueMap() or setValue().
    Exception: If the value is set to null but there is no null entry in the valueMap for this item, setting addUnknownValues to true will not cause a null option to show up at the top of the select item pickList. Whether an empty option is shown in the pickList is governed by allowEmptyValue instead.
    Note that this property has no effect if the selectItem has a specified optionDataSource. If setValue() is called on a databound SelectItem and the new value does not match any loaded options, the value will be accepted, but not added to the options displayed in the pickList. Also note that if a displayField exists, a fetch will be performed in an attempt to retrieve a valid display value, as described under FormItem.fetchMissingValues. If specified the FormItem.loadingDisplayValue will be displayed while the fetch is in progress, and then the real value (mapped to a display field value if a matching record was found) will be displayed when the fetch completes.
    
    Returns:
    
    Boolean
    
    See Also:
    
    Dependent Selects Example
  - setAllowEmptyValue
```
public void setAllowEmptyValue(java.lang.Boolean allowEmptyValue)
```
    If set to true, always show an empty option in this item's pickList, allowing the user to clear the value (even if there is no empty entry in the valueMap for the item).
    The empty value will be displayed with the emptyDisplayValue.
    With a databound selectItem, enabling allowEmptyValue disables data paging by default - all data matching the current criteria will be requested. However, enabling separateSpecialValues allows data paging to be used if required.
    See also specialValues as a way of providing several different special values in addition to an empty value, such as "Invalid". Note that setting specialValues disables the use of allowEmptyValue - see details of how to have an empty value while using specialValues in in the specialValues documentation.
    
    Parameters:
    
    allowEmptyValue - Default value is false
  - getAllowEmptyValue
```
public java.lang.Boolean getAllowEmptyValue()
```
    If set to true, always show an empty option in this item's pickList, allowing the user to clear the value (even if there is no empty entry in the valueMap for the item).
    The empty value will be displayed with the emptyDisplayValue.
    With a databound selectItem, enabling allowEmptyValue disables data paging by default - all data matching the current criteria will be requested. However, enabling separateSpecialValues allows data paging to be used if required.
    See also specialValues as a way of providing several different special values in addition to an empty value, such as "Invalid". Note that setting specialValues disables the use of allowEmptyValue - see details of how to have an empty value while using specialValues in in the specialValues documentation.
    
    Returns:
    
    Boolean
  - setAllowMultiCharSearch
```
public void setAllowMultiCharSearch(boolean allowMultiCharSearch)
```
    By default, if multiple keys are pressed in quick succession, a SelectItem will buffer them together and use the resulting multi-char string when searching. Set this attribute to false to force the item to match only one character at a time.
    
    Parameters:
    
    allowMultiCharSearch - Default value is true
  - getAllowMultiCharSearch
```
public boolean getAllowMultiCharSearch()
```
    By default, if multiple keys are pressed in quick succession, a SelectItem will buffer them together and use the resulting multi-char string when searching. Set this attribute to false to force the item to match only one character at a time.
    
    Returns:
    
    boolean
  - setAutoFetchData
```
public void setAutoFetchData(java.lang.Boolean autoFetchData)
```
    If this select item retrieves its options from a dataSource, should options be fetched from the server when the item is first drawn, or should this fetch be delayed until the user opens the pickList.
    The default is true in order to allow the user to select a value via keyboard input while keyboard focus is on the SelectItem but the pickList has not actually been shown.
    Note : This is an advanced setting
    
    Parameters:
    
    autoFetchData - Default value is true
  - getAutoFetchData
```
public java.lang.Boolean getAutoFetchData()
```
    If this select item retrieves its options from a dataSource, should options be fetched from the server when the item is first drawn, or should this fetch be delayed until the user opens the pickList.
    The default is true in order to allow the user to select a value via keyboard input while keyboard focus is on the SelectItem but the pickList has not actually been shown.
    
    Returns:
    
    Boolean
  - setCachePickListResults
```
public void setCachePickListResults(java.lang.Boolean cachePickListResults)
```
    For databound pickLists (see PickList.optionDataSource), by default Smart GWT will cache and re-use datasets shown by pickLists in an LRU (least recently used) caching pattern.
    Setting this flag to false avoids this caching for situations where it is too aggressive.
    
    Parameters:
    
    cachePickListResults - Default value is true
  - getCachePickListResults
```
public java.lang.Boolean getCachePickListResults()
```
    For databound pickLists (see PickList.optionDataSource), by default Smart GWT will cache and re-use datasets shown by pickLists in an LRU (least recently used) caching pattern.
    Setting this flag to false avoids this caching for situations where it is too aggressive.
    
    Returns:
    
    Boolean
  - setCanSelectText
```
public void setCanSelectText(boolean canSelectText)
```
    By default SelectItems do not allow users to select the text of the selected value.
    
    Overrides:
    
    setCanSelectText in class FormItem
    
    Parameters:
    
    canSelectText - Default value is false
  - getCanSelectText
```
public boolean getCanSelectText()
```
    By default SelectItems do not allow users to select the text of the selected value.
    
    Overrides:
    
    getCanSelectText in class FormItem
    
    Returns:
    
    boolean
  - setControlStyle
```
public void setControlStyle(java.lang.String controlStyle)
```
    Base CSS class name for a form item's control box (surrounds text box and picker).
    NOTE: See the CompoundFormItem_skinning discussion for special skinning considerations.
    
    Overrides:
    
    setControlStyle in class FormItem
    
    Parameters:
    
    controlStyle - See FormItemBaseStyle . Default value is "selectItemControl", [IRA]
    
    See Also:
    
    FormItem.setCellStyle(java.lang.String), Appearance overview and related methods
  - getControlStyle
```
public java.lang.String getControlStyle()
```
    Base CSS class name for a form item's control box (surrounds text box and picker).
    NOTE: See the CompoundFormItem_skinning discussion for special skinning considerations.
    
    Overrides:
    
    getControlStyle in class FormItem
    
    Returns:
    
    See FormItemBaseStyle
    
    See Also:
    
    FormItem.getCellStyle(), Appearance overview and related methods
  - setDefaultToFirstOption
```
public void setDefaultToFirstOption(java.lang.Boolean defaultToFirstOption)
```
    Select the first option as the default value for this SelectItem.
    If options are derived from a dataSource, the first value returned by the server will be used, otherwise the first value in the valueMap. Note that setting this property to true will trigger a fetch at soon as the form is created, because the form will try to establish a default value at that time.
    If enabled, this setting overrides defaultValue and defaultDynamicValue().
    
    Parameters:
    
    defaultToFirstOption - Default value is false
  - getDefaultToFirstOption
```
public java.lang.Boolean getDefaultToFirstOption()
```
    Select the first option as the default value for this SelectItem.
    If options are derived from a dataSource, the first value returned by the server will be used, otherwise the first value in the valueMap. Note that setting this property to true will trigger a fetch at soon as the form is created, because the form will try to establish a default value at that time.
    If enabled, this setting overrides defaultValue and defaultDynamicValue().
    
    Returns:
    
    Boolean
  - setDefaultValue
```
public void setDefaultValue(java.lang.Boolean defaultValue)
```
    Static default value for this SelectItem. To default to the first option use defaultToFirstOption instead.
    
    Overrides:
    
    setDefaultValue in class FormItem
    
    Parameters:
    
    defaultValue - Default value is null
  - getDefaultValue
```
public java.lang.Boolean getDefaultValue()
```
    Static default value for this SelectItem. To default to the first option use defaultToFirstOption instead.
    
    Returns:
    
    Boolean
  - setDisplayField
```
public void setDisplayField(java.lang.String displayField)
```
    Specifies an alternative field from which display values should be retrieved for this item.
    The display field can be either another field value in the same record or a field that must be retrieved from a related optionDataSource. For fields with an optionDataSource, developers may explicitly specify foreignDisplayField. If that property is unset, the standard displayField value will be used by default.
    If this item is not databound (FormItem.optionDataSource is unset), or bound to the same dataSource as the form as a whole, this item will call form.getValue() the form named after 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 FormItem.optionDataSource where the FormItem.valueField matches this item's value, and displaying the displayField value from that record. (Even if specified, the field may not be used if it does not match any fields present in the optionDataSource - see getDisplayFieldName() for details). Note that if optionDataSource is set and no valid display field is specified (via FormItem.foreignDisplayField, or this property), FormItem.getDisplayFieldName() will return the dataSource title field by default.
    This essentially enables the specified optionDataSource to be used as a server based valueMap.
    Note that, when entering free-form search values, items will select the first match in their valueMap or pickList. This means that it can't be guaranteed that a given search-value will return the same valueField value if there are duplicate displayField values in the available options.
    
    Specified by:
    
    setDisplayField in interface PickList
    
    Overrides:
    
    setDisplayField in class FormItem
    
    Parameters:
    
    displayField - Default value is null
    
    See Also:
    
    FormItem.getDisplayFieldName(), FormItem.invalidateDisplayValueCache(), Databinding overview and related methods, List - Related Records Example
  - getDisplayField
```
public java.lang.String getDisplayField()
```
    Specifies an alternative field from which display values should be retrieved for this item.
    The display field can be either another field value in the same record or a field that must be retrieved from a related optionDataSource. For fields with an optionDataSource, developers may explicitly specify foreignDisplayField. If that property is unset, the standard displayField value will be used by default.
    If this item is not databound (FormItem.optionDataSource is unset), or bound to the same dataSource as the form as a whole, this item will call form.getValue() the form named after 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 FormItem.optionDataSource where the FormItem.valueField matches this item's value, and displaying the displayField value from that record. (Even if specified, the field may not be used if it does not match any fields present in the optionDataSource - see getDisplayFieldName() for details). Note that if optionDataSource is set and no valid display field is specified (via FormItem.foreignDisplayField, or this property), FormItem.getDisplayFieldName() will return the dataSource title field by default.
    This essentially enables the specified optionDataSource to be used as a server based valueMap.
    Note that, when entering free-form search values, items will select the first match in their valueMap or pickList. This means that it can't be guaranteed that a given search-value will return the same valueField value if there are duplicate displayField values in the available options.
    Specified by:
    
    getDisplayField in interface PickList
    
    Overrides:
    
    getDisplayField in class FormItem
    
    Returns:
    Returns the displayField for this item.
    Behavior varies based on the configuration of this item, as follows:
    If this item has an optionDataSource and an explicit FormItem.foreignDisplayField is specified, this will be returned.
    
    Otherwise if an explicit displayField is specified it will be returned by default. If the displayField was specified on the underlying dataSource field, and no matching field is present in the optionDataSource for the item, we avoid returning the specified displayField value and instead return the title field of the option DataSource. We do this to avoid confusion for the case where the displayField is intended as a display-field value for showing another field value within the same record in the underlying dataSource only.
    
    If no explicit foreignDisplay or displayField specification was found, and the FormItem.valueField for this item is hidden in the FormItem.optionDataSource, this method will return the title field for the optionDataSource.
    See Also:
    
    FormItem.getDisplayFieldName(), FormItem.invalidateDisplayValueCache(), Databinding overview and related methods, List - Related Records Example
  - setEditProxyConstructor
```
public void setEditProxyConstructor(java.lang.String editProxyConstructor)
```
    Default class used to construct the EditProxy for this component when the component is first placed into edit mode.
    
    Overrides:
    
    setEditProxyConstructor in class FormItem
    
    Parameters:
    
    editProxyConstructor - See SCClassName . Default value is "SelectItemEditProxy"
  - getEditProxyConstructor
```
public java.lang.String getEditProxyConstructor()
```
    Default class used to construct the EditProxy for this component when the component is first placed into edit mode.
    
    Overrides:
    
    getEditProxyConstructor in class FormItem
    
    Returns:
    
    See SCClassName
  - setEmptyDisplayValue
```
public void setEmptyDisplayValue(java.lang.String emptyDisplayValue)
```
    Text to display when this form item has a null or undefined value.
    If the formItem has a databound pickList, and its FormItem.displayField or FormItem.valueField (if the former isn't set) has an undefined emptyCellValue setting, that field's emptyCellValue will automatically be set to the emptyDisplayValue.
    
    Overrides:
    
    setEmptyDisplayValue in class FormItem
    
    Parameters:
    
    emptyDisplayValue - See HTMLString . Default value is " "
  - getEmptyDisplayValue
```
public java.lang.String getEmptyDisplayValue()
```
    Text to display when this form item has a null or undefined value.
    If the formItem has a databound pickList, and its FormItem.displayField or FormItem.valueField (if the former isn't set) has an undefined emptyCellValue setting, that field's emptyCellValue will automatically be set to the emptyDisplayValue.
    
    Overrides:
    
    getEmptyDisplayValue in class FormItem
    
    Returns:
    
    See HTMLString
  - setEmptyPickListMessage
```
public void setEmptyPickListMessage(java.lang.String emptyPickListMessage)
```
    Empty message to display in the selectItem if PickList.hideEmptyPickList is false.
    Note : This is an advanced setting
    
    Specified by:
    
    setEmptyPickListMessage in interface PickList
    
    Parameters:
    
    emptyPickListMessage - Default value is "No items to show"
  - getEmptyPickListMessage
```
public java.lang.String getEmptyPickListMessage()
```
    Empty message to display in the selectItem if PickList.hideEmptyPickList is false.
    
    Specified by:
    
    getEmptyPickListMessage in interface PickList
    
    Returns:
    
    String
  - setEscapeHTML
```
public void setEscapeHTML(java.lang.Boolean escapeHTML)
```
    By default HTML values in a selectItem will be interpreted by the browser. Setting this flag to true will causes HTML characters to be escaped, meaning the raw value of the field (for example "<b>AAA</b>") is displayed to the user rather than the interpreted HTML (for example "AAA")
    
    Parameters:
    
    escapeHTML - Default value is false
    
    See Also:
    
    Appearance overview and related methods
  - getEscapeHTML
```
public java.lang.Boolean getEscapeHTML()
```
    By default HTML values in a selectItem will be interpreted by the browser. Setting this flag to true will causes HTML characters to be escaped, meaning the raw value of the field (for example "<b>AAA</b>") is displayed to the user rather than the interpreted HTML (for example "AAA")
    
    Returns:
    
    Boolean
    
    See Also:
    
    Appearance overview and related methods
  - setFetchDisplayedFieldsOnly
```
public void setFetchDisplayedFieldsOnly(java.lang.Boolean fetchDisplayedFieldsOnly)
```
    If this item has a specified optionDataSource and this property is true, the list of fields used by this pickList will be passed to the datasource as DSRequest.outputs. If the datasource supports this feature the returned fields will be limited to this list. A custom datasource will need to add code to implement field limiting.
    This list of used fields consists of the values of valueField, displayField and pickListFields.
    NOTE: When enabled, getSelectedRecord will only include the fetched fields.
    Note : This is an advanced setting
    
    Parameters:
    
    fetchDisplayedFieldsOnly - Default value is null
  - getFetchDisplayedFieldsOnly
```
public java.lang.Boolean getFetchDisplayedFieldsOnly()
```
    If this item has a specified optionDataSource and this property is true, the list of fields used by this pickList will be passed to the datasource as DSRequest.outputs. If the datasource supports this feature the returned fields will be limited to this list. A custom datasource will need to add code to implement field limiting.
    This list of used fields consists of the values of valueField, displayField and pickListFields.
    NOTE: When enabled, getSelectedRecord will only include the fetched fields.
    
    Returns:
    
    Boolean
  - setFilterLocally
```
public void setFilterLocally(java.lang.Boolean filterLocally)
```
    If 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.
    This means data will only be fetched once from the server, and then filtered on the client.
    Note - when this property is set to false, filtering will still be performed on the client if a complete set of data for some criteria has been cached by a fetch, and a subsequent fetch has more restrictive criteria. To explicitly disable client-side filtering set the useClientFiltering property to false.
    Note : This is an advanced setting
    
    Specified by:
    
    setFilterLocally in interface PickList
    
    Overrides:
    
    setFilterLocally in class FormItem
    
    Parameters:
    
    filterLocally - Default value is false
    
    See Also:
    
    FormItem.setFilterLocally(java.lang.Boolean)
  - getFilterLocally
```
public java.lang.Boolean getFilterLocally()
```
    If 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.
    This means data will only be fetched once from the server, and then filtered on the client.
    Note - when this property is set to false, filtering will still be performed on the client if a complete set of data for some criteria has been cached by a fetch, and a subsequent fetch has more restrictive criteria. To explicitly disable client-side filtering set the useClientFiltering property to false.
    
    Specified by:
    
    getFilterLocally in interface PickList
    
    Overrides:
    
    getFilterLocally in class FormItem
    
    Returns:
    
    Boolean
    
    See Also:
    
    FormItem.getFilterLocally()
  - setIconPlacement
```
public void setIconPlacement(PickListItemIconPlacement iconPlacement)
```
    For PickList items with PickListItemIconPlacement set such that the pickList does not render near-origin, should specified icons be rendered inline within the formItem itself, or within the pickerNavigationBar.
    May be overridden at the icon level via FormItemIcon.iconPlacement.
    For mobile browsing with limited available screen space, icons rendered in the navigation bar may be easier for the user to interact with.
    
    Parameters:
    
    iconPlacement - Default value is "both"
  - getIconPlacement
```
public PickListItemIconPlacement getIconPlacement()
```
    For PickList items with PickListItemIconPlacement set such that the pickList does not render near-origin, should specified icons be rendered inline within the formItem itself, or within the pickerNavigationBar.
    May be overridden at the icon level via FormItemIcon.iconPlacement.
    For mobile browsing with limited available screen space, icons rendered in the navigation bar may be easier for the user to interact with.
    
    Returns:
    
    PickListItemIconPlacement
  - setInitialSort
```
public void setInitialSort(SortSpecifier... initialSort)
```
    An array of SortSpecifier objects used to set up the initial sort configuration for this pickList. If specified, this will be used instead of any PickList.sortField specified.
    
    Parameters:
    
    initialSort - Default value is null
  - getInitialSort
```
public SortSpecifier[] getInitialSort()
```
    An array of SortSpecifier objects used to set up the initial sort configuration for this pickList. If specified, this will be used instead of any PickList.sortField specified.
    
    Returns:
    
    SortSpecifier...
  - setMultiple
```
public void setMultiple(java.lang.Boolean multiple)
```
    If true, multiple values may be selected.
    The SelectItem will either render as a drop-down allowing multiple selections, or a multi-row list of options similar to a small headerless ListGrid, based on the MultipleAppearance setting.
    The logical value of the formItem, as retrieved by getValue() and set via setValue(), is an Array of Strings reflecting the selected values.
    When this value is true, we disable doubleClick events by default, instead issuing two single clicks by forcibly setting noDoubleClicks: true. If you need to work with doubleClick events, you can disable this default behavior by explicitly setting formItem.pickListProperties.noDoubleClicks: false.
    Note: multiple:true SelectItems with multipleAppearance:"grid" do not currently support optionDataSource binding. You can get around this by calling DataSource.fetchData() directly and calling dsResponse.data.getValueMap() to obtain a valueMap.
    
    Parameters:
    
    multiple - Default value is false
    
    See Also:
    
    Appearance overview and related methods
  - getMultiple
```
public java.lang.Boolean getMultiple()
```
    If true, multiple values may be selected.
    The SelectItem will either render as a drop-down allowing multiple selections, or a multi-row list of options similar to a small headerless ListGrid, based on the MultipleAppearance setting.
    The logical value of the formItem, as retrieved by getValue() and set via setValue(), is an Array of Strings reflecting the selected values.
    When this value is true, we disable doubleClick events by default, instead issuing two single clicks by forcibly setting noDoubleClicks: true. If you need to work with doubleClick events, you can disable this default behavior by explicitly setting formItem.pickListProperties.noDoubleClicks: false.
    Note: multiple:true SelectItems with multipleAppearance:"grid" do not currently support optionDataSource binding. You can get around this by calling DataSource.fetchData() directly and calling dsResponse.data.getValueMap() to obtain a valueMap.
    
    Returns:
    
    Boolean
    
    See Also:
    
    Appearance overview and related methods
  - setMultipleAppearance
```
public void setMultipleAppearance(MultipleAppearance multipleAppearance)
```
    How should items with multiple set to 'true' be displayed?
    
    Parameters:
    
    multipleAppearance - Default value is "picklist"
  - getMultipleAppearance
```
public MultipleAppearance getMultipleAppearance()
```
    How should items with multiple set to 'true' be displayed?
    
    Returns:
    
    MultipleAppearance
  - setOpenOnDownArrow
```
public void setOpenOnDownArrow(java.lang.Boolean openOnDownArrow)
```
    Causes the PickList to open when the down arrow is pressed, default false.
    For native OS widgets, the down arrow changes the value of a select on Windows, but opens the select on Macs. This setting is not recommended unless you are certain that all users of your applications will expect the Mac convention.
    
    Parameters:
    
    openOnDownArrow - Default value is false
  - getOpenOnDownArrow
```
public java.lang.Boolean getOpenOnDownArrow()
```
    Causes the PickList to open when the down arrow is pressed, default false.
    For native OS widgets, the down arrow changes the value of a select on Windows, but opens the select on Macs. This setting is not recommended unless you are certain that all users of your applications will expect the Mac convention.
    
    Returns:
    
    Boolean
  - setOpenOnSpace
```
public void setOpenOnSpace(java.lang.Boolean openOnSpace)
```
    Causes the PickList to open when the spacebar is pressed, default false.
    For native OS widgets, space opens the PickList on Macs, but not on Windows. Consider using this setting if your users are almost entirely Mac users, or enabling it only for users running MacOS.
    However, before using this setting, consider that it means that Spacebar will not be able to be used for another purpose when focus is in a SelectItem.
    
    Parameters:
    
    openOnSpace - Default value is false
  - getOpenOnSpace
```
public java.lang.Boolean getOpenOnSpace()
```
    Causes the PickList to open when the spacebar is pressed, default false.
    For native OS widgets, space opens the PickList on Macs, but not on Windows. Consider using this setting if your users are almost entirely Mac users, or enabling it only for users running MacOS.
    However, before using this setting, consider that it means that Spacebar will not be able to be used for another purpose when focus is in a SelectItem.
    
    Returns:
    
    Boolean
  - setOptionOperationId
```
public void setOptionOperationId(java.lang.String optionOperationId)
```
    If this item has a specified optionDataSource, this attribute may be set to specify an explicit DSRequest.operationId when performing a fetch against the option dataSource to pick up display value mapping.
    
    Overrides:
    
    setOptionOperationId in class FormItem
    
    Parameters:
    
    optionOperationId - Default value is null
  - getOptionOperationId
```
public java.lang.String getOptionOperationId()
```
    If this item has a specified optionDataSource, this attribute may be set to specify an explicit DSRequest.operationId when performing a fetch against the option dataSource to pick up display value mapping.
    
    Overrides:
    
    getOptionOperationId in class FormItem
    
    Returns:
    
    String
  - getPickerClearButton
```
public NavigationButton getPickerClearButton()
```
    NavigationButton to clear the picker value, created when pickListPlacement indicates that the search interface takes over the entire panel or screen.
    This button will only be shown if allowEmptyValue is true.
    The following passthroughs apply:
    - pickerClearButtonTitle for Button.title
    For an overview of how to use and configure AutoChildren, see Using AutoChildren.
    Returns:
    
    NavigationButton
  - setPickerClearButtonTitle
```
public void setPickerClearButtonTitle(java.lang.String pickerClearButtonTitle)
```
    The title for the pickerClearButton.
    
    Parameters:
    
    pickerClearButtonTitle - See HTMLString . Default value is "Clear"
  - getPickerClearButtonTitle
```
public java.lang.String getPickerClearButtonTitle()
```
    The title for the pickerClearButton.
    
    Returns:
    
    See HTMLString
  - getPickerExitButton
```
public NavigationButton getPickerExitButton()
```
    NavigationButton to dismiss the picker interface, created when pickListPlacement indicates that the search interface takes over the entire panel or screen.
    The following passthroughs apply:
    - pickerExitButtonTitle for Button.title
    For an overview of how to use and configure AutoChildren, see Using AutoChildren.
    Returns:
    
    NavigationButton
  - setPickerExitButtonTitle
```
public void setPickerExitButtonTitle(java.lang.String pickerExitButtonTitle)
```
    The title for the pickerExitButton.
    
    Parameters:
    
    pickerExitButtonTitle - See HTMLString . Default value is "Done"
  - getPickerExitButtonTitle
```
public java.lang.String getPickerExitButtonTitle()
```
    The title for the pickerExitButton.
    
    Returns:
    
    See HTMLString
  - setPickerIconHeight
```
public void setPickerIconHeight(java.lang.Integer pickerIconHeight)
```
    If showPickerIcon is true for this item, this property governs the size of the picker icon. If unset, the picker icon will be sized as a square to fit in the available height for the icon.
    It is not recommended to change the pickerIconHeight from the default value if spriting is enabled because the image sprites are set up assuming specific, fixed dimensions of the picker icon. If the pickerIconHeight must be changed, then the pickerIconStyle should be changed to a custom CSS style name.
    Note : This is an advanced setting
    
    Overrides:
    
    setPickerIconHeight in class FormItem
    
    Parameters:
    
    pickerIconHeight - Default value is null
  - getPickerIconHeight
```
public java.lang.Integer getPickerIconHeight()
```
    If showPickerIcon is true for this item, this property governs the size of the picker icon. If unset, the picker icon will be sized as a square to fit in the available height for the icon.
    It is not recommended to change the pickerIconHeight from the default value if spriting is enabled because the image sprites are set up assuming specific, fixed dimensions of the picker icon. If the pickerIconHeight must be changed, then the pickerIconStyle should be changed to a custom CSS style name.
    
    Overrides:
    
    getPickerIconHeight in class FormItem
    
    Returns:
    
    Integer
  - setPickerIconSrc
```
public void setPickerIconSrc(java.lang.String pickerIconSrc)
```
    If showPickerIcon is true for this item, this property governs the src of the picker icon image to be displayed.
    When spriting is enabled, this property will not be used to locate an image, instead, the image is drawn via CSS based on the pickerIconStyle property.
    Note : This is an advanced setting
    
    Overrides:
    
    setPickerIconSrc in class FormItem
    
    Parameters:
    
    pickerIconSrc - See SCImgURL . Default value is "[SKIN]/DynamicForm/SelectItem_PickButton_icon.gif"
  - getPickerIconSrc
```
public java.lang.String getPickerIconSrc()
```
    If showPickerIcon is true for this item, this property governs the src of the picker icon image to be displayed.
    When spriting is enabled, this property will not be used to locate an image, instead, the image is drawn via CSS based on the pickerIconStyle property.
    
    Overrides:
    
    getPickerIconSrc in class FormItem
    
    Returns:
    
    See SCImgURL
  - setPickerIconStyle
```
public void setPickerIconStyle(java.lang.String pickerIconStyle)
```
    Base CSS class name for a form item's picker icon cell. If unset, inherits from this item's controlStyle.
    
    Overrides:
    
    setPickerIconStyle in class FormItem
    
    Parameters:
    
    pickerIconStyle - See FormItemBaseStyle . Default value is "selectItemPickerIcon"
    
    See Also:
    
    FormItem.setCellStyle(java.lang.String), Appearance overview and related methods
  - getPickerIconStyle
```
public java.lang.String getPickerIconStyle()
```
    Base CSS class name for a form item's picker icon cell. If unset, inherits from this item's controlStyle.
    
    Overrides:
    
    getPickerIconStyle in class FormItem
    
    Returns:
    
    See FormItemBaseStyle
    
    See Also:
    
    FormItem.getCellStyle(), Appearance overview and related methods
  - setPickerIconWidth
```
public void setPickerIconWidth(java.lang.Integer pickerIconWidth)
```
    If showPickerIcon is true for this item, this property governs the size of the picker icon. If unset, the picker icon will be sized as a square to fit in the available height for the icon.
    It is not recommended to change the pickerIconWidth from the default value if spriting is enabled because the image sprites are set up assuming specific, fixed dimensions of the picker icon. If the pickerIconWidth must be changed, then the pickerIconStyle should be changed to a custom CSS style name.
    Note : This is an advanced setting
    
    Overrides:
    
    setPickerIconWidth in class FormItem
    
    Parameters:
    
    pickerIconWidth - Default value is null
  - getPickerIconWidth
```
public java.lang.Integer getPickerIconWidth()
```
    If showPickerIcon is true for this item, this property governs the size of the picker icon. If unset, the picker icon will be sized as a square to fit in the available height for the icon.
    It is not recommended to change the pickerIconWidth from the default value if spriting is enabled because the image sprites are set up assuming specific, fixed dimensions of the picker icon. If the pickerIconWidth must be changed, then the pickerIconStyle should be changed to a custom CSS style name.
    
    Overrides:
    
    getPickerIconWidth in class FormItem
    
    Returns:
    
    Integer
  - getPickerNavigationBar
```
public NavigationBar getPickerNavigationBar()
```
    NavigationBar created when pickListPlacement indicates that the search interface takes over the entire panel or screen.
    For an overview of how to use and configure AutoChildren, see Using AutoChildren.
    
    Returns:
    
    NavigationBar
  - setPickListConstructor
```
public void setPickListConstructor(java.lang.String pickListConstructor)
```
    The Class to use when creating the pickList for a FormItem. Must be a subclass of the builtin default, PickListMenu.
    
    Parameters:
    
    pickListConstructor - See SCClassName . Default value is "PickListMenu"
  - getPickListConstructor
```
public java.lang.String getPickListConstructor()
```
    The Class to use when creating the pickList for a FormItem. Must be a subclass of the builtin default, PickListMenu.
    
    Returns:
    
    See SCClassName
  - setPickListCriteria
```
public void setPickListCriteria(Criteria pickListCriteria)
```
    If this item has a databound pickList (for example PickList.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
    
    Specified by:
    
    setPickListCriteria in interface PickList
    
    Parameters:
    
    pickListCriteria - Default value is null
  - getPickListCriteria
```
public Criteria getPickListCriteria()
```
    If this item has a databound pickList (for example PickList.optionDataSource is set), this property can be used to provide static filter criteria when retrieving the data for the pickList.
    
    Specified by:
    
    getPickListCriteria in interface PickList
    
    Returns:
    
    Criteria
  - setPickListFields
```
public void setPickListFields(ListGridField... pickListFields)
```
    This property allows the developer to specify which field[s] will be displayed in the drop down list of options.
    Only applies to databound pickLists (see PickList.optionDataSource, or pickLists with custom data set up via the advanced PickList.getClientPickListData() method.
    If this property is unset, we display the PickList.displayField, if specified, otherwise the PickList.valueField.
    If there are multiple fields, column headers will be shown for each field, the height of which can be customized via the PickList.pickListHeaderHeight attribute.
    Each field to display should be specified as a ListGridField object. Note that unlike in listGrids, dataSource fields marked as hidden:true will be hidden by default in pickLists. To override this behavior, ensure that you specify an explicit value for showIf.
    Note : This is an advanced setting
    
    Parameters:
    
    pickListFields - Default value is null
    
    See Also:
    
    setValueField(java.lang.String), List - Related Records Example
  - getPickListFields
```
public ListGridField[] getPickListFields()
```
    This property allows the developer to specify which field[s] will be displayed in the drop down list of options.
    Only applies to databound pickLists (see PickList.optionDataSource, or pickLists with custom data set up via the advanced PickList.getClientPickListData() method.
    If this property is unset, we display the PickList.displayField, if specified, otherwise the PickList.valueField.
    If there are multiple fields, column headers will be shown for each field, the height of which can be customized via the PickList.pickListHeaderHeight attribute.
    Each field to display should be specified as a ListGridField object. Note that unlike in listGrids, dataSource fields marked as hidden:true will be hidden by default in pickLists. To override this behavior, ensure that you specify an explicit value for showIf.
    
    Returns:
    
    ListGridField...
    
    See Also:
    
    getValueField(), List - Related Records Example
  - setPickListPlacement
```
public void setPickListPlacement(PanelPlacement pickListPlacement)
```
    Controls where the PickList is placed. Can be specified as a PanelPlacement or a specific widget that should be filled (by specifying an actual Canvas or Canvas.ID).
    Default behavior is to "fillPanel" if isHandset or isTablet, to better accomodate the smaller screen real estate and less precise pointing ability on such devices.
    When filling the whole screen, part of the screen or a specific panel, the expanded interface is created as a standard FormItem picker, and incorporates a navigation bar and done button that hides the expanded interface.
    
    Parameters:
    
    pickListPlacement - Default value is null
  - getPickListPlacement
```
public PanelPlacement getPickListPlacement()
```
    Controls where the PickList is placed. Can be specified as a PanelPlacement or a specific widget that should be filled (by specifying an actual Canvas or Canvas.ID).
    Default behavior is to "fillPanel" if isHandset or isTablet, to better accomodate the smaller screen real estate and less precise pointing ability on such devices.
    When filling the whole screen, part of the screen or a specific panel, the expanded interface is created as a standard FormItem picker, and incorporates a navigation bar and done button that hides the expanded interface.
    
    Returns:
    
    PanelPlacement
  - setPickListPlacement
```
public void setPickListPlacement(Canvas pickListPlacement)
```
    Controls where the PickList is placed. Can be specified as a PanelPlacement or a specific widget that should be filled (by specifying an actual Canvas or Canvas.ID).
    Default behavior is to "fillPanel" if isHandset or isTablet, to better accomodate the smaller screen real estate and less precise pointing ability on such devices.
    When filling the whole screen, part of the screen or a specific panel, the expanded interface is created as a standard FormItem picker, and incorporates a navigation bar and done button that hides the expanded interface.
    
    Parameters:
    
    pickListPlacement - Default value is null
  - getPickListPlacementAsCanvas
```
public Canvas getPickListPlacementAsCanvas()
```
    Controls where the PickList is placed. Can be specified as a PanelPlacement or a specific widget that should be filled (by specifying an actual Canvas or Canvas.ID).
    Default behavior is to "fillPanel" if isHandset or isTablet, to better accomodate the smaller screen real estate and less precise pointing ability on such devices.
    When filling the whole screen, part of the screen or a specific panel, the expanded interface is created as a standard FormItem picker, and incorporates a navigation bar and done button that hides the expanded interface.
    
    Returns:
    
    Canvas
  - setPickListPlacement
```
public void setPickListPlacement(java.lang.String pickListPlacement)
```
    Controls where the PickList is placed. Can be specified as a PanelPlacement or a specific widget that should be filled (by specifying an actual Canvas or Canvas.ID).
    Default behavior is to "fillPanel" if isHandset or isTablet, to better accomodate the smaller screen real estate and less precise pointing ability on such devices.
    When filling the whole screen, part of the screen or a specific panel, the expanded interface is created as a standard FormItem picker, and incorporates a navigation bar and done button that hides the expanded interface.
    
    Parameters:
    
    pickListPlacement - Default value is null
  - getPickListPlacementAsString
```
public java.lang.String getPickListPlacementAsString()
```
    Controls where the PickList is placed. Can be specified as a PanelPlacement or a specific widget that should be filled (by specifying an actual Canvas or Canvas.ID).
    Default behavior is to "fillPanel" if isHandset or isTablet, to better accomodate the smaller screen real estate and less precise pointing ability on such devices.
    When filling the whole screen, part of the screen or a specific panel, the expanded interface is created as a standard FormItem picker, and incorporates a navigation bar and done button that hides the expanded interface.
    
    Returns:
    
    String
  - setProgressiveLoading
```
public void setProgressiveLoading(java.lang.Boolean progressiveLoading)
```
    Indicates whether or not this SelectItem will load its list of options progressively. This property is copied onto the underlying PickList.
    
    Parameters:
    
    progressiveLoading - Default value is null
    
    See Also:
    
    DataSource.setProgressiveLoading(java.lang.Boolean), ProgressiveLoading overview and related methods
  - getProgressiveLoading
```
public java.lang.Boolean getProgressiveLoading()
```
    Indicates whether or not this SelectItem will load its list of options progressively. This property is copied onto the underlying PickList.
    
    Returns:
    
    Boolean
    
    See Also:
    
    DataSource.getProgressiveLoading(), ProgressiveLoading overview and related methods
  - setSaveOnEnter
```
public void setSaveOnEnter(java.lang.Boolean saveOnEnter)
```
    Select items will submit their containing form on enter keypress if saveOnEnter is true. Setting this property to false will disable this behavior.
    Note that if the drop down list of options (pickList) is visible an Enter keypress is used to select a value from the available set of options and will not automatically cause form submission.
    
    Overrides:
    
    setSaveOnEnter in class FormItem
    
    Parameters:
    
    saveOnEnter - Default value is true
  - getSaveOnEnter
```
public java.lang.Boolean getSaveOnEnter()
```
    Select items will submit their containing form on enter keypress if saveOnEnter is true. Setting this property to false will disable this behavior.
    Note that if the drop down list of options (pickList) is visible an Enter keypress is used to select a value from the available set of options and will not automatically cause form submission.
    
    Overrides:
    
    getSaveOnEnter in class FormItem
    
    Returns:
    
    Boolean
  - setSeparateSpecialValues
```
public void setSeparateSpecialValues(java.lang.Boolean separateSpecialValues)
```
    If true, special values such as the empty value will be shown in a separate non-scrolling area, in the separateValuesList. Aside from making these values more easily accessible, showing them in a separate list allows data paging to be used, which is disabled if the separateValues are shown in the normal drop-down list along with other values.
    
    Parameters:
    
    separateSpecialValues - Default value is null
  - getSeparateSpecialValues
```
public java.lang.Boolean getSeparateSpecialValues()
```
    If true, special values such as the empty value will be shown in a separate non-scrolling area, in the separateValuesList. Aside from making these values more easily accessible, showing them in a separate list allows data paging to be used, which is disabled if the separateValues are shown in the normal drop-down list along with other values.
    
    Returns:
    
    Boolean
  - getSeparateValuesList
```
public ListGrid getSeparateValuesList()
```
    AutoChild used to show specialValues.
    For an overview of how to use and configure AutoChildren, see Using AutoChildren.
    
    Returns:
    
    ListGrid
  - setShowFocused
```
public void setShowFocused(java.lang.Boolean showFocused)
```
    When this item receives focus, should it be re-styled to indicate it has focus?
    Note : This is an advanced setting
    
    Overrides:
    
    setShowFocused in class FormItem
    
    Parameters:
    
    showFocused - Default value is true, [IRWA]
    
    See Also:
    
    FormItem.setCellStyle(java.lang.String), Appearance overview and related methods
  - getShowFocused
```
public java.lang.Boolean getShowFocused()
```
    When this item receives focus, should it be re-styled to indicate it has focus?
    
    Overrides:
    
    getShowFocused in class FormItem
    
    Returns:
    
    Boolean
    
    See Also:
    
    FormItem.getCellStyle(), Appearance overview and related methods
  - setShowHintInField
```
public void setShowHintInField(java.lang.Boolean showHintInField)
```
    If showing a hint for this form item, should it be shown within the field?
    CSS style for the hint is textBoxStyle with the suffix "Hint" appended to it.
    Note : This is an advanced setting
    
    Parameters:
    
    showHintInField - Default value is null
    
    See Also:
    
    FormItem.setHint(java.lang.String), Appearance overview and related methods
  - getShowHintInField
```
public java.lang.Boolean getShowHintInField()
```
    If showing a hint for this form item, should it be shown within the field?
    CSS style for the hint is textBoxStyle with the suffix "Hint" appended to it.
    
    Returns:
    
    Boolean
    
    See Also:
    
    FormItem.getHint(), Appearance overview and related methods
  - setShowOptionsFromDataSource
```
public void setShowOptionsFromDataSource(java.lang.Boolean showOptionsFromDataSource)
```
    If this item is part of a databound form, and has a specified 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
    
    Specified by:
    
    setShowOptionsFromDataSource in interface PickList
    
    Parameters:
    
    showOptionsFromDataSource - Default value is null
    
    See Also:
    
    Databinding overview and related methods
  - getShowOptionsFromDataSource
```
public java.lang.Boolean getShowOptionsFromDataSource()
```
    If this item is part of a databound form, and has a specified 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.
    
    Specified by:
    
    getShowOptionsFromDataSource in interface PickList
    
    Returns:
    
    Boolean
    
    See Also:
    
    Databinding overview and related methods
  - setShowOver
```
public void setShowOver(java.lang.Boolean showOver)
```
    When the user rolls over the select item, should the pickButton display it's Over state?
    Note : This is an advanced setting
    
    Parameters:
    
    showOver - Default value is true
  - getShowOver
```
public java.lang.Boolean getShowOver()
```
    When the user rolls over the select item, should the pickButton display it's Over state?
    
    Returns:
    
    Boolean
  - setShowPickerIcon
```
public void setShowPickerIcon(java.lang.Boolean showPickerIcon)
```
    Should we show a special 'picker' icon for this form item? Picker icons are customizable via pickerIconProperties. By default they will be rendered inside the form item's "control box" area, and will call FormItem.showPicker() when clicked.
    
    Overrides:
    
    setShowPickerIcon in class FormItem
    
    Parameters:
    
    showPickerIcon - Default value is true
  - getShowPickerIcon
```
public java.lang.Boolean getShowPickerIcon()
```
    Should we show a special 'picker' icon for this form item? Picker icons are customizable via pickerIconProperties. By default they will be rendered inside the form item's "control box" area, and will call FormItem.showPicker() when clicked.
    
    Overrides:
    
    getShowPickerIcon in class FormItem
    
    Returns:
    
    Boolean
  - setSortField
```
public void setSortField(java.lang.String sortField)
```
    Specifies one or more fields by which this item should be initially sorted. It can be a field name, or an array of field names - but note that, if multiple fields are supplied, then each will be sorted in the same direction.
    For full sorting control, set initialSort to a list of custom sortSpecifiers.
    This attribute can also be set to the index of a field in the fields array, but note that it will be converted to a string (field name) after initialization.
    
    Parameters:
    
    sortField - Default value is null
    
    See Also:
    
    Sort Example
  - getSortField
```
public java.lang.String getSortField()
```
    Specifies one or more fields by which this item should be initially sorted. It can be a field name, or an array of field names - but note that, if multiple fields are supplied, then each will be sorted in the same direction.
    For full sorting control, set initialSort to a list of custom sortSpecifiers.
    This attribute can also be set to the index of a field in the fields array, but note that it will be converted to a string (field name) after initialization.
    
    Returns:
    
    String
    
    See Also:
    
    Sort Example
  - setSortField
```
public void setSortField(java.lang.String... sortField)
```
    Specifies one or more fields by which this item should be initially sorted. It can be a field name, or an array of field names - but note that, if multiple fields are supplied, then each will be sorted in the same direction.
    For full sorting control, set initialSort to a list of custom sortSpecifiers.
    This attribute can also be set to the index of a field in the fields array, but note that it will be converted to a string (field name) after initialization.
    
    Parameters:
    
    sortField - Default value is null
    
    See Also:
    
    Sort Example
  - setSortField
```
public void setSortField(java.lang.Integer sortField)
```
    Specifies one or more fields by which this item should be initially sorted. It can be a field name, or an array of field names - but note that, if multiple fields are supplied, then each will be sorted in the same direction.
    For full sorting control, set initialSort to a list of custom sortSpecifiers.
    This attribute can also be set to the index of a field in the fields array, but note that it will be converted to a string (field name) after initialization.
    
    Parameters:
    
    sortField - Default value is null
    
    See Also:
    
    Sort Example
  - setSpecialValues
```
public void setSpecialValues(java.util.Map specialValues)
```
    A set of "special" values such as "All", "None" or "Invalid" that do not appear in the normal com.smartgwt.client.types.ValueMap or in the data returned by the optionDataSource.
    Like other uses of com.smartgwt.client.types.ValueMap, either a list of values or a mapping from stored to display value can be provided.
    These values can either be shown at the top of the list of values (in the order specified), or can be shown in a separate, non-scrolling region - the setting separateSpecialValues controls this. Note that data paging can only be used if separateSpecialValues is enabled.
    If specialValues are configured, allowEmptyValue is ignored - an empty value, if desired, must be included in the specialValues. To provide a specialValue which clears the value of the field, use the special constant emptyStoredValue.
    specialValues can also be used to take a value that does appear in the normal data and redundantly display it at the top of the list to make it more accessible. Note that in this case it is expected that the special value appears both at the top of the list and in it's normal position in the list, so this works best with separateSpecialValues mode enabled.
    Also, if an optionDataSource is used, specialValues that appear in the normal dataset will be updated by automatic cache synchronization (if the displayField is updated). However when using a distinct valueField and displayField, you are required to provide specialValues as a map (there is no support for fetchMissingValues automatically fetching appropriate display values).
    Note that specialValues are not supported in conjunction with MultiComboBoxItem. Whereas with selectItem.multiple:true, specialValues will never be normal values that may be selected. So, specialValues should have options such as "Select All", "Select None" and others.
    
    Parameters:
    
    specialValues - Default value is null
  - getSpecialValues
```
public java.util.Map getSpecialValues()
```
    A set of "special" values such as "All", "None" or "Invalid" that do not appear in the normal com.smartgwt.client.types.ValueMap or in the data returned by the optionDataSource.
    Like other uses of com.smartgwt.client.types.ValueMap, either a list of values or a mapping from stored to display value can be provided.
    These values can either be shown at the top of the list of values (in the order specified), or can be shown in a separate, non-scrolling region - the setting separateSpecialValues controls this. Note that data paging can only be used if separateSpecialValues is enabled.
    If specialValues are configured, allowEmptyValue is ignored - an empty value, if desired, must be included in the specialValues. To provide a specialValue which clears the value of the field, use the special constant emptyStoredValue.
    specialValues can also be used to take a value that does appear in the normal data and redundantly display it at the top of the list to make it more accessible. Note that in this case it is expected that the special value appears both at the top of the list and in it's normal position in the list, so this works best with separateSpecialValues mode enabled.
    Also, if an optionDataSource is used, specialValues that appear in the normal dataset will be updated by automatic cache synchronization (if the displayField is updated). However when using a distinct valueField and displayField, you are required to provide specialValues as a map (there is no support for fetchMissingValues automatically fetching appropriate display values).
    Note that specialValues are not supported in conjunction with MultiComboBoxItem. Whereas with selectItem.multiple:true, specialValues will never be normal values that may be selected. So, specialValues should have options such as "Select All", "Select None" and others.
    
    Returns:
    
    Map
  - setTextBoxStyle
```
public void setTextBoxStyle(java.lang.String textBoxStyle)
```
    Base CSS class name for a form item's text box element.
    NOTE: See the CompoundFormItem_skinning discussion for special skinning considerations.
    If the textBoxStyle is changed at runtime, updateState() must be called to update the visual state of this item.
    
    Overrides:
    
    setTextBoxStyle in class FormItem
    
    Parameters:
    
    textBoxStyle - See FormItemBaseStyle . Default value is "selectItemText", [IRA]
    
    See Also:
    
    FormItem.setCellStyle(java.lang.String), Appearance overview and related methods
  - getTextBoxStyle
```
public java.lang.String getTextBoxStyle()
```
    Base CSS class name for a form item's text box element.
    NOTE: See the CompoundFormItem_skinning discussion for special skinning considerations.
    If the textBoxStyle is changed at runtime, updateState() must be called to update the visual state of this item.
    
    Overrides:
    
    getTextBoxStyle in class FormItem
    
    Returns:
    
    See FormItemBaseStyle
    
    See Also:
    
    FormItem.getCellStyle(), Appearance overview and related methods
  - setTextMatchStyle
```
public void setTextMatchStyle(TextMatchStyle textMatchStyle)
```
    When applying filter criteria to pickList data, what type of matching to use.
    For a databound pickList (optionDataSource set), textMatchStyle is sent to the server as DSRequest.textMatchStyle.
    For a non-databound pickList, textMatchStyle is applied by filterClientPickListData().
    
    Specified by:
    
    setTextMatchStyle in interface PickList
    
    Parameters:
    
    textMatchStyle - Default value is "startsWith"
  - getTextMatchStyle
```
public TextMatchStyle getTextMatchStyle()
```
    When applying filter criteria to pickList data, what type of matching to use.
    For a databound pickList (optionDataSource set), textMatchStyle is sent to the server as DSRequest.textMatchStyle.
    For a non-databound pickList, textMatchStyle is applied by filterClientPickListData().
    
    Specified by:
    
    getTextMatchStyle in interface PickList
    
    Returns:
    
    TextMatchStyle
  - setUseClientFiltering
```
public void setUseClientFiltering(java.lang.Boolean useClientFiltering)
```
    For databound items, this property will be passed to the generated ResultSet data object for the pickList as ResultSet.useClientFiltering. Setting to false will disable filtering on the client and ensure criteria are always passed to the DataSource directly.
    Note : This is an advanced setting
    
    Parameters:
    
    useClientFiltering - Default value is null
  - getUseClientFiltering
```
public java.lang.Boolean getUseClientFiltering()
```
    For databound items, this property will be passed to the generated ResultSet data object for the pickList as ResultSet.useClientFiltering. Setting to false will disable filtering on the client and ensure criteria are always passed to the DataSource directly.
    
    Returns:
    
    Boolean
  - setValueField
```
public void setValueField(java.lang.String valueField)
```
    If this form item maps data values to display values by retrieving the FormItem.displayField values from an optionDataSource, this property denotes the the field to use as the underlying data value in records from the optionDataSource.
    If unset, assumed to be the FormItem.name of this form item.
    
    Specified by:
    
    setValueField in interface PickList
    
    Overrides:
    
    setValueField in class FormItem
    
    Parameters:
    
    valueField - Default value is null
    
    See Also:
    
    Databinding overview and related methods, List - Related Records Example
  - getValueField
```
public java.lang.String getValueField()
```
    If this form item maps data values to display values by retrieving the FormItem.displayField values from an optionDataSource, this property denotes the the field to use as the underlying data value in records from the optionDataSource.
    If unset, assumed to be the FormItem.name of this form item.
    
    Specified by:
    
    getValueField in interface PickList
    
    Overrides:
    
    getValueField in class FormItem
    
    Returns:
    
    Getter method to retrieve the FormItem.valueField for this item. If unset, default behavior will return the FormItem.name of this field.
    
    See Also:
    
    Databinding overview and related methods, List - Related Records Example
  - addDataArrivedHandler
```
public com.google.gwt.event.shared.HandlerRegistration addDataArrivedHandler(DataArrivedHandler handler)
```
    Add a dataArrived handler.
    If this item is showing a dataBound pickList, this notification method will be fired when new data arrives from the server.
    
    Specified by:
    
    addDataArrivedHandler in interface HasDataArrivedHandlers
    
    Parameters:
    
    handler - the dataArrived handler
    
    Returns:
    
    HandlerRegistration used to remove this handler
  - defaultDynamicValue
```
public void defaultDynamicValue()
```
    Expression evaluated to determine the defaultValue when no value is provided for this item. To default to the first option use defaultToFirstOption instead.
  - getDisplayFieldName
```
public java.lang.String getDisplayFieldName()
```
    Returns the displayField for this item.
    Behavior varies based on the configuration of this item, as follows:
    - If this item has an optionDataSource and an explicit FormItem.foreignDisplayField is specified, this will be returned.
    - Otherwise if an explicit displayField is specified it will be returned by default. If the displayField was specified on the underlying dataSource field, and no matching field is present in the optionDataSource for the item, we avoid returning the specified displayField value and instead return the title field of the option DataSource. We do this to avoid confusion for the case where the displayField is intended as a display-field value for showing another field value within the same record in the underlying dataSource only.
    - If no explicit foreignDisplay or displayField specification was found, and the FormItem.valueField for this item is hidden in the FormItem.optionDataSource, this method will return the title field for the optionDataSource.
    Specified by:
    
    getDisplayFieldName in interface PickList
    
    Overrides:
    
    getDisplayFieldName in class FormItem
    
    Returns:
    
    display field name, or null if there is no separate display field to use.
  - getSelectedRecords
```
public ListGridRecord[] getSelectedRecords()
```
    For a SelectItem with an optionDataSource and allowing multiple selection (via multiple:true), returns the list of currently selected records, or null if none are selected.
    
    Returns:
    
    the list of selected records, or null if none are selected
  - getValueFieldName
```
public java.lang.String getValueFieldName()
```
    Getter method to retrieve the FormItem.valueField for this item. If unset, default behavior will return the FormItem.name of this field.
    
    Specified by:
    
    getValueFieldName in interface PickList
    
    Overrides:
    
    getValueFieldName in class FormItem
    
    Returns:
    
    fieldName to use a "value field" in records from this items FormItem.optionDataSource
  - pendingStatusChanged
```
public boolean pendingStatusChanged(DynamicForm form,
                                    FormItem item,
                                    boolean pendingStatus,
                                    java.lang.Object newValue,
                                    java.lang.Object value)
```
    Notification method called when showPending is enabled and this SelectItem should either clear or show its pending visual state.
    The default behavior is that the titleStyle and cellStyle are updated to include/exclude the "Pending" suffix. In addition, a multiple SelectItem when displayed in the pending state will apply FormItem.editPendingCSSText to any new value in the text box and also append "Pending" to the cells' ListGrid.baseStyle for cells in the pickList menu corresponding to new values. Returning false will cancel this default behavior.
    
    Parameters:
    
    form - the managing DynamicForm instance.
    
    item - the form item itself (also available as "this").
    
    pendingStatus - true if the item should show its pending visual state; false otherwise.
    
    newValue - the current form item value.
    
    value - the value that would be restored by a call to DynamicForm.resetValues().
    
    Returns:
    
    false to cancel the default behavior.
  - showPicker
```
public void showPicker()
```
    Method to show a picker for this item. By default this method is called if the user clicks on a pickerIcon. May also be called programmatically.
    Default implementation lazily creates and shows the Picker Autochild. May be overridden to implement some custom picker for this item.
    
    Overrides:
    
    showPicker in class FormItem
  - setDefaultProperties
```
public static void setDefaultProperties(SelectItem selectItemProperties)
```
    Class level method to set the default properties of this class. If set, then all existing and subsequently created instances of this class will automatically have default properties corresponding to the properties of the class instance passed to this function. This is a powerful feature that eliminates the need for users to create a separate hierarchy of subclasses that only alter the default properties of this class. Can also be used for skinning / styling purposes.
    Note: This method is intended for setting default attributes only and will affect all instances of the underlying class (including those automatically generated in JavaScript). This method should not be used to apply standard EventHandlers or override methods for a class - use a custom subclass instead. Calling this method after instances have been created can result in undefined behavior, since it bypasses any setters and a class instance may have already examined a particular property and not be expecting any changes through this route.
    
    Parameters:
    
    selectItemProperties - properties that should be used as new defaults when instances of this class are created
    
    See Also:
    
    SGWTProperties
  - getPickListFilterCriteria
```
protected Criteria getPickListFilterCriteria()
```
    Returns a set of filter criteria to be applied to the data displayed in the pickList when it is shown.
    If this is a databound item, the criteria will be passed as criteria to DataSource.fetchData(). Otherwise an equivalent client-side filter will be performed on the data returned by PickList.getClientPickListData().
    By default returns PickList.pickListCriteria if specified, otherwise an empty set of criteria so all records will be displayed. Note : this is an override point - if overridden this method will be called by the live form item during filtering. However it is recommended that developers use setPickListFilterCriteriaFunction(FormItemCriteriaFunction) to build custom criteria instead of overriding this method directly. This ensures that the custom filter criteria generating code will be called even if the form item was automatically generated based on a template passed to ListGridField.setEditorType(com.smartgwt.client.widgets.form.fields.FormItem).
    
    Returns:
    
    criteria to be used for databound or local filtering
  - setSpecialValues
```
public void setSpecialValues(java.lang.String... values)
```
    Set the specialValues for this item.
    
    Parameters:
    
    values - the special values
  - setSpecialValues
```
public void setSpecialValues(java.util.LinkedHashMap valueMap)
```
    Set the specialValues for this item.
    
    Parameters:
    
    valueMap - the special value map
  - setPickListHeight
```
public void setPickListHeight(int pickListHeight)
```
    Maximum height to show the pick list before it starts to scroll. Note that by default the pickList will be sized to the height required by its content so it will be taller when more rows are available as selectable options.
    
    Specified by:
    
    setPickListHeight in interface PickList
    
    Parameters:
    
    pickListHeight - pickListHeight Default value is 300
  - getPickListHeight
```
public int getPickListHeight()
```
    Maximum height to show the pick list before it starts to scroll. Note that by default the pickList will be sized to the height required by its content so it will be taller when more rows are available as selectable options.
    
    Specified by:
    
    getPickListHeight in interface PickList
    
    Returns:
    
    int
  - setEmptyPickListHeight
```
public void setEmptyPickListHeight(int emptyPickListHeight)
```
    Height for an empty pick list (showing the empty message), if the pick list has no records and hideEmptyPickList is false.
    
    Specified by:
    
    setEmptyPickListHeight in interface PickList
    
    Parameters:
    
    emptyPickListHeight - emptyPickListHeight Default value is 100
  - getEmptyPickListHeight
```
public int getEmptyPickListHeight()
```
    Height for an empty pick list (showing the empty message), if the pick list has no records and hideEmptyPickList is false.
    
    Specified by:
    
    getEmptyPickListHeight in interface PickList
    
    Returns:
    
    int
  - setHideEmptyPickList
```
public 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.
    
    Specified by:
    
    setHideEmptyPickList in interface PickList
    
    Parameters:
    
    hideEmptyPickList - hideEmptyPickList Default value is null
  - getHideEmptyPickList
```
public 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.
    
    Specified by:
    
    getHideEmptyPickList in interface PickList
    
    Returns:
    
    Boolean
  - setPickListWidth
```
public void setPickListWidth(java.lang.Integer pickListWidth)
```
    Default width to show the pickList. If not specified, the width of this form item's element will be used instead.
    
    Specified by:
    
    setPickListWidth in interface PickList
    
    Parameters:
    
    pickListWidth - pickListWidth Default value is null
  - getPickListWidth
```
public java.lang.Integer getPickListWidth()
```
    Default width to show the pickList. If not specified, the width of this form item's element will be used instead.
    
    Specified by:
    
    getPickListWidth in interface PickList
    
    Returns:
    
    Integer
  - setPickListBaseStyle
```
public void setPickListBaseStyle(java.lang.String pickListBaseStyle)
```
    Base Style for pickList cells. As with ListGrid Cells, will have 'over', 'selected' and 'disabled' appended on changes of state for the cells.
    
    Specified by:
    
    setPickListBaseStyle in interface PickList
    
    Parameters:
    
    pickListBaseStyle - pickListBaseStyle Default value is "pickListCell"
  - getPickListBaseStyle
```
public java.lang.String getPickListBaseStyle()
```
    Base Style for pickList cells. As with ListGrid Cells, will have 'over', 'selected' and 'disabled' appended on changes of state for the cells.
    
    Specified by:
    
    getPickListBaseStyle in interface PickList
    
    Returns:
    
    String
  - setAnimatePickList
```
public void setAnimatePickList(java.lang.Boolean animatePickList)
```
    If true, when the pickList is shown, it will be shown via an animated reveal effect
    Note : This is an advanced setting
    
    Specified by:
    
    setAnimatePickList in interface PickList
    
    Parameters:
    
    animatePickList - animatePickList Default value is null
  - getAnimatePickList
```
public java.lang.Boolean getAnimatePickList()
```
    If true, when the pickList is shown, it will be shown via an animated reveal effect
    
    Specified by:
    
    getAnimatePickList in interface PickList
    
    Returns:
    
    Boolean
  - setAnimationTime
```
public void setAnimationTime(int animationTime)
```
    If this.animatePickList is true - this specifies the duration of the animation effect applied when showing the pickList
    Note : This is an advanced setting
    
    Specified by:
    
    setAnimationTime in interface PickList
    
    Parameters:
    
    animationTime - animationTime Default value is 200
  - getAnimationTime
```
public int getAnimationTime()
```
    If this.animatePickList is true - this specifies the duration of the animation effect applied when showing the pickList
    
    Specified by:
    
    getAnimationTime in interface PickList
    
    Returns:
    
    int
  - setPickListHeaderHeight
```
public void setPickListHeaderHeight(int pickListHeaderHeight)
```
    If this pick list is showing multiple fields, this property determines the height of the column headers for those fields. Set to zero to suppress the headers entirely.
    
    Specified by:
    
    setPickListHeaderHeight in interface PickList
    
    Parameters:
    
    pickListHeaderHeight - pickListHeaderHeight Default value is 22
  - getPickListHeaderHeight
```
public int getPickListHeaderHeight()
```
    If this pick list is showing multiple fields, this property determines the height of the column headers for those fields. Set to zero to suppress the headers entirely.
    
    Specified by:
    
    getPickListHeaderHeight in interface PickList
    
    Returns:
    
    int
  - setPickListCellHeight
```
public void setPickListCellHeight(int pickListCellHeight)
```
    Cell Height for this item's pickList.
    
    Specified by:
    
    setPickListCellHeight in interface PickList
    
    Parameters:
    
    pickListCellHeight - pickListCellHeight Default value is 16
  - getPickListCellHeight
```
public int getPickListCellHeight()
```
    Cell Height for this item's pickList.
    
    Specified by:
    
    getPickListCellHeight in interface PickList
    
    Returns:
    
    int
  - getSortFieldAsInt
```
public java.lang.Integer getSortFieldAsInt()
```
    Specifies the field by which this item should be initially sorted. Can be set to either a 'field name' or the index of the field in the fields Array. Note that if sortField is initially specified as a number, it will be converted to a string (field name) after the item is initialized.
    To programmatically change sort field or direction after initialization, call ${isc.DocUtils.linkForRef('sort')}.
    
    Returns:
    
    Integer
  - setValueIconField
```
public void setValueIconField(java.lang.String valueIconField)
```
    For Databound formItems, this property determines which column valueIcons should show up in for this formItem's pickList.
    If unset valueIcons show up in the displayField column if specified, otherwise the valueField column.
    In most cases only the displayField or valueField will be visible. This property is typically only required if custom pickListFields have been specified for this item.
    Note : This is an advanced setting
    
    Specified by:
    
    setValueIconField in interface PickList
    
    Parameters:
    
    valueIconField - valueIconField Default value is null
  - getValueIconField
```
public java.lang.String getValueIconField()
```
    For Databound formItems, this property determines which column valueIcons should show up in for this formItem's pickList.
    If unset valueIcons show up in the displayField column if specified, otherwise the valueField column.
    In most cases only the displayField or valueField will be visible. This property is typically only required if custom pickListFields have been specified for this item.
    
    Specified by:
    
    getValueIconField in interface PickList
    
    Returns:
    
    String
  - setShowAllOptions
```
public void setShowAllOptions(java.lang.Boolean showAllOptions)
```
    If true, even non-matching options will be shown, with configurable separatorRows in between. Not valid for optionDataSource.
    
    Specified by:
    
    setShowAllOptions in interface PickList
    
    Parameters:
    
    showAllOptions - showAllOptions Default value is null
  - getShowAllOptions
```
public java.lang.Boolean getShowAllOptions()
```
    If true, even non-matching options will be shown, with configurable separatorRows in between. Not valid for optionDataSource.
    
    Specified by:
    
    getShowAllOptions in interface PickList
    
    Returns:
    
    Boolean
  - setPickListCriteria
```
public void setPickListCriteria(DSRequest optionFilterContext)
```
    If this item has a specified optionDataSource, and this property is not null, this will be passed to the datasource as RPCRequest properties when performing the filter operation on the dataSource to obtain the set of options for the list.
    Note : This is an advanced setting
    
    Parameters:
    
    optionFilterContext - optionFilterContext Default value is null
  - setOptionDataSource
```
public void setOptionDataSource(DataSource dataSource)
```
    If set, this FormItem will derive data to show in the PickList by fetching records from the specified optionDataSource. The fetched data will be used as a valueMap by extracting the valueField and displayField in the loaded records, to derive one valueMap entry per record loaded from the optionDataSource. Multiple fields from the fetched data may be shown in the pickList by setting pickListFields.
    The data will be retrieved via a "fetch" operation on the DataSource, passing the pickListCriteria (if set) as criteria, and passing optionFilterContext (if set) as DSRequest properties.
    The fetch will be triggered when the pickList is first shown, or, you can set autoFetchData to fetch when the FormItem is first drawn. You can also call com.smartgwt.client.widgets.form.fields.PickList#fetchData at any time to manually trigger a fetch.
    Data paging is automatically enabled if the optionDataSource supports it. As the pickList is scrolled by the user, requests for additional data will be automatically issued.
    For a pickList attached to a ComboBoxItem, new fetches are issued as the user types, with criteria set as described under ComboBoxItem.getPickListFilterCriteria(). If your dataSource is not capable of filtering results by search criteria (eg the dataSource is backed by an XML flat file), you can set filterLocally to have the entire dataset loaded up front and filtering performed in the browser. This disables data paging.
    Setting optionDataSource also enables the basic optionDataSource behaviors, eg, fetching individual display values before the pickList is shown.
    Note that if a normal, static valueMap is also specified for the field (either directly in the form item or as part of the field definition in the dataSource), it will be preferred to the data derived from the optionDataSource for whatever mappings are present.
    Note : This is an advanced setting
    
    Specified by:
    
    setOptionDataSource in interface PickList
    
    Overrides:
    
    setOptionDataSource in class FormItem
    
    Parameters:
    
    optionDataSource - optionDataSource Default value is null
  - getOptionDataSource
```
public DataSource getOptionDataSource()
```
    Specified by:
    
    getOptionDataSource in interface PickList
  - setSeparatorRows
```
public void setSeparatorRows(ListGridRecord[] separatorRows)
```
    Description copied from interface: PickList
    
    Array of records to show between matching and non-matching rows in the PickList.
    Not valid for 'databound pickLists'.
    
    Specified by:
    
    setSeparatorRows in interface PickList
    
    Parameters:
    
    separatorRows - separator rows
  - setDefaultValues
```
public void setDefaultValues(java.lang.String... defaultValues)
```
    Default values used when no value is provided for this item. Note that whenever this item's value is cleared by the user or set to null programmatically, it will be reverted to the defaultValues.
    
    Parameters:
    
    defaultValues - the defaultValues. Default value is null
  - setDefaultValues
```
public void setDefaultValues(java.lang.Integer... defaultValues)
```
    Default values used when no value is provided for this item. Note that whenever this item's value is cleared by the user or set to null programmatically, it will be reverted to the defaultValues.
    
    Parameters:
    
    defaultValues - the defaultValues. Default value is null
  - setFetchDelay
```
public void setFetchDelay(java.lang.Integer fetchDelay)
```
    Description copied from interface: PickList
    
    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. The default setting will initiate a fetch if the stops typing or pauses briefly.
    
    Specified by:
    
    setFetchDelay in interface PickList
    
    Parameters:
    
    fetchDelay - the fetch delay. defaults to 200ms
  - getFetchDelay
```
public java.lang.Integer getFetchDelay()
```
    Description copied from interface: PickList
    
    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. The default setting will initiate a fetch if the stops typing or pauses briefly.
    
    Specified by:
    
    getFetchDelay in interface PickList
    
    Returns:
    
    the fetch delay
  - getValues
```
public java.lang.String[] getValues()
```
    Returns the values of a SelectItem with multiple=true as an array of Strings.
    
    Returns:
    
    value of selection. If no values are selected, and empty array is returned
  - setValues
```
public void setValues(java.lang.String... values)
```
    Set the values of a SelectItem with multiple=true.
    
    Parameters:
    
    values - the SelectItem values
  - isMultiple
```
public java.lang.Boolean isMultiple()
```
    If true, multiple values may be selected.
    The SelectItem will either render as a drop-down allowing multiple selections, or a multi-row list of options similar to a small headerless ListGrid, based on the MultipleAppearance setting.
    The logical value of the formItem, as retrieved by getValue() and set via setValue(), is an Array of Strings reflecting the selected values.
    When this value is true, we disable doubleClick events by default, instead issuing two single clicks by forcibly setting noDoubleClicks: true. If you need to work with doubleClick events, you can disable this default behavior by explicitly setting formItem.pickListProperties.noDoubleClicks: false.
    Note: multiple:true SelectItems do not currently support optionDataSource binding. You can get around this by calling DataSource.fetchData directly and calling dsResponse.data.getValueMap() to obtain a valueMap.
    
    Returns:
    
    Boolean
    
    See Also:
    
    Appearance overview and related methods
  - filterClientPickListData
```
public ListGridRecord[] filterClientPickListData()
```
    Description copied from interface: PickList
    
    Returns the data to display in the pick list.
    The default implementation applies the criteria returned by #getPickListFilterCriteria to the data returned by PickList.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.
    
    Specified by:
    
    filterClientPickListData in interface PickList
    
    Returns:
    
    array of record objects to display in the pickList
  - getClientPickListData
```
public ListGridRecord[] getClientPickListData()
```
    Description copied from interface: PickList
    
    Returns the set of data to be displayed in this item's PickList.
    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.
    
    Specified by:
    
    getClientPickListData in interface PickList
    
    Returns:
    
    Array of record objects to be displayed in the pickList. Note that when a user picks a record from the list, the value of the field matching item.valueField will be picked. Also note that the fields to be displayed can be customized via item.pickListFields
  - getSelectedRecord
```
public ListGridRecord getSelectedRecord()
```
    Returns the entire record object associated with the current value for this item (or null if no matching record exists in the PickList data). Most commonly used for databound pickListItems to retrieve the values of other fields in the record.
    
    Overrides:
    
    getSelectedRecord in class FormItem
    
    Returns:
    
    the selected record or null
  - setPickListFilterCriteriaFunction
```
public void setPickListFilterCriteriaFunction(FilterCriteriaFunction filterCriteriaFunction)
```
    Deprecated. in favor of setPickListFilterCriteriaFunction(FormItemCriteriaFunction)
    
    Set the pick list filter criteria function / handler.
    
    Specified by:
    
    setPickListFilterCriteriaFunction in interface PickList
    
    Parameters:
    
    filterCriteriaFunction - the filter criteria function
  - setPickListFilterCriteriaFunction
```
public void setPickListFilterCriteriaFunction(FormItemCriteriaFunction filterCriteriaFunction)
```
    Set up a method to return filter criteria for options displayed for this item.
    The criteria returned by this method are used to decide which options should appear in the drop-down PickList shown by this SelectItem.
    Static criteria, specified via pickListCriteria, will always be included in addition to criteria returned by this method.
  - setPickListProperties
```
public void setPickListProperties(ListGrid pickListProperties)
```
    Set the properties to be applied to the pickList created for this Form Item.
    Note: Not every ListGrid property is supported when assigned to a pickList. Where there is a dedicated API on the form item (such as setPickListCellHeight()), we recommend that be used in favor of setting the equivalent property on the pickListProperties block.
    PickLists and setShowFilterEditor(): ComboBoxItems do not support setting showFilterEditor to true on pickListProperties. This combination of settings leads to an ambiguous user exprience as the two sets of filter-criteria (those from the text-box and those from the pickList filter editor) interact with each other.
    setPickListProperties() is a valid way to create a filterable pickList, on a SelectItem, but this setting is not supported on a SelectItem with setMultiple() set to true - this combination of settings can cause a selected value to be filtered out of view at which point further selection changes will discard that value.
    In general we recommend the ComboBoxItem class (with setAddUnknownValues() set as appropriate) as a better interface for filtering pickList data.
    
    Parameters:
    
    pickListProperties - the pick list properties
  - setOptionFilterContext
```
public void setOptionFilterContext(DSRequest dsRequestProperties)
```
    Description copied from interface: PickList
    
    If this item has a specified 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
    
    Specified by:
    
    setOptionFilterContext in interface PickList
    
    Parameters:
    
    dsRequestProperties - optionFilterContext Default value is null
  - getValueAsString
```
public java.lang.String getValueAsString()
```
    Return the value tracked by this form item.
    
    Returns:
    
    value of this element
  - setPickListSort
```
public void setPickListSort(SortSpecifier[] sortSpecifiers)
```
    This method sorts the pickList on one or more fields, creating the underlying JS object if needed. Pass in an array of SortSpecifiers to have the grid's data sorted by the fields in each specifier.property and in the directions specified. The grid can be sorted by any combination of fields, including fields specified in the fields array, whether visible or hidden, and 'unused fields from the underlying dataSource', if there is one. If multiple fields are sorted, those that are visible show a directional icon and a small 'sort-numeral' indicating that field's index in the sort configuration.
    See ListGrid.addSort(com.smartgwt.client.data.SortSpecifier) and com.smartgwt.client.widgets.grid.ListGrid#alterSort APIs for information on making changes to the current sort configuration.
    
    Parameters:
    
    sortSpecifiers - Array of SortSpecifier objects
  - fetchData
```
public void fetchData()
```
    Only applies to databound items (see optionDataSource).
    Performs a fetch type operation on this item's DataSource to retrieve the set of valid options for the item, based on the current pickListCriteria.
  - fetchData
```
public void fetchData(DSCallback callback)
```
    See Also:
    
    SelectItem#fetchData()}
  - fetchData
```
public void fetchData(DSCallback callback,
                      DSRequest requestProperties)
```
    Only applies to databound items (see optionDataSource).
    Performs a fetch type operation on this item's DataSource to retrieve the set of valid options for the item, based on the current pickListCriteria.
    Parameters:
    callback - Callback to fire when the fetch completes. Callback will fire with 4 parameters:
    
    item a pointer to the form item
    dsResponse the DSResponse returned by the server
    data the raw data returned by the server
    dsRequest the DSRequest sent to the server
    requestProperties - properties to apply to the dsRequest for this fetch.

Class SelectItem

Nested Class Summary

Nested classes/interfaces inherited from class com.smartgwt.client.widgets.form.fields.FormItem

Field Summary

Fields inherited from class com.smartgwt.client.widgets.form.fields.FormItem

Fields inherited from class com.smartgwt.client.core.RefDataClass

Fields inherited from class com.smartgwt.client.core.DataClass

Fields inherited from class com.smartgwt.client.core.JsObject

Constructor Summary

Method Summary

Methods inherited from class com.smartgwt.client.widgets.form.fields.FormItem

Methods inherited from class com.smartgwt.client.core.RefDataClass

Methods inherited from class com.smartgwt.client.core.DataClass

Methods inherited from class com.smartgwt.client.core.JsObject

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

Constructor Detail

SelectItem

SelectItem

SelectItem

SelectItem

Method Detail

getOrCreateRef

changeAutoChildDefaults

changeAutoChildDefaults

changeAutoChildDefaults

changePickerIconDefaults

setAddUnknownValues

getAddUnknownValues

setAllowEmptyValue

getAllowEmptyValue

setAllowMultiCharSearch

getAllowMultiCharSearch

setAutoFetchData

getAutoFetchData

setCachePickListResults

getCachePickListResults

setCanSelectText

getCanSelectText

setControlStyle

getControlStyle

setDefaultToFirstOption

getDefaultToFirstOption

setDefaultValue

getDefaultValue

setDisplayField

getDisplayField

setEditProxyConstructor

getEditProxyConstructor

setEmptyDisplayValue

getEmptyDisplayValue

setEmptyPickListMessage

getEmptyPickListMessage

setEscapeHTML

getEscapeHTML

setFetchDisplayedFieldsOnly

getFetchDisplayedFieldsOnly

setFilterLocally

getFilterLocally

setIconPlacement

getIconPlacement

setInitialSort

getInitialSort

setMultiple

getMultiple

setMultipleAppearance

getMultipleAppearance

setOpenOnDownArrow

getOpenOnDownArrow

setOpenOnSpace

getOpenOnSpace

setOptionOperationId

getOptionOperationId

getPickerClearButton

setPickerClearButtonTitle

getPickerClearButtonTitle

getPickerExitButton

setPickerExitButtonTitle

getPickerExitButtonTitle

setPickerIconHeight