public class SelectItem extends FormItem implements PickList, HasDataArrivedHandlers
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.
com.smartgwt.client.widgets.form.fields.FormItem#getValueMapscClassNameid| 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) |
| 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,
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
SelectItem.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).
|
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 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 |
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 pickList if
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 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.
|
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 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) |
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. |
java.lang.String |
getPickListBaseStyle()
Base Style for pickList cells.
|
Criteria |
getPickListCriteria()
If this item has a databound pickList (for example 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.
|
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 |
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 the field by which this item should be initially sorted.
|
java.lang.Integer |
getSortFieldAsInt()
Specifies the field by which this item should be initially sorted.
|
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 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
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. |
java.lang.String |
getValueFieldName()
Getter method to retrieve the
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.
|
void |
setAddUnknownValues(java.lang.Boolean addUnknownValues)
If this item's value is set (via
SelectItem.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 |
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 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 |
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 pickList if
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 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 |
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 operationId when performing a fetch against the option dataSource to
pick up display value mapping. |
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 |
setPickListCriteria(Criteria pickListCriteria)
If this item has a databound pickList (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)
Deprecated.
|
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 |
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 |
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 the field by which this item should be initially sorted.
|
void |
setSortField(java.lang.String sortField)
Specifies the field by which this item should be initially sorted.
|
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 useClientFiltering. |
void |
setValueField(java.lang.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(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.
|
_getValue, addBlurHandler, addChangedHandler, addChangeHandler, addClickHandler, addDoubleClickHandler, addEditorEnterHandler, addEditorExitHandler, addFocusHandler, addIconClickHandler, addIconKeyPressHandler, addItemHoverHandler, addKeyDownHandler, addKeyPressHandler, addKeyUpHandler, addPickerIconClickHandler, addTitleClickHandler, addTitleDoubleClickHandler, addTitleHoverHandler, addValueHoverHandler, asSGWTComponent, blurItem, canEditCriterion, clearValue, disable, enable, error, error, errorIfNotCreated, focusInItem, getAccessKey, getAlign, getAllowExpressions, getAlwaysFetchMissingValues, getApplyHeightToTextBox, getAriaRole, getAttribute, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsFloat, getAttributeAsInt, getAttributeAsJavaScriptObject, getAttributeAsObject, getAttributeAsString, getBrowserSpellCheck, getCanEdit, getCanEditOpaqueValues, getCanFocus, getCanvasAutoChild, getCellHeight, getCellStyle, getChangeOnKeypress, getClassName, getClipStaticValue, getClipTitle, getConfig, getContainerWidget, getCriteriaField, getCriterion, getCriterion, getDataPath, getDateFormatter, getDecimalPad, getDecimalPrecision, getDefaultIconSrc, getDisabled, getDisableIconsOnReadOnly, getDisplayValue, getDisplayValue, getEditorTypeConfig, getEditPendingCSSText, getEmptyValueIcon, getEndRow, getErrorIconHeight, getErrorIconSrc, getErrorIconWidth, getErrorMessageWidth, getExportFormat, getFetchMissingValues, getFieldName, getForm, getFormat, getFormItemAutoChild, getFullDataPath, getGlobalTabIndex, getHeight, getHeightAsString, 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, getPageLeft, getPageRect, getPageTop, getPicker, getPickerIconName, getPickerIconPrompt, getPickerIconProperties, getPixelHeight, getPixelWidth, getPrintTextBoxStyle, getPrintTitleStyle, getPrompt, getReadOnlyDisplay, getReadOnlyTextBoxStyle, getRect, getRedrawOnChange, getRejectInvalidValueOnChange, getRequired, getRequiredMessage, getRowSpan, getScClassName, getSelectOnClick, getSelectOnFocus, getShouldSaveValue, getShowClippedTitleOnHover, getShowClippedValueOnHover, getShowDisabled, getShowErrorIcon, getShowErrorStyle, getShowErrorText, getShowFocusedErrorState, getShowFocusedIcons, getShowFocusedPickerIcon, getShowHint, getShowIcons, getShowOverIcons, getShowRTL, getShowTitle, getShowValueIconOnly, getStartRow, getStopOnError, getSuppressValueIcon, getSynchronousValidation, getTabIndex, getTextAlign, getTimeFormatter, getTitle, getTitleAlign, getTitleColSpan, getTitleOrientation, getTitleStyle, getTitleVAlign, getTooltip, getTop, getType, getValidateOnChange, getValidateOnExit, getValidOperators, getVAlign, getValue, getValueAsRecordList, getValueIconHeight, getValueIconLeftPadding, getValueIconRightPadding, getValueIconSize, getValueIconWidth, getVisible, getVisibleHeight, getVisibleWidth, getWidth, getWidthAsString, getWrapTitle, hasAdvancedCriteria, hide, hideIcon, invalidateDisplayValueCache, isCreated, isDisabled, isDrawn, isVisible, redraw, setAccessKey, setAlign, setAllowExpressions, setAlwaysFetchMissingValues, 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, setAutoChildVisibility, setBrowserSpellCheck, setCanEdit, setCanEditCriterionPredicate, setCanEditOpaqueValues, setCanFocus, setCellHeight, setCellStyle, setChangeOnKeypress, setClipStaticValue, setClipTitle, setColSpan, setColSpan, setCriteriaField, setCriterion, setCriterionGetter, setCriterionSetter, 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, setExportFormat, setFetchMissingValues, setFormat, setGlobalTabIndex, setHeight, setHeight, setHint, setHintStyle, setHoverAlign, setHoverDelay, setHoverHeight, setHoverOpacity, setHoverStyle, setHoverVAlign, setHoverWidth, setIconHeight, setIconHSpace, setIconPrompt, setIcons, setIconVAlign, setIconWidth, setImageURLPrefix, setImageURLSuffix, setImplicitSave, setImplicitSaveOnBlur, setInitHandler, setInputFormat, setInputTransformer, setItemHoverFormatter, setItemTitleHoverFormatter, setItemValueHoverFormatter, setLeft, setLoadingDisplayValue, setLocateItemBy, setMultipleValueSeparator, setName, setNullProperty, setOperator, setOptionCriteria, setOptionFilterContext, setPickerIconName, setPickerIconPrompt, setPickerIconProperties, setPrintTextBoxStyle, setPrintTitleStyle, setPrompt, setProperty, setProperty, setProperty, setProperty, setProperty, setReadOnlyDisplay, setReadOnlyTextBoxStyle, setRedrawOnChange, setRejectInvalidValueOnChange, setRequired, setRequiredMessage, setRowSpan, setScClassName, setSelectOnClick, setSelectOnFocus, setShouldSaveValue, setShowClippedTitleOnHover, setShowClippedValueOnHover, setShowDisabled, setShowErrorIcon, setShowErrorStyle, setShowErrorText, setShowFocusedErrorState, setShowFocusedIcons, setShowFocusedPickerIcon, setShowHint, setShowIcons, setShowIfCondition, setShowOverIcons, setShowRTL, setShowTitle, setShowValueIconOnly, setStartRow, setStopOnError, setSuppressValueIcon, setSynchronousValidation, setTabIndex, setTextAlign, setTimeFormatter, setTitle, setTitleAlign, setTitleColSpan, setTitleHoverFormatter, setTitleOrientation, setTitleStyle, setTitleVAlign, setTooltip, setTop, setType, setValidateOnChange, setValidateOnExit, setValidators, setValidOperators, setVAlign, setValue, setValue, setValue, setValue, setValue, setValue, setValueFormatter, setValueHoverFormatter, setValueIconHeight, setValueIconLeftPadding, setValueIconMapper, setValueIconRightPadding, setValueIcons, setValueIconSize, setValueIconWidth, setValueMap, setValueMap, setVisible, setWidth, setWidth, setWrapTitle, shouldApplyHeightToTextBox, shouldFetchMissingValue, shouldSaveOnEnter, shouldStopKeyPressBubbling, show, showIcon, stopHover, storeValue, storeValue, updateState, validate, valueClippedgetRef, getRef, internalSetIDdoAddHandler, fireEvent, getAttributeAsDoubleArray, getAttributeAsIntArray, getAttributeAsLong, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsStringArray, getAttributes, getHandlerCount, setAttribute, setAttribute, setAttribute, setAttributeAsJavaObjectequals, getJsObj, hashCode, setJavaScriptObject, setJsObjpublic SelectItem()
public SelectItem(com.google.gwt.core.client.JavaScriptObject jsObj)
public SelectItem(java.lang.String name)
public SelectItem(java.lang.String name,
java.lang.String title)
public static SelectItem getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
public static void changeAutoChildDefaults(java.lang.String autoChildName,
Canvas defaults)
autoChildName.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.AutoChildUsagepublic static void changeAutoChildDefaults(java.lang.String autoChildName,
FormItem defaults)
autoChildName.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.AutoChildUsagepublic static void changePickerIconDefaults(FormItemIcon defaults)
public void setAddUnknownValues(java.lang.Boolean addUnknownValues)
SelectItem.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 SelectItem.setValueMap() or SelectItem.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 SelectItem.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
fetchMissingValues. If specified the
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
addUnknownValues - Default value is truepublic java.lang.Boolean getAddUnknownValues()
SelectItem.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 SelectItem.setValueMap() or SelectItem.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 SelectItem.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
fetchMissingValues. If specified the
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.
public void setAllowEmptyValue(java.lang.Boolean allowEmptyValue)
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.
allowEmptyValue - Default value is falsepublic java.lang.Boolean getAllowEmptyValue()
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.
public void setAutoFetchData(java.lang.Boolean autoFetchData)
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
autoFetchData - Default value is truepublic java.lang.Boolean getAutoFetchData()
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.
public void setCachePickListResults(java.lang.Boolean cachePickListResults)
Setting this flag to false avoids this caching for situations where it is too aggressive.
cachePickListResults - Default value is truepublic java.lang.Boolean getCachePickListResults()
Setting this flag to false avoids this caching for situations where it is too aggressive.
public void setCanSelectText(boolean canSelectText)
setCanSelectText in class FormItemcanSelectText - Default value is falsepublic boolean getCanSelectText()
getCanSelectText in class FormItempublic void setControlStyle(java.lang.String controlStyle)
NOTE: See the CompoundFormItem_skinning discussion for special skinning considerations.
setControlStyle in class FormItemcontrolStyle - See FormItemBaseStyle . Default value is "selectItemControl", [IRA]FormItem.setCellStyle(java.lang.String),
Appearance overview and related methodspublic java.lang.String getControlStyle()
NOTE: See the CompoundFormItem_skinning discussion for special skinning considerations.
getControlStyle in class FormItemFormItemBaseStyleFormItem.getCellStyle(),
Appearance overview and related methodspublic void setDefaultToFirstOption(java.lang.Boolean defaultToFirstOption)
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 SelectItem.defaultDynamicValue().
defaultToFirstOption - Default value is falsepublic java.lang.Boolean getDefaultToFirstOption()
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 SelectItem.defaultDynamicValue().
public void setDefaultValue(java.lang.Boolean defaultValue)
defaultToFirstOption instead.setDefaultValue in class FormItemdefaultValue - Default value is nullpublic java.lang.Boolean getDefaultValue()
defaultToFirstOption instead.public void setDisplayField(java.lang.String displayField)
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 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 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.
setDisplayField in interface PickListsetDisplayField in class FormItemdisplayField - Default value is nullFormItem.invalidateDisplayValueCache(),
List - Related Records Examplepublic java.lang.String getDisplayField()
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 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 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.
getDisplayField in interface PickListgetDisplayField in class FormItemdisplayField for this item. This will typically be specified explicitly via the displayField attribute. However, if that property is
unset, and the valueField for this item is
hidden in the optionDataSource, this method
will return the title field for the optionDataSource.FormItem.invalidateDisplayValueCache(),
List - Related Records Examplepublic void setEmptyDisplayValue(java.lang.String emptyDisplayValue)
If the formItem has a databound pickList, and its
displayField or valueField (if the former isn't set) has an undefined
emptyCellValue setting, that field's
emptyCellValue will automatically be set to the emptyDisplayValue.
setEmptyDisplayValue in class FormItememptyDisplayValue - See HTMLString . Default value is " "public java.lang.String getEmptyDisplayValue()
If the formItem has a databound pickList, and its
displayField or valueField (if the former isn't set) has an undefined
emptyCellValue setting, that field's
emptyCellValue will automatically be set to the emptyDisplayValue.
getEmptyDisplayValue in class FormItemHTMLStringpublic void setEscapeHTML(java.lang.Boolean escapeHTML)
"<b>AAA</b>") is
displayed to the user rather than the interpreted HTML (for example "AAA")escapeHTML - Default value is falseAppearance overview and related methodspublic java.lang.Boolean getEscapeHTML()
"<b>AAA</b>") is
displayed to the user rather than the interpreted HTML (for example "AAA")Appearance overview and related methodspublic void setFetchDisplayedFieldsOnly(java.lang.Boolean fetchDisplayedFieldsOnly)
optionDataSource and this property is true, the list of fields
used by this pickList will be passed to the datasource as 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
fetchDisplayedFieldsOnly - Default value is nullpublic java.lang.Boolean getFetchDisplayedFieldsOnly()
optionDataSource and this property is true, the list of fields
used by this pickList will be passed to the datasource as 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.
public void setFilterLocally(java.lang.Boolean filterLocally)
filterLocally is set for this item, and this item is showing options from a dataSource, fetch the
entire set of options from the server, and use these values to map the item value to the appropriate display value. Also
use "local" type filtering on drop down list of options. 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
setFilterLocally in interface PickListsetFilterLocally in class FormItemfilterLocally - Default value is falseFormItem.setFilterLocally(java.lang.Boolean)public java.lang.Boolean getFilterLocally()
filterLocally is set for this item, and this item is showing options from a dataSource, fetch the
entire set of options from the server, and use these values to map the item value to the appropriate display value. Also
use "local" type filtering on drop down list of options. 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.
getFilterLocally in interface PickListgetFilterLocally in class FormItemFormItem.getFilterLocally()public void setMultiple(java.lang.Boolean multiple)
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.
multiple - Default value is falseAppearance overview and related methodspublic java.lang.Boolean getMultiple()
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.
Appearance overview and related methodspublic void setMultipleAppearance(MultipleAppearance multipleAppearance)
multiple set to 'true' be
displayed?multipleAppearance - Default value is "picklist"public MultipleAppearance getMultipleAppearance()
multiple set to 'true' be
displayed?public void setOpenOnDownArrow(java.lang.Boolean openOnDownArrow)
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.
openOnDownArrow - Default value is falsepublic java.lang.Boolean getOpenOnDownArrow()
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.
public void setOpenOnSpace(java.lang.Boolean openOnSpace)
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.
openOnSpace - Default value is falsepublic java.lang.Boolean getOpenOnSpace()
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.
public void setOptionOperationId(java.lang.String optionOperationId)
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.setOptionOperationId in class FormItemoptionOperationId - Default value is nullpublic java.lang.String getOptionOperationId()
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.getOptionOperationId in class FormItempublic void setPickerIconHeight(java.lang.Integer pickerIconHeight)
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
setPickerIconHeight in class FormItempickerIconHeight - Default value is nullpublic java.lang.Integer getPickerIconHeight()
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.
getPickerIconHeight in class FormItempublic void setPickerIconSrc(java.lang.String pickerIconSrc)
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
setPickerIconSrc in class FormItempickerIconSrc - See SCImgURL . Default value is "[SKIN]/DynamicForm/SelectItem_PickButton_icon.gif"public java.lang.String getPickerIconSrc()
showPickerIcon is true for this item,
this property governs the src of the picker icon
image to be displayed.getPickerIconSrc in class FormItemSCImgURLpublic void setPickerIconStyle(java.lang.String pickerIconStyle)
controlStyle.setPickerIconStyle in class FormItempickerIconStyle - See FormItemBaseStyle . Default value is "selectItemPickerIcon"FormItem.setCellStyle(java.lang.String),
Appearance overview and related methodspublic java.lang.String getPickerIconStyle()
controlStyle.getPickerIconStyle in class FormItemFormItemBaseStyleFormItem.getCellStyle(),
Appearance overview and related methodspublic void setPickerIconWidth(java.lang.Integer pickerIconWidth)
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
setPickerIconWidth in class FormItempickerIconWidth - Default value is nullpublic java.lang.Integer getPickerIconWidth()
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.
getPickerIconWidth in class FormItempublic void setPickListCriteria(Criteria pickListCriteria)
Note : This is an advanced setting
setPickListCriteria in interface PickListpickListCriteria - Default value is nullpublic Criteria getPickListCriteria()
getPickListCriteria in interface PickListpublic void setPickListFields(ListGridField... pickListFields)
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 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
pickListFields - Default value is nullsetValueField(java.lang.String),
List - Related Records Examplepublic ListGridField[] getPickListFields()
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 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.
getValueField(),
List - Related Records Examplepublic void setProgressiveLoading(java.lang.Boolean progressiveLoading)
progressively. This property is copied onto the underlying
PickList.progressiveLoading - Default value is nullDataSource.setProgressiveLoading(java.lang.Boolean),
ProgressiveLoading overview and related methodspublic java.lang.Boolean getProgressiveLoading()
progressively. This property is copied onto the underlying
PickList.DataSource.getProgressiveLoading(),
ProgressiveLoading overview and related methodspublic void setSaveOnEnter(java.lang.Boolean saveOnEnter)
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.
setSaveOnEnter in class FormItemsaveOnEnter - Default value is truepublic java.lang.Boolean getSaveOnEnter()
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.
getSaveOnEnter in class FormItempublic void setShowFocused(java.lang.Boolean showFocused)
Note : This is an advanced setting
setShowFocused in class FormItemshowFocused - Default value is true, [IRWA]FormItem.setCellStyle(java.lang.String),
Appearance overview and related methodspublic java.lang.Boolean getShowFocused()
getShowFocused in class FormItemFormItem.getCellStyle(),
Appearance overview and related methodspublic void setShowHintInField(java.lang.Boolean showHintInField)
CSS style for the hint is textBoxStyle with the suffix "Hint" appended to it.
Note : This is an advanced setting
showHintInField - Default value is nullFormItem.setHint(java.lang.String),
Appearance overview and related methodspublic java.lang.Boolean getShowHintInField()
CSS style for the hint is textBoxStyle with the suffix "Hint" appended to it.
FormItem.getHint(),
Appearance overview and related methodspublic void setShowOptionsFromDataSource(java.lang.Boolean showOptionsFromDataSource)
valueMap, by default we show the valueMap
options in the pickList for the item. Setting this property to true will ensure that the options displayed in our
pickList are derived from the form's dataSource.
Note : This is an advanced setting
setShowOptionsFromDataSource in interface PickListshowOptionsFromDataSource - Default value is nullDatabinding overview and related methodspublic java.lang.Boolean getShowOptionsFromDataSource()
valueMap, by default we show the valueMap
options in the pickList for the item. Setting this property to true will ensure that the options displayed in our
pickList are derived from the form's dataSource.getShowOptionsFromDataSource in interface PickListDatabinding overview and related methodspublic void setShowOver(java.lang.Boolean showOver)
Over state?
Note : This is an advanced setting
showOver - Default value is truepublic java.lang.Boolean getShowOver()
Over state?public void setShowPickerIcon(java.lang.Boolean showPickerIcon)
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.setShowPickerIcon in class FormItemshowPickerIcon - Default value is truepublic java.lang.Boolean getShowPickerIcon()
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.getShowPickerIcon in class FormItempublic void setSortField(java.lang.String sortField)
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.sortField - Default value is nullpublic java.lang.String getSortField()
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.public void setSortField(java.lang.Integer sortField)
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.sortField - Default value is nullpublic void setTextBoxStyle(java.lang.String textBoxStyle)
NOTE: See the CompoundFormItem_skinning discussion for special skinning considerations.
setTextBoxStyle in class FormItemtextBoxStyle - See FormItemBaseStyle . Default value is "selectItemText", [IRA]FormItem.setCellStyle(java.lang.String),
Appearance overview and related methodspublic java.lang.String getTextBoxStyle()
NOTE: See the CompoundFormItem_skinning discussion for special skinning considerations.
getTextBoxStyle in class FormItemFormItemBaseStyleFormItem.getCellStyle(),
Appearance overview and related methodspublic void setTextMatchStyle(TextMatchStyle textMatchStyle)
For a databound pickList (optionDataSource set),
textMatchStyle is sent to the server as textMatchStyle.
For a non-databound pickList, textMatchStyle is applied by
filterClientPickListData().
setTextMatchStyle in interface PickListtextMatchStyle - Default value is "startsWith"public TextMatchStyle getTextMatchStyle()
For a databound pickList (optionDataSource set),
textMatchStyle is sent to the server as textMatchStyle.
For a non-databound pickList, textMatchStyle is applied by
filterClientPickListData().
getTextMatchStyle in interface PickListpublic void setUseClientFiltering(java.lang.Boolean useClientFiltering)
databound items, this property will
be passed to the generated ResultSet data object for the pickList as 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
useClientFiltering - Default value is nullpublic java.lang.Boolean getUseClientFiltering()
databound items, this property will
be passed to the generated ResultSet data object for the pickList as useClientFiltering. Setting to false will disable filtering on
the client and ensure criteria are always passed to the DataSource directly.public void setValueField(java.lang.String valueField)
displayField values from an optionDataSource, this property denotes the the
field to use as the underlying data value in records from the optionDataSource.name of this form item.setValueField in interface PickListsetValueField in class FormItemvalueField - Default value is nullpublic java.lang.String getValueField()
displayField values from an optionDataSource, this property denotes the the
field to use as the underlying data value in records from the optionDataSource.name of this form item.getValueField in interface PickListgetValueField in class FormItemvalueField for this
item. If unset, default behavior will return the name
of this field.public com.google.gwt.event.shared.HandlerRegistration addDataArrivedHandler(DataArrivedHandler handler)
If this item is showing a dataBound pickList, this notification method will be fired when new data arrives from the server.
addDataArrivedHandler in interface HasDataArrivedHandlershandler - the dataArrived handlerHandlerRegistration used to remove this handlerpublic void defaultDynamicValue()
defaultValue when no value is provided for this item. To default to the first option use defaultToFirstOption instead.public java.lang.String getDisplayFieldName()
displayField for this item. This will typically be specified explicitly via the displayField attribute. However, if that property is
unset, and the valueField for this item is
hidden in the optionDataSource, this method
will return the title field for the optionDataSource.getDisplayFieldName in interface PickListgetDisplayFieldName in class FormItempublic ListGridRecord[] getSelectedRecords()
optionDataSource
and allowing multiple selection (via
multiple:true), returns the list of currently selected records, or null if none are selected.public java.lang.String getValueFieldName()
valueField for this
item. If unset, default behavior will return the name
of this field.getValueFieldName in interface PickListgetValueFieldName in class FormItemoptionDataSourcepublic void showPicker()
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.
showPicker in class FormItempublic static void setDefaultProperties(SelectItem selectItemProperties)
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.
selectItemProperties - properties that should be used as new defaults when instances of this class are createdprotected Criteria getPickListFilterCriteria()
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).public void setPickListHeight(int pickListHeight)
setPickListHeight in interface PickListpickListHeight - pickListHeight Default value is 300public int getPickListHeight()
getPickListHeight in interface PickListpublic void setEmptyPickListHeight(int emptyPickListHeight)
hideEmptyPickList is false.setEmptyPickListHeight in interface PickListemptyPickListHeight - emptyPickListHeight Default value is 100public int getEmptyPickListHeight()
hideEmptyPickList is false.getEmptyPickListHeight in interface PickListpublic void setEmptyPickListMessage(java.lang.String emptyPickListMessage)
hideEmptyPickList is false. Note : This is an advanced setting
setEmptyPickListMessage in interface PickListemptyPickListMessage - emptyPickListMessage Default value is nullpublic java.lang.String getEmptyPickListMessage()
hideEmptyPickList is false.getEmptyPickListMessage in interface PickListpublic void setHideEmptyPickList(java.lang.Boolean hideEmptyPickList)
setHideEmptyPickList in interface PickListhideEmptyPickList - hideEmptyPickList Default value is nullpublic java.lang.Boolean getHideEmptyPickList()
getHideEmptyPickList in interface PickListpublic void setPickListWidth(java.lang.Integer pickListWidth)
setPickListWidth in interface PickListpickListWidth - pickListWidth Default value is nullpublic java.lang.Integer getPickListWidth()
getPickListWidth in interface PickListpublic void setPickListBaseStyle(java.lang.String pickListBaseStyle)
setPickListBaseStyle in interface PickListpickListBaseStyle - pickListBaseStyle Default value is "pickListCell"public java.lang.String getPickListBaseStyle()
getPickListBaseStyle in interface PickListpublic void setAnimatePickList(java.lang.Boolean animatePickList)
Note : This is an advanced setting
setAnimatePickList in interface PickListanimatePickList - animatePickList Default value is nullpublic java.lang.Boolean getAnimatePickList()
getAnimatePickList in interface PickListpublic void setAnimationTime(int animationTime)
Note : This is an advanced setting
setAnimationTime in interface PickListanimationTime - animationTime Default value is 200public int getAnimationTime()
getAnimationTime in interface PickListpublic void setPickListHeaderHeight(int pickListHeaderHeight)
setPickListHeaderHeight in interface PickListpickListHeaderHeight - pickListHeaderHeight Default value is 22public int getPickListHeaderHeight()
getPickListHeaderHeight in interface PickListpublic java.lang.Integer getSortFieldAsInt()
'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')}.
public void setValueIconField(java.lang.String valueIconField)
valueIcons should show up in for this formItem's pickList.displayField column if specified, otherwise
the valueField column.displayField or valueField will be visible. This property is typically only
required if custom pickListFields
have been specified for this item. Note : This is an advanced setting
setValueIconField in interface PickListvalueIconField - valueIconField Default value is nullpublic java.lang.String getValueIconField()
valueIcons should show up in for this formItem's pickList.displayField column if specified, otherwise
the valueField column.displayField or valueField will be visible. This property is typically only
required if custom pickListFields
have been specified for this item.getValueIconField in interface PickListpublic void setShowAllOptions(java.lang.Boolean showAllOptions)
separatorRows in between. Not valid for optionDataSource.setShowAllOptions in interface PickListshowAllOptions - showAllOptions Default value is nullpublic java.lang.Boolean getShowAllOptions()
separatorRows in between. Not valid for optionDataSource.getShowAllOptions in interface PickListpublic void setPickListCriteria(DSRequest optionFilterContext)
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
optionFilterContext - optionFilterContext Default value is nullpublic void setOptionDataSource(DataSource dataSource)
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
setOptionDataSource in interface PickListsetOptionDataSource in class FormItemoptionDataSource - optionDataSource Default value is nullpublic DataSource getOptionDataSource()
getOptionDataSource in interface PickListpublic void setSeparatorRows(ListGridRecord[] separatorRows)
PickList
Not valid for 'databound pickLists'.
setSeparatorRows in interface PickListseparatorRows - separator rowspublic void setDefaultValues(java.lang.String... defaultValues)
null programmatically, it will be reverted to the defaultValues.defaultValues - the defaultValues. Default value is nullpublic void setDefaultValues(java.lang.Integer... defaultValues)
null programmatically, it will be reverted to the defaultValues.defaultValues - the defaultValues. Default value is nullpublic void setFetchDelay(java.lang.Integer fetchDelay)
PickListsetFetchDelay in interface PickListfetchDelay - the fetch delay. defaults to 200mspublic java.lang.Integer getFetchDelay()
PickListgetFetchDelay in interface PickListpublic java.lang.String[] getValues()
public void setValues(java.lang.String... values)
values - the SelectItem valuespublic java.lang.Boolean isMultiple()
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.
Appearance overview and related methodspublic ListGridRecord[] filterClientPickListData()
PickList
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.
filterClientPickListData in interface PickListpublic ListGridRecord[] getClientPickListData()
PickListThis 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.
getClientPickListData in interface PickListpublic ListGridRecord getSelectedRecord()
getSelectedRecord in class FormItempublic void setPickListFilterCriteriaFunction(FilterCriteriaFunction filterCriteriaFunction)
setPickListFilterCriteriaFunction(FormItemCriteriaFunction)setPickListFilterCriteriaFunction in interface PickListfilterCriteriaFunction - the filter criteria functionpublic void setPickListFilterCriteriaFunction(FormItemCriteriaFunction filterCriteriaFunction)
public void setPickListProperties(ListGrid pickListProperties)
pickListProperties - the pick list propertiespublic void setOptionFilterContext(DSRequest dsRequestProperties)
PickListoptionDataSource, 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
setOptionFilterContext in interface PickListdsRequestProperties - optionFilterContext Default value is nullpublic java.lang.String getValueAsString()
public void setPickListSort(SortSpecifier[] sortSpecifiers)
'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.
sortSpecifiers - Array of SortSpecifier objectspublic void fetchData()
public void fetchData(DSCallback callback)
SelectItem#fetchData()}public void fetchData(DSCallback callback, DSRequest requestProperties)
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.