com.smartgwt.client.widgets.form.fields
Class SelectItem

java.lang.Object
  extended by com.smartgwt.client.core.JsObject
      extended by com.smartgwt.client.core.DataClass
          extended by com.smartgwt.client.core.RefDataClass
              extended by com.smartgwt.client.widgets.form.fields.FormItem
                  extended by com.smartgwt.client.widgets.form.fields.SelectItem
All Implemented Interfaces:
HasHandlers, HasBlurHandlers, HasChangedHandlers, HasChangeHandlers, HasClickHandlers, HasDataArrivedHandlers, HasDoubleClickHandlers, HasFocusHandlers, HasIconClickHandlers, HasIconKeyPressHandlers, HasItemHoverHandlers, HasKeyDownHandlers, HasKeyPressHandlers, HasKeyUpHandlers, HasTitleHoverHandlers, PickList
Direct Known Subclasses:
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.


Field Summary
 
Fields inherited from class com.smartgwt.client.core.JsObject
jsObj
 
Constructor Summary
SelectItem()
           
SelectItem(JavaScriptObject jsObj)
           
SelectItem(String name)
           
SelectItem(String name, String title)
           
 
Method Summary
 HandlerRegistration addDataArrivedHandler(DataArrivedHandler handler)
          Add a dataArrived handler.
 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)
          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, 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.
 Boolean getAddUnknownValues()
          If we're setting the value of a select item and the value isn't a legal value in the valueMap, whether we should allow the value (creating a new option for it) or reject it.
 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 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
 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.
 ListGridRecord[] getClientPickListData()
          Returns the set of data to be displayed in this item's PickList.
 String getControlStyle()
          Base CSS class name for a form item's control box (surrounds text box and picker).
 Boolean getDefaultToFirstOption()
          Select the first option as the default value for this SelectItem.
 Boolean getDefaultValue()
          Static default value for this SelectItem.
 String getDisplayField()
          Specifies an alternative field from which display values should be retrieved for this item.
 String getDisplayFieldName()
          Returns the displayField for this form item.
 int getEmptyPickListHeight()
          Height for an empty pick list (showing the empty message), if the pick list has no records and hideEmptyPickList is false.
 String getEmptyPickListMessage()
          Empty message to display in the pickList if hideEmptyPickList is false.
 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.
 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.
 int getHeight()
          Default height for select items is 19px.
 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.
 Boolean getMultiple()
          If true, this selectItem will be displayed as a tall list of options, and the user will be able to select multiple options.
 DataSource getOptionDataSource()
           
 String getOptionOperationId()
          If this item has a specified optionDataSource, this attribute may be set to specify an explicit operationId when performing a fetch against the option dataSource to pick up display value mapping.
static SelectItem getOrCreateRef(JavaScriptObject jsObj)
           
 Integer getPickerIconHeight()
          If showPickerIcon is true for this item, this property governs the size of the picker icon.
 String getPickerIconSrc()
          If showPickerIcon is true for this item, this property governs the src of the picker icon image to be displayed.
 String getPickerIconStyle()
          Base CSS class name for a form item's picker icon cell.
 Integer getPickerIconWidth()
          If showPickerIcon is true for this item, this property governs the size of the picker icon.
 String getPickListBaseStyle()
          Base Style for pickList cells.
 Criteria getPickListCriteria()
          If this item has a databound pick-list (for example optionDataSource is set) this property can be used to provide static filter criteria when retrieving the data for the pickList.
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.
 Integer getPickListWidth()
          Default width to show the pickList.
 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).
 Boolean getShowAllOptions()
          If true, even non-matching options will be shown, with configurable separatorRows in between.
 Boolean getShowFocused()
          When this item recieves focus, should it be re-styled to indicate it has focus?
 Boolean getShowHintInField()
          If showing a hint for this form item, should it be shown within the field?
 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.
 Boolean getShowOver()
          When the user rolls over the select item, should the pickButton display it's Over state?
 Boolean getShowPickerIcon()
          Should we show a special 'picker' icon for this form item.
 String getSortField()
          Specifies the field by which this item should be initially sorted.
 Integer getSortFieldAsInt()
          Specifies the field by which this item should be initially sorted.
 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.
 String getValueField()
          If this form item maps data values to display values by retrieving the 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 name of this form item.
 String getValueFieldName()
          Getter method to retrieve the valueField for this item.
 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.
 String[] getValues()
          Returns the values of a SelectItem with multiple=true as an array of Strings.
 void setAddUnknownValues(Boolean addUnknownValues)
          If we're setting the value of a select item and the value isn't a legal value in the valueMap, whether we should allow the value (creating a new option for it) or reject it.
 void setAllowEmptyValue(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 setAnimatePickList(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(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 setControlStyle(String controlStyle)
          Base CSS class name for a form item's control box (surrounds text box and picker).
 void setDefaultToFirstOption(Boolean defaultToFirstOption)
          Select the first option as the default value for this SelectItem.
 void setDefaultValue(Boolean defaultValue)
          Static default value for this SelectItem.
 void setDefaultValues(Integer... defaultValues)
          Default values used when no value is provided for this item.
 void setDefaultValues(String... defaultValues)
          Default values used when no value is provided for this item.
 void setDisplayField(String displayField)
          Specifies an alternative field from which display values should be retrieved for this item.
 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(String emptyPickListMessage)
          Empty message to display in the pickList if hideEmptyPickList is false.
 void setFetchDelay(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 setFields(FormItemIcon pickerIconProperties)
           
 void setFilterLocally(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 setHeight(int height)
          Default height for select items is 19px.
 void setHideEmptyPickList(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 setMultiple(Boolean multiple)
          If true, this selectItem will be displayed as a tall list of options, and the user will be able to select multiple options.
 void setOptionDataSource(DataSource dataSource)
          If set, this FormItem will derive data to show in the PickList by fetching records from the specified optionDataSource.
 void setOptionOperationId(String optionOperationId)
          If this item has a specified optionDataSource, this attribute may be set to specify an explicit operationId when performing a fetch against the option dataSource to pick up display value mapping.
 void setPickerIconHeight(Integer pickerIconHeight)
          If showPickerIcon is true for this item, this property governs the size of the picker icon.
 void setPickerIconSrc(String pickerIconSrc)
          If showPickerIcon is true for this item, this property governs the src of the picker icon image to be displayed.
 void setPickerIconStyle(String pickerIconStyle)
          Base CSS class name for a form item's picker icon cell.
 void setPickerIconWidth(Integer pickerIconWidth)
          If showPickerIcon is true for this item, this property governs the size of the picker icon.
 void setPickListBaseStyle(String pickListBaseStyle)
          Base Style for pickList cells.
 void setPickListCriteria(Criteria pickListCriteria)
          If this item has a databound pick-list (for example 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)
          Set the pick list filter criteria function / handler.
 void setPickListHeaderHeight(int pickListHeaderHeight)
          If this pick list is showing multiple fields, this property determines the height of the column headers for those fields.
 void setPickListHeight(int pickListHeight)
          Maximum height to show the pick list before it starts to scroll.
 void setPickListWidth(Integer pickListWidth)
          Default width to show the pickList.
 void setSeparatorRows(ListGridRecord[] separatorRows)
          Array of records to show between matching and non-matching rows in the PickList.
 void setShowAllOptions(Boolean showAllOptions)
          If true, even non-matching options will be shown, with configurable separatorRows in between.
 void setShowFocused(Boolean showFocused)
          When this item recieves focus, should it be re-styled to indicate it has focus?
 void setShowHintInField(Boolean showHintInField)
          If showing a hint for this form item, should it be shown within the field?
 void setShowOptionsFromDataSource(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(Boolean showOver)
          When the user rolls over the select item, should the pickButton display it's Over state?
 void setShowPickerIcon(Boolean showPickerIcon)
          Should we show a special 'picker' icon for this form item.
 void setSortField(Integer sortField)
          Specifies the field by which this item should be initially sorted.
 void setSortField(String sortField)
          Specifies the field by which this item should be initially sorted.
 void setTextBoxStyle(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 setValueField(String valueField)
          If this form item maps data values to display values by retrieving the 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 name of this form item.
 void setValueIconField(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(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
addBlurHandler, addChangedHandler, addChangeHandler, addClickHandler, addDoubleClickHandler, addFocusHandler, addIconClickHandler, addIconKeyPressHandler, addItemHoverHandler, addKeyDownHandler, addKeyPressHandler, addKeyUpHandler, addTitleHoverHandler, blurItem, clearValue, disable, enable, focusInItem, getAccessKey, getAlign, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsFloat, getAttributeAsInt, getAttributeAsJavaScriptObject, getAttributeAsString, getCellStyle, getConfig, getCriteriaField, getCriterion, getDataPath, getDateFormatter, getDefaultIconSrc, getDisabled, getDisplayValue, getDisplayValue, getEmptyDisplayValue, getEmptyValueIcon, getEndRow, getErrorIconHeight, getErrorIconSrc, getErrorIconWidth, getErrorMessageWidth, getFetchMissingValues, getFieldName, getForm, getGlobalTabIndex, getHint, getHintStyle, getHoverAlign, getHoverDelay, getHoverHeight, getHoverOpacity, getHoverStyle, getHoverVAlign, getHoverWidth, getIconHeight, getIconPageRect, getIconPrompt, getIconRect, getIconVAlign, getIconWidth, getImageURLPrefix, getImageURLSuffix, getLeft, getName, getOperator, getOptionCriteria, getOptionFilterContext, getPrompt, getRejectInvalidValueOnChange, getRequired, getRowSpan, getSelectOnFocus, getShouldSaveValue, getShowDisabled, getShowErrorIcon, getShowErrorStyle, getShowErrorText, getShowFocusedIcons, getShowFocusedPickerIcon, getShowHint, getShowIcons, getShowOverIcons, getShowTitle, getShowValueIconOnly, getStartRow, getSuppressValueIcon, getTabIndex, getTextAlign, getTimeFormatter, getTitle, getTitleAlign, getTitleOrientation, getTitleStyle, getTooltip, getTop, getType, getValidateOnChange, getValue, getValueIconHeight, getValueIconLeftPadding, getValueIconRightPadding, getValueIconSize, getValueIconWidth, getVisible, getWidth, getWrapTitle, hide, isCreated, isDisabled, isDrawn, redraw, setAccessKey, setAlign, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setCellStyle, setColSpan, setColSpan, setCriteriaField, setDataPath, setDateFormatter, setDefaultIconSrc, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDisabled, setEditorType, setEditorValueFormatter, setEditorValueParser, setEmptyDisplayValue, setEmptyValueIcon, setEndRow, setErrorFormatter, setErrorIconHeight, setErrorIconSrc, setErrorIconWidth, setErrorMessageWidth, setErrorOrientation, setFetchMissingValues, setGlobalTabIndex, setHeight, setHint, setHintStyle, setHoverAlign, setHoverDelay, setHoverHeight, setHoverOpacity, setHoverStyle, setHoverVAlign, setHoverWidth, setIconHeight, setIconPrompt, setIcons, setIconVAlign, setIconWidth, setImageURLPrefix, setImageURLSuffix, setInputTransformer, setItemHoverFormatter, setItemTitleHoverFormatter, setLeft, setName, setOperator, setOptionCriteria, setOptionFilterContext, setPrompt, setProperty, setProperty, setProperty, setProperty, setRedrawOnChange, setRejectInvalidValueOnChange, setRequired, setRowSpan, setSelectOnFocus, setShouldSaveValue, setShowDisabled, setShowErrorIcon, setShowErrorStyle, setShowErrorText, setShowFocusedIcons, setShowFocusedPickerIcon, setShowHint, setShowIcons, setShowIfCondition, setShowOverIcons, setShowTitle, setShowValueIconOnly, setStartRow, setSuppressValueIcon, setTabIndex, setTextAlign, setTimeFormatter, setTitle, setTitleAlign, setTitleOrientation, setTitleStyle, setTooltip, setTop, setType, setValidateOnChange, setValidators, setValue, setValue, setValue, setValue, setValue, setValue, setValueFormatter, setValueIconHeight, setValueIconLeftPadding, setValueIconRightPadding, setValueIcons, setValueIconSize, setValueIconWidth, setValueMap, setValueMap, setVisible, setWidth, setWidth, setWrapTitle, show, stopHover, updateState
 
Methods inherited from class com.smartgwt.client.core.RefDataClass
getRef, getRef
 
Methods inherited from class com.smartgwt.client.core.DataClass
doAddHandler, fireEvent, getAttributeAsIntArray, getAttributeAsMap, getAttributeAsObject, getAttributeAsStringArray, getAttributes, getHandlerCount, getJsObj, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute
 
Methods inherited from class com.smartgwt.client.core.JsObject
setJsObj
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, 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(JavaScriptObject jsObj)

SelectItem

public SelectItem(String name)

SelectItem

public SelectItem(String name,
                  String title)
Method Detail

getOrCreateRef

public static SelectItem getOrCreateRef(JavaScriptObject jsObj)

setHeight

public void setHeight(int height)
Default height for select items is 19px.

Overrides:
setHeight in class FormItem
Parameters:
height - height Default value is 19

getHeight

public int getHeight()
Default height for select items is 19px.

Overrides:
getHeight in class FormItem
Returns:
int

setAddUnknownValues

public void setAddUnknownValues(Boolean addUnknownValues)
If we're setting the value of a select item and the value isn't a legal value in the valueMap, whether we should allow the value (creating a new option for it) or reject it.

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 : This is an advanced setting

Parameters:
addUnknownValues - addUnknownValues Default value is true

getAddUnknownValues

public Boolean getAddUnknownValues()
If we're setting the value of a select item and the value isn't a legal value in the valueMap, whether we should allow the value (creating a new option for it) or reject it.

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.

Returns:
Boolean

setDefaultValue

public void setDefaultValue(Boolean defaultValue)
Static default value for this SelectItem. To default to the first option use defaultToFirstOption instead.

Overrides:
setDefaultValue in class FormItem
Parameters:
defaultValue - defaultValue Default value is null

getDefaultValue

public Boolean getDefaultValue()
Static default value for this SelectItem. To default to the first option use defaultToFirstOption instead.

Returns:
Boolean

setDefaultToFirstOption

public void setDefaultToFirstOption(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 - defaultToFirstOption Default value is false

getDefaultToFirstOption

public 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

setShowPickerIcon

public void setShowPickerIcon(Boolean showPickerIcon)
Should we show a special 'picker' icon for this form item. Picker icons are customizeable via pickerIconProperties. By default they will be rendered inside the Form Item's "control box" area, and will call showPicker() when clicked.

Overrides:
setShowPickerIcon in class FormItem
Parameters:
showPickerIcon - showPickerIcon Default value is true

getShowPickerIcon

public Boolean getShowPickerIcon()
Should we show a special 'picker' icon for this form item. Picker icons are customizeable via pickerIconProperties. By default they will be rendered inside the Form Item's "control box" area, and will call showPicker() when clicked.

Overrides:
getShowPickerIcon in class FormItem
Returns:
Boolean

setTextBoxStyle

public void setTextBoxStyle(String textBoxStyle)
Base CSS class name for a form item's text box element.

NOTE: See the CompoundFormItem_skinning discussion for special skinning considerations.

Overrides:
setTextBoxStyle in class FormItem
Parameters:
textBoxStyle - textBoxStyle Default value is "selectItemText", [IRA]

getTextBoxStyle

public String getTextBoxStyle()
Base CSS class name for a form item's text box element.

NOTE: See the CompoundFormItem_skinning discussion for special skinning considerations.

Overrides:
getTextBoxStyle in class FormItem
Returns:
String

setControlStyle

public void setControlStyle(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.

Parameters:
controlStyle - controlStyle Default value is "selectItemControl", [IRA]

getControlStyle

public 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.

Returns:
String

setPickerIconStyle

public void setPickerIconStyle(String pickerIconStyle)
Base CSS class name for a form item's picker icon cell. If unset inherits from this items controlStyle.

Parameters:
pickerIconStyle - pickerIconStyle Default value is "selectItemPickerIcon", [IRA]

getPickerIconStyle

public String getPickerIconStyle()
Base CSS class name for a form item's picker icon cell. If unset inherits from this items controlStyle.

Returns:
String

setShowFocused

public void setShowFocused(Boolean showFocused)
When this item recieves focus, should it be re-styled to indicate it has focus?

Note : This is an advanced setting

Overrides:
setShowFocused in class FormItem
Parameters:
showFocused - showFocused Default value is true, [IRWA]

getShowFocused

public Boolean getShowFocused()
When this item recieves focus, should it be re-styled to indicate it has focus?

Overrides:
getShowFocused in class FormItem
Returns:
Boolean

setPickerIconWidth

public void setPickerIconWidth(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 avaliable height for the icon.

Note : This is an advanced setting

Overrides:
setPickerIconWidth in class FormItem
Parameters:
pickerIconWidth - pickerIconWidth Default value is null

getPickerIconWidth

public 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 avaliable height for the icon.

Overrides:
getPickerIconWidth in class FormItem
Returns:
Integer

setPickerIconHeight

public void setPickerIconHeight(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 avaliable height for the icon.

Note : This is an advanced setting

Overrides:
setPickerIconHeight in class FormItem
Parameters:
pickerIconHeight - pickerIconHeight Default value is null

getPickerIconHeight

public 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 avaliable height for the icon.

Overrides:
getPickerIconHeight in class FormItem
Returns:
Integer

setPickerIconSrc

public void setPickerIconSrc(String pickerIconSrc)
If showPickerIcon is true for this item, this property governs the src of the picker icon image to be displayed.

Note : This is an advanced setting

Overrides:
setPickerIconSrc in class FormItem
Parameters:
pickerIconSrc - pickerIconSrc Default value is "[SKIN]/DynamicForm/SelectItem_PickButton_icon.gif"

getPickerIconSrc

public String getPickerIconSrc()
If showPickerIcon is true for this item, this property governs the src of the picker icon image to be displayed.

Overrides:
getPickerIconSrc in class FormItem
Returns:
String

setShowOver

public void setShowOver(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 - showOver Default value is true

getShowOver

public Boolean getShowOver()
When the user rolls over the select item, should the pickButton display it's Over state?

Returns:
Boolean

setAllowEmptyValue

public void setAllowEmptyValue(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 - all data matching the 'current criteria' will be requested.

Parameters:
allowEmptyValue - allowEmptyValue Default value is false

getAllowEmptyValue

public 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 - all data matching the 'current criteria' will be requested.

Returns:
Boolean

setAutoFetchData

public void setAutoFetchData(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 - autoFetchData Default value is true

getAutoFetchData

public 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

setShowHintInField

public void setShowHintInField(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 - showHintInField Default value is null

getShowHintInField

public 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

setOptionOperationId

public void setOptionOperationId(String optionOperationId)
If this item has a specified optionDataSource, this attribute may be set to specify an explicit operationId when performing a fetch against the option dataSource to pick up display value mapping.

Overrides:
setOptionOperationId in class FormItem
Parameters:
optionOperationId - optionOperationId Default value is null

getOptionOperationId

public String getOptionOperationId()
If this item has a specified optionDataSource, this attribute may be set to specify an explicit operationId when performing a fetch against the option dataSource to pick up display value mapping.

Overrides:
getOptionOperationId in class FormItem
Returns:
String

setDisplayField

public void setDisplayField(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'.

If this item is not databound (optionDataSource is unset), or bound to the same dataSource as the form as a whole, this item will call DynamicForm.getValue(java.lang.String) 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 optionDataSource where the valueField matches this item's value, and displaying the displayField value from that record. Note that if optionDataSource is set and this value is not set, FormItem.getDisplayFieldName() will return the dataSource title field by default.

This essentially enables the specified optionDataSource to be used as a server based valueMap.

Specified by:
setDisplayField in interface PickList
Overrides:
setDisplayField in class FormItem
Parameters:
displayField - displayField Default value is null

getDisplayField

public 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'.

If this item is not databound (optionDataSource is unset), or bound to the same dataSource as the form as a whole, this item will call DynamicForm.getValue(java.lang.String) 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 optionDataSource where the valueField matches this item's value, and displaying the displayField value from that record. Note that if optionDataSource is set and this value is not set, FormItem.getDisplayFieldName() will return the dataSource title field by default.

This essentially enables the specified optionDataSource to be used as a server based valueMap.

Specified by:
getDisplayField in interface PickList
Overrides:
getDisplayField in class FormItem
Returns:
String

setValueField

public void setValueField(String valueField)
If this form item maps data values to display values by retrieving the 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 name of this form item.

Specified by:
setValueField in interface PickList
Overrides:
setValueField in class FormItem
Parameters:
valueField - valueField Default value is null

getValueField

public String getValueField()
If this form item maps data values to display values by retrieving the 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 name of this form item.

Specified by:
getValueField in interface PickList
Overrides:
getValueField in class FormItem
Returns:
String

setFilterLocally

public void setFilterLocally(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 : This is an advanced setting

Specified by:
setFilterLocally in interface PickList
Overrides:
setFilterLocally in class FormItem
Parameters:
filterLocally - filterLocally Default value is false

getFilterLocally

public 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.

Specified by:
getFilterLocally in interface PickList
Overrides:
getFilterLocally in class FormItem
Returns:
Boolean

setShowOptionsFromDataSource

public void setShowOptionsFromDataSource(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 - showOptionsFromDataSource Default value is null

getShowOptionsFromDataSource

public 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

setMultiple

public void setMultiple(Boolean multiple)
If true, this selectItem will be displayed as a tall list of options, and the user will be able to select multiple options.

In this case the logical value of the formItem, as retrieved by FormItem.getValue() and set via FormItem.setValue(int), is an Array of Strings reflecting the selected values.

Note: multiple:true SelectItems do not currently support optionDataSource binding. You can get around this by calling DataSource.fetchData() directly and creating a valueMap for the item from the resulting array.

Parameters:
multiple - multiple Default value is false

getMultiple

public Boolean getMultiple()
If true, this selectItem will be displayed as a tall list of options, and the user will be able to select multiple options.

In this case the logical value of the formItem, as retrieved by FormItem.getValue() and set via FormItem.setValue(int), is an Array of Strings reflecting the selected values.

Note: multiple:true SelectItems do not currently support optionDataSource binding. You can get around this by calling DataSource.fetchData() directly and creating a valueMap for the item from the resulting array.

Returns:
Boolean

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 String getDisplayFieldName()
Returns the displayField for this form item. If unset, and optionDataSource is explicitly specified, 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

getValueFieldName

public String getValueFieldName()
Getter method to retrieve the valueField for this item. If unset, default behavior will return the 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 optionDataSource

addDataArrivedHandler

public 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

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

Returns:
criteria to be used for databound or local filtering

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 optionDataSource, or picklists with custom data set up via the advanced PickList.getClientPickListData() method.

If this property is unset, we display the displayField, if specified, otherwise the valueField

If there are multiple fields, column headers will be shown for each field, the height of which can be customized via the pickListHeaderHeight attribute.

Each field to display should be specified as a ListGridField object. Note that unlike in ListGrid, dataSource fields marked as com.smartgwt.client.data.DataSourceField#setDis${isc.DocUtils.linkForRef('DataSourceField.display','display:true')} will not be hidden by default in pickLists. To override this behavior, ensure that you specify an explicit value for {@link com.smartgwt.client.widgets.grid.ListGridField#getShowIf showIf}

Note : This is an advanced setting

Parameters:
pickListFields - pickListFields Default value is null

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

setEmptyPickListMessage

public void setEmptyPickListMessage(String emptyPickListMessage)
Empty message to display in the pickList if hideEmptyPickList is false.

Note : This is an advanced setting

Specified by:
setEmptyPickListMessage in interface PickList
Parameters:
emptyPickListMessage - emptyPickListMessage Default value is null

getEmptyPickListMessage

public String getEmptyPickListMessage()
Empty message to display in the pickList if hideEmptyPickList is false.

Specified by:
getEmptyPickListMessage in interface PickList
Returns:
String

setHideEmptyPickList

public void setHideEmptyPickList(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 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(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 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(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 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(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 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

setSortField

public void setSortField(String sortField)
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 initally 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')}.

Parameters:
sortField - sortField Default value is null

getSortField

public String getSortField()
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 initally 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:
String

setSortField

public void setSortField(Integer sortField)
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 initally 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')}.

Parameters:
sortField - sortField Default value is null

getSortFieldAsInt

public 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 initally 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(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 specfied for this item.

Note : This is an advanced setting

Specified by:
setValueIconField in interface PickList
Parameters:
valueIconField - valueIconField Default value is null

getValueIconField

public 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 specfied for this item.

Specified by:
getValueIconField in interface PickList
Returns:
String

setPickListCriteria

public void setPickListCriteria(Criteria pickListCriteria)
If this item has a databound pick-list (for example 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 - pickListCriteria Default value is null

getPickListCriteria

public Criteria getPickListCriteria()
If this item has a databound pick-list (for example 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

setTextMatchStyle

public void setTextMatchStyle(TextMatchStyle textMatchStyle)
When applying filter criteria to pickList data, what type of matching to use. Legal values are "substring" (value contains user input) or "startsWith" (value starts with user input. Both matches are case insensitive.

For a databound pickList (optionDataSource set), textMatchStyle is sent to the server as textMatchStyle.

For a non-databound pickList, textMatchStyle is applied by PickList.filterClientPickListData().

Specified by:
setTextMatchStyle in interface PickList
Parameters:
textMatchStyle - textMatchStyle Default value is "startsWith"

getTextMatchStyle

public TextMatchStyle getTextMatchStyle()
When applying filter criteria to pickList data, what type of matching to use. Legal values are "substring" (value contains user input) or "startsWith" (value starts with user input. Both matches are case insensitive.

For a databound pickList (optionDataSource set), textMatchStyle is sent to the server as textMatchStyle.

For a non-databound pickList, textMatchStyle is applied by PickList.filterClientPickListData().

Specified by:
getTextMatchStyle in interface PickList
Returns:
TextMatchStyle

setShowAllOptions

public void setShowAllOptions(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 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(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 programatically, it will be reverted to the defaultValues.

Parameters:
defaultValues - the defaultValues. Default value is null

setDefaultValues

public void setDefaultValues(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 programatically, it will be reverted to the defaultValues.

Parameters:
defaultValues - the defaultValues. Default value is null

setFetchDelay

public void setFetchDelay(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 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 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(String... values)
Set the values of a SelectItem with multiple=true.

Parameters:
values - the SelectItem values

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)
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 2 parameters: item a pointer to the form item and dsResponse the DSResponse returned by the server.

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 2 parameters: item a pointer to the form item and dsResponse the DSResponse returned by the server.
requestProperties - properties to apply to the dsRequest for this fetch.

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

setFields

public void setFields(FormItemIcon pickerIconProperties)

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, shown by setting this.showPickerIcon to true. May also be called programatically.
Default implementation lazily creates a 'picker' from the set of defaults defined on this FormItem.


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.

Returns:
the selected record or null

setPickListFilterCriteriaFunction

public void setPickListFilterCriteriaFunction(FilterCriteriaFunction filterCriteriaFunction)
Set the pick list filter criteria function / handler.

Specified by:
setPickListFilterCriteriaFunction in interface PickList
Parameters:
filterCriteriaFunction - the filter criteria function