public class MultiPickerItem extends StaticTextItem
MultiPickerItem is a compact editor for this purpose,
using a pop-up
to present a Shuttle
-style interface for moving records or values being different categories.
When the MultiPickerItem pop-up is not active, MultiPickerItem just displays the currently chosen values as read-only
text, which can be clipped
to appear in a
very small space.
Note: if your use case is a search interface to generate criteria, in either the
FilterEditor of a ListGrid/TreeGrid, or in a SearchForm, SetFilterItem is the right choice. Generally, use
SetFilterItem for searching, and MultiPickerItem (or Shuttle
) for editing.
To configure a MultiPickerItem, provide either an optionDataSource or a valueMap. The value
stored by a MultiPickerItem is the set of selected
items, as either a list of primary key values
if an
optionDataSource is used, or as just ID values if an valueMap is used.
The item's picker-component can be
customized via settings such as sortField
,
or by configuring auto-children
like the search-form
, the main pickList-grid
or the separate list of selected values
. You can use optionFilterContext
to apply custom
requestProperties
to fetches from the main pickList
grid.
FormItem.CustomStateGetter, FormItem.StateCustomizer
configOnly, scClassName, warnOnEditorTypeConversion, warnOnEditorTypeConversionDefault
id
factoryCreated, factoryProperties
Constructor and Description |
---|
MultiPickerItem() |
MultiPickerItem(com.google.gwt.core.client.JavaScriptObject jsObj) |
MultiPickerItem(java.lang.String name) |
Modifier and Type | Method and Description |
---|---|
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) |
java.lang.Boolean |
getCanExpand()
Should we show an
expansionIcon expand
button allowing the user to show an expanded view of the pickList with multiple fields. |
java.lang.Boolean |
getCanSelectFolders()
For multiPickerItems with
selectionStyle:"pickTree" , should the user be
able to select and deselect folders? |
java.lang.Boolean |
getCascadeSelection()
For multiPickerItems with
selectionStyle:"pickTree" , and canSelectFolders:true , should TreeGrid.cascadeSelection be enabled on our pickTree? |
java.lang.String |
getCollapseIconSrc()
SCImgURL for the expansionIcon while in expanded mode |
java.lang.Boolean |
getDeriveUniqueValues()
If this MultiPickerItem is deriving its options from a dataSource, should it ensure unique field values by
grouping by the value field for this item? This is not necessary if the
target dataSource value field is already unique - for example if this is the primaryKey field for a dataSource. |
ToolStripButton |
getDeselectAllButton()
Clear All button
com.smartgwt.client.types.AutoChild |
java.lang.String |
getDeselectAllButtonTitle()
Title for the
deselectAllButton |
java.lang.String |
getDeselectAllWhileFiltered_disabledPrompt()
Disabled prompt for the
deselectAllButton while filtered if selectAllWhileFiltered is set to
"disable" . |
java.lang.String |
getDeselectAllWhileFiltered_partialCachePrompt()
Disabled prompt for the
deselectAllButton while filtered if selectAllWhileFiltered is set to
"whenLoaded" and the PickList does not have a complete data set loaded on the client. |
java.lang.String |
getDisplayField()
If set, this item will display a value from another field to the user instead of showing the underlying data value for
the
field name . |
ListGridField[] |
getExpandedPickListFields()
|
java.lang.String |
getExpandIconSrc()
SCImgURL for the expansionIcon while not in expanded mode |
java.lang.Integer |
getExpansionHeight()
Height for the
pickerLayout in expanded
mode when canExpand is true |
ToolStripButton |
getExpansionIcon()
Automatically generated expand / collapse icon when
canExpand is true |
java.lang.Integer |
getExpansionWidth()
Width for the
pickerLayout in expanded
mode when canExpand is true |
DynamicForm |
getFilterForm()
Dynamic form showing a single text item for filtering the PickList while
SelectionStyle is "pickList". |
java.lang.String |
getFilterHint()
Hint for the filterForm text item. |
FormItemIcon |
getFilterIcon()
Automatically generated right-aligned inline filter indicator icon for the
filterForm text box. |
java.lang.Integer |
getFilterIconHeight()
height for the filterIcon |
java.lang.String |
getFilterIconSrc()
src for the filterIcon |
java.lang.Integer |
getFilterIconWidth()
width for the filterIcon |
boolean |
getFilterPickListOnKeypress()
Should
filterOnKeypress be active for the
pickList? |
java.lang.Boolean |
getIncludeSelectedParents()
For multiPickerItems with
selectionStyle:"pickTree" , and canSelectFolders:true , should selected
parent nodes be included in the item's value? |
SortSpecifier[] |
getInitialSort()
Initial sort specifiers for this item's list of
options. |
java.lang.Boolean |
getMultiple()
MultiPickerItems always work with array values
|
Criteria |
getOptionCriteria()
If this MultiPickerItem is deriving its options from a dataSource, this property allows developers to specify criteria
for the fetch.
|
DataSource |
getOptionDataSource()
If set, this FormItem will map stored values to display values as though a
com.smartgwt.client.types.ValueMap
were specified, by fetching records from the specified optionDataSource and extracting the valueField and displayField in loaded records, to derive one valueMap
entry per record loaded from the optionDataSource. |
DSRequest |
getOptionFilterContext()
If this item has a specified
optionDataSource , and this property is not null, the context is passed to the
dataSource as RPCRequest properties when performing fetch operations on the dataSource
to obtain a data-value to display-value mapping, and when fetching for grid-based pickers. |
java.lang.String |
getOptionOperationId()
If this item has a specified
optionDataSource , this attribute may be set to specify an explicit DSRequest.operationId when performing a fetch against the option
dataSource to pick up display value mapping. |
static MultiPickerItem |
getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj) |
VLayout |
getPickerLayout()
Main dropdown picker layout containing the PickList or
Shuttle . |
HLayout |
getPickerToolbar()
|
ListGrid |
getPickList()
The MultiPickerItem
pickList is a filterable ListGrid com.smartgwt.client.types.AutoChild for
viewing and selecting the list of available options when SelectionStyle is
"pickList" . |
java.lang.Integer |
getPickListFetchDelay()
If
filterPickListOnKeypress
is true, how long to wait in ms after the last keystroke from a user before filtering the pickList. |
java.lang.Integer |
getPickListHeight()
|
java.lang.Integer |
getPickListWidth()
|
TreeGrid |
getPickTree()
The MultiPickerItem
pickTree is a TreeGrid com.smartgwt.client.types.AutoChild for viewing and
selecting a tree of available options when SelectionStyle is "pickTree" . |
ToolStripButton |
getSelectAllButton()
Select All button
com.smartgwt.client.types.AutoChild |
java.lang.String |
getSelectAllButtonTitle()
Title for the
selectAllButton |
java.lang.String |
getSelectAllWhileFiltered_disabledPrompt()
Disabled prompt for the
selectAllButton while filtered if selectAllWhileFiltered is set to
"disable" . |
java.lang.String |
getSelectAllWhileFiltered_partialCachePrompt()
Disabled prompt for the
selectAllButton while filtered if selectAllWhileFiltered is set to
"whenLoaded" and the PickList does not have a complete data set loaded on the client. |
FilteredSelectAllAction |
getSelectAllWhileFiltered()
If the user has filtered the set of options available in this item, how should the "Select All" and "Clear All" buttons
work?
|
java.lang.String |
getSelectedSelectionListTitle()
Default title for the
selectionList . |
ListGrid |
getSelectionList()
Automatically generated ListGrid displaying the current selection for
selectionStyle:"pickList" . |
Label |
getSelectionListLabel()
AutoChild to show the
selectedSelectionListTitle |
MultiPickerSelectionStyle |
getSelectionStyle()
Should the MultiPickerItem use a
Shuttle style interface to indicate the
currently selected / unselected values? |
boolean |
getShowFilterForm()
Should the
filterForm be shown? |
java.lang.Boolean |
getShowSelectionLabel()
|
java.lang.Boolean |
getShowSelectionList()
|
Shuttle |
getShuttle()
|
java.lang.Integer |
getShuttleHeight()
|
java.lang.Integer |
getShuttleWidth()
|
SortDirection |
getSortDirection()
Sort direction for this item's list of options. |
java.lang.String |
getSortField()
Sort field for this item's list of options. |
java.lang.Integer |
getSortFieldAsInt()
Sort field for this item's list of options. |
java.lang.String[] |
getSortFieldAsStringArray()
Sort field for this item's list of options. |
TextMatchStyle |
getTextMatchStyle()
textMatchStyle to apply to
option
criteria for this item |
java.lang.String |
getValueField()
If this form item maps data values to display values by retrieving the
FormItem.displayField values from an optionDataSource , this property denotes the the
field to use as the underlying data value in records from the optionDataSource.If not explicitly supplied, the valueField name will be derived as described in FormItem.getValueFieldName() . |
java.lang.String |
getValueFieldName()
Getter method to retrieve the
FormItem.valueField
for this item. |
MultiPickerItem |
setCanExpand(java.lang.Boolean canExpand)
Should we show an
expansionIcon expand
button allowing the user to show an expanded view of the pickList with multiple fields. |
MultiPickerItem |
setCanSelectFolders(java.lang.Boolean canSelectFolders)
For multiPickerItems with
selectionStyle:"pickTree" , should the user be
able to select and deselect folders? |
MultiPickerItem |
setCascadeSelection(java.lang.Boolean cascadeSelection)
For multiPickerItems with
selectionStyle:"pickTree" , and canSelectFolders:true , should TreeGrid.cascadeSelection be enabled on our pickTree? |
MultiPickerItem |
setCollapseIconSrc(java.lang.String collapseIconSrc)
SCImgURL for the expansionIcon while in expanded mode |
static void |
setDefaultProperties(MultiPickerItem multiPickerItemProperties)
Class level method to set the default properties of this class.
|
MultiPickerItem |
setDeriveUniqueValues(java.lang.Boolean deriveUniqueValues)
If this MultiPickerItem is deriving its options from a dataSource, should it ensure unique field values by
grouping by the value field for this item? This is not necessary if the
target dataSource value field is already unique - for example if this is the primaryKey field for a dataSource. |
MultiPickerItem |
setDeselectAllButtonTitle(java.lang.String deselectAllButtonTitle)
Title for the
deselectAllButton |
MultiPickerItem |
setDeselectAllWhileFiltered_disabledPrompt(java.lang.String deselectAllWhileFiltered_disabledPrompt)
Disabled prompt for the
deselectAllButton while filtered if selectAllWhileFiltered is set to
"disable" . |
MultiPickerItem |
setDeselectAllWhileFiltered_partialCachePrompt(java.lang.String deselectAllWhileFiltered_partialCachePrompt)
Disabled prompt for the
deselectAllButton while filtered if selectAllWhileFiltered is set to
"whenLoaded" and the PickList does not have a complete data set loaded on the client. |
MultiPickerItem |
setDisplayField(java.lang.String displayField)
If set, this item will display a value from another field to the user instead of showing the underlying data value for
the
field name . |
MultiPickerItem |
setExpandedPickListFields(ListGridField... expandedPickListFields)
|
MultiPickerItem |
setExpandIconSrc(java.lang.String expandIconSrc)
SCImgURL for the expansionIcon while not in expanded mode |
MultiPickerItem |
setExpansionHeight(java.lang.Integer expansionHeight)
Height for the
pickerLayout in expanded
mode when canExpand is true |
MultiPickerItem |
setExpansionWidth(java.lang.Integer expansionWidth)
Width for the
pickerLayout in expanded
mode when canExpand is true |
MultiPickerItem |
setFilterHint(java.lang.String filterHint)
Hint for the filterForm text item. |
MultiPickerItem |
setFilterIconHeight(java.lang.Integer filterIconHeight)
height for the filterIcon |
MultiPickerItem |
setFilterIconSrc(java.lang.String filterIconSrc)
src for the filterIcon |
MultiPickerItem |
setFilterIconWidth(java.lang.Integer filterIconWidth)
width for the filterIcon |
MultiPickerItem |
setFilterPickListOnKeypress(boolean filterPickListOnKeypress)
Should
filterOnKeypress be active for the
pickList? |
MultiPickerItem |
setIncludeSelectedParents(java.lang.Boolean includeSelectedParents)
For multiPickerItems with
selectionStyle:"pickTree" , and canSelectFolders:true , should selected
parent nodes be included in the item's value? |
MultiPickerItem |
setInitialSort(SortSpecifier... initialSort)
Initial sort specifiers for this item's list of
options. |
MultiPickerItem |
setMultiple(java.lang.Boolean multiple)
MultiPickerItems always work with array values
|
void |
setOptionCriteria(Criteria optionCriteria)
If this MultiPickerItem is deriving its options from a dataSource, this property allows developers to specify criteria
for the fetch.
|
MultiPickerItem |
setOptionDataSource(DataSource optionDataSource)
If set, this FormItem will map stored values to display values as though a
com.smartgwt.client.types.ValueMap
were specified, by fetching records from the specified optionDataSource and extracting the valueField and displayField in loaded records, to derive one valueMap
entry per record loaded from the optionDataSource. |
MultiPickerItem |
setOptionFilterContext(DSRequest optionFilterContext)
If this item has a specified
optionDataSource , and this property is not null, the context is passed to the
dataSource as RPCRequest properties when performing fetch operations on the dataSource
to obtain a data-value to display-value mapping, and when fetching for grid-based pickers. |
MultiPickerItem |
setOptionOperationId(java.lang.String optionOperationId)
If this item has a specified
optionDataSource , this attribute may be set to specify an explicit DSRequest.operationId when performing a fetch against the option
dataSource to pick up display value mapping. |
MultiPickerItem |
setPickListFetchDelay(java.lang.Integer pickListFetchDelay)
If
filterPickListOnKeypress
is true, how long to wait in ms after the last keystroke from a user before filtering the pickList. |
MultiPickerItem |
setPickListHeight(java.lang.Integer pickListHeight)
|
MultiPickerItem |
setPickListWidth(java.lang.Integer pickListWidth)
|
MultiPickerItem |
setSelectAllButtonTitle(java.lang.String selectAllButtonTitle)
Title for the
selectAllButton |
MultiPickerItem |
setSelectAllWhileFiltered_disabledPrompt(java.lang.String selectAllWhileFiltered_disabledPrompt)
Disabled prompt for the
selectAllButton while filtered if selectAllWhileFiltered is set to
"disable" . |
MultiPickerItem |
setSelectAllWhileFiltered_partialCachePrompt(java.lang.String selectAllWhileFiltered_partialCachePrompt)
Disabled prompt for the
selectAllButton while filtered if selectAllWhileFiltered is set to
"whenLoaded" and the PickList does not have a complete data set loaded on the client. |
MultiPickerItem |
setSelectAllWhileFiltered(FilteredSelectAllAction selectAllWhileFiltered)
If the user has filtered the set of options available in this item, how should the "Select All" and "Clear All" buttons
work?
|
MultiPickerItem |
setSelectedSelectionListTitle(java.lang.String selectedSelectionListTitle)
Default title for the
selectionList . |
MultiPickerItem |
setSelectionStyle(MultiPickerSelectionStyle selectionStyle)
Should the MultiPickerItem use a
Shuttle style interface to indicate the
currently selected / unselected values? |
MultiPickerItem |
setShowFilterForm(boolean showFilterForm)
Should the
filterForm be shown? |
MultiPickerItem |
setShowSelectionLabel(java.lang.Boolean showSelectionLabel)
|
MultiPickerItem |
setShowSelectionList(java.lang.Boolean showSelectionList)
|
MultiPickerItem |
setShuttleHeight(java.lang.Integer shuttleHeight)
|
MultiPickerItem |
setShuttleWidth(java.lang.Integer shuttleWidth)
|
MultiPickerItem |
setSortDirection(SortDirection sortDirection)
Sort direction for this item's list of options. |
MultiPickerItem |
setSortField(java.lang.Integer sortField)
Sort field for this item's list of options. |
MultiPickerItem |
setSortField(java.lang.String... sortField)
Sort field for this item's list of options. |
MultiPickerItem |
setSortField(java.lang.String sortField)
Sort field for this item's list of options. |
MultiPickerItem |
setTextMatchStyle(TextMatchStyle textMatchStyle)
textMatchStyle to apply to
option
criteria for this item |
MultiPickerItem |
setValueField(java.lang.String valueField)
If this form item maps data values to display values by retrieving the
FormItem.displayField values from an optionDataSource , this property denotes the the
field to use as the underlying data value in records from the optionDataSource.If not explicitly supplied, the valueField name will be derived as described in FormItem.getValueFieldName() . |
getApplyAlignToText, getApplyHeightToTextBox, getCanSelectText, getClipValue, getDateFormatter, getDefaultValue, getEditProxyConstructor, getEscapeHTML, getTextBoxStyle, getWrap, setApplyAlignToText, setApplyHeightToTextBox, setCanSelectText, setClipValue, setDateFormatter, setDefaultProperties, setEditProxyConstructor, setEscapeHTML, setTextBoxStyle, setWrap
_getValue, addBlurHandler, addChangedHandler, addChangeHandler, addClickHandler, addDoubleClickHandler, addEditorEnterHandler, addEditorExitHandler, addFocusHandler, addIcon, addIcon, addIconClickHandler, addIconKeyPressHandler, addItemHoverHandler, addKeyDownHandler, addKeyPressHandler, addKeyUpHandler, addPendingStatusChangedHandler, addPickerIconClickHandler, addShowContextMenuHandler, addTitleClickHandler, addTitleDoubleClickHandler, addTitleHoverHandler, addValueHoverHandler, addValueIconClickHandler, applyFormula, asSGWTComponent, blurItem, canEditCriterion, checkFormItemType, clearErrors, clearValue, disable, disableIcon, enable, enableIcon, error, error, errorIfNotCreated, focusAfterItem, focusInItem, getAccessKey, getAlign, getAllowExpressions, getAlwaysFetchMissingValues, getAlwaysShowControlBox, getAriaRole, getAttribute, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsFloat, getAttributeAsInt, getAttributeAsJavaScriptObject, getAttributeAsObject, getAttributeAsString, getAutoComplete, getAutoCompleteKeywords, getBrowserInputType, getBrowserSpellCheck, getCanEdit, getCanEditOpaqueValues, getCanFocus, getCanHover, getCanTabToIcons, getCanvasAutoChild, getCellHeight, getCellStyle, getChangeOnKeypress, getClassName, getClipStaticValue, getClipTitle, getConfig, getContainerWidget, getControlStyle, getCriteriaField, getCriterion, getCriterion, getCursorPosition, getCustomState, getDataPath, getDecimalPad, getDecimalPrecision, getDefaultIconSrc, getDefaultOperator, getDestroyed, getDisabled, getDisabledHover, getDisableIconsOnReadOnly, getDisplayFieldName, getDisplayValue, getDisplayValue, getEditorTypeConfig, getEditPendingCSSText, getEmptyDisplayValue, getEmptyValueIcon, getEndRow, getErrorIconHeight, getErrorIconProperties, getErrorIconSrc, getErrorIconWidth, getErrorMessageWidth, getErrors, getExportFormat, getFetchMissingValues, getFieldName, getFilterLocally, getForeignDisplayField, getForm, getFormat, getFormItemAutoChild, getFormula, getFullDataPath, getGlobalTabIndex, getGridColNum, getGridRowNum, getHeight, getHeightAsString, getHidden, getHint, getHintStyle, getHoverAlign, getHoverDelay, getHoverFocusKey, getHoverHeight, getHoverHeightAsString, getHoverOpacity, getHoverPersist, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWidthAsString, getIcon, getIconBaseStyle, getIconHeight, getIconHSpace, getIconPageRect, getIconPrompt, getIconRect, getIcons, getIconTabPosition, getIconVAlign, getIconWidth, getID, getImageURLPrefix, getImageURLSuffix, getImplicitSave, getImplicitSaveOnBlur, getInputFormat, getLeft, getLinearColSpan, getLinearColSpanAsString, getLinearEndRow, getLinearEndRowAsString, getLinearStartRow, getLinearStartRowAsString, getLinearWidth, getLinearWidthAsString, getListGrid, getLoadingDisplayValue, getLocateItemBy, getMinHintWidth, getMultipleValueSeparator, getName, getNullOriginalValueText, getOperator, getOptionDataSourceAsString, getOptionTextMatchStyle, getOriginalValueMessage, getPageLeft, getPageRect, getPageTop, getPaletteDefaults, getPicker, getPickerIcon, getPickerIcon, getPickerIconHeight, getPickerIconName, getPickerIconPrompt, getPickerIconProperties, getPickerIconSrc, getPickerIconStyle, getPickerIconTabPosition, getPickerIconWidth, getPixelHeight, getPixelWidth, getPrintReadOnlyTextBoxStyle, getPrintTextBoxStyle, getPrintTitleStyle, getPrompt, getReadOnlyCanSelectText, getReadOnlyDisplay, getReadOnlyHover, getReadOnlyTextBoxStyle, getReadOnlyWhen, getRect, getRedrawOnChange, getRejectInvalidValueOnChange, getRequired, getRequiredMessage, getRequiredWhen, getRowSpan, getSaveOnEnter, getScClassName, getSelectedRecord, getSelectOnClick, getSelectOnFocus, getShouldSaveValue, getShowClippedTitleOnHover, getShowClippedValueOnHover, getShowDeletions, getShowDisabled, getShowDisabledIconsOnFocus, getShowDisabledPickerIconOnFocus, getShowErrorIcon, getShowErrorIconInline, getShowErrorStyle, getShowErrorText, getShowFocused, getShowFocusedErrorState, getShowFocusedIcons, getShowFocusedPickerIcon, getShowHint, getShowIcons, getShowIconsOnFocus, getShowImageAsURL, getShowOldValueInHover, getShowOver, getShowOverIcons, getShowPending, getShowPickerIcon, getShowPickerIconOnFocus, getShowRTL, getShowTitle, getShowValueIconOnly, getStartRow, getStaticHeight, getStopOnError, getStoreDisplayValues, getSupportsCutPasteEvents, getSuppressValueIcon, getSynchronousValidation, getTabIndex, getTextAlign, getTextFormula, getTimeFormatter, getTitle, getTitleAlign, getTitleColSpan, getTitleOrientation, getTitleStyle, getTitleVAlign, getTooltip, getTop, getType, getUpdateControlOnOver, getUpdatePickerIconOnOver, getUpdateTextBoxOnOver, getUseAdvancedCriteria, getUseDisabledHintStyleForReadOnly, getUseLocalDisplayFieldValue, getValidateOnChange, getValidateOnExit, getValidOperators, getVAlign, getValue, getValueAsFloat, getValueAsInteger, getValueAsLong, getValueAsRecordList, getValueDeselectedCSSText, getValueIconHeight, getValueIconLeftPadding, getValueIconRightPadding, getValueIconSize, getValueIconWidth, getValueMap, getValueMapAsArray, getVisible, getVisibleHeight, getVisibleTitleWidth, getVisibleWhen, getVisibleWidth, getWarnOnEditorTypeConversion, getWarnOnEditorTypeConversionDefault, getWidth, getWidthAsString, getWrapHintText, getWrapTitle, handleWarnOnEditorTypeConversion, hasAdvancedCriteria, hasErrors, hide, hideIcon, invalidateDisplayValueCache, isAssignableFrom, isConfigOnly, isCreated, isCutEvent, isDisabled, isDrawn, isFocused, isInGrid, isPasteEvent, isVisible, linkToInstanceUponCreate, mapDisplayToValue, mapValueToDisplay, mapValueToDisplay, mapValueToDisplay, redraw, redraw, removeIcon, selectedRecordChanged, setAccessKey, setAlign, setAllowExpressions, setAlwaysFetchMissingValues, setAlwaysShowControlBox, setAriaRole, setAriaState, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAutoChildConstructor, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildVisibility, setAutoComplete, setAutoCompleteKeywords, setBrowserInputType, setBrowserSpellCheck, setCanEdit, setCanEditCriterionPredicate, setCanEditOpaqueValues, setCanFocus, setCanHover, setCanTabToIcons, setCellHeight, setCellStyle, setChangeOnKeypress, setClipStaticValue, setClipTitle, setColSpan, setColSpan, setConfigOnly, setControlStyle, setCriteriaField, setCriterion, setCriterionGetter, setCriterionSetter, setCustomStateGetter, setDataPath, setDecimalPad, setDecimalPrecision, setDefaultIconSrc, setDefaultOperator, setDefaultProperties, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDisabled, setDisabledHover, setDisableIconsOnReadOnly, setDisplayFormat, setDisplayFormat, setEditorProperties, setEditorType, setEditorType, setEditorType, setEditorValueFormatter, setEditorValueParser, setEditPendingCSSText, setEmptyDisplayValue, setEmptyValueIcon, setEndRow, setErrorFormatter, setErrorIconHeight, setErrorIconProperties, setErrorIconSrc, setErrorIconWidth, setErrorMessageWidth, setErrorOrientation, setErrors, setErrors, setExportFormat, setFetchMissingValues, setFilterLocally, setForeignDisplayField, setFormat, setFormula, setGlobalTabIndex, setHeight, setHeight, setHidden, setHint, setHintStyle, setHoverAlign, setHoverDelay, setHoverFocusKey, setHoverHeight, setHoverHeight, setHoverOpacity, setHoverPersist, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWidth, setIconBaseStyle, setIconDisabled, setIconHeight, setIconHSpace, setIconPrompt, setIcons, setIconShowOnFocus, setIconVAlign, setIconWidth, setID, setImageURLPrefix, setImageURLSuffix, setImplicitSave, setImplicitSaveOnBlur, setInitHandler, setInputFormat, setInputTransformer, setItemHoverFormatter, setItemTitleHoverFormatter, setItemValueHoverFormatter, setJavaScriptObject, setLeft, setLinearColSpan, setLinearColSpan, setLinearEndRow, setLinearEndRow, setLinearStartRow, setLinearStartRow, setLinearWidth, setLinearWidth, setLoadingDisplayValue, setLocateItemBy, setMinHintWidth, setMultipleValueSeparator, setName, setNullOriginalValueText, setNullProperty, setOperator, setOptionDataSource, setOptionFilterContext, setOptionTextMatchStyle, setOriginalValueMessage, setPickerIconHeight, setPickerIconName, setPickerIconPrompt, setPickerIconProperties, setPickerIconSrc, setPickerIconStyle, setPickerIconWidth, setPrintReadOnlyTextBoxStyle, setPrintTextBoxStyle, setPrintTitleStyle, setPrompt, setProperty, setProperty, setProperty, setProperty, setProperty, setReadOnlyCanSelectText, setReadOnlyDisplay, setReadOnlyHover, setReadOnlyTextBoxStyle, setReadOnlyWhen, setRedrawOnChange, setRejectInvalidValueOnChange, setRequired, setRequiredMessage, setRequiredWhen, setRowSpan, setSaveOnEnter, setScClassName, setSelectOnClick, setSelectOnFocus, setShouldSaveValue, setShowClippedTitleOnHover, setShowClippedValueOnHover, setShowDeletions, setShowDisabled, setShowDisabledIconsOnFocus, setShowDisabledPickerIconOnFocus, setShowErrorIcon, setShowErrorIconInline, setShowErrorStyle, setShowErrorText, setShowFocused, setShowFocusedErrorState, setShowFocusedIcons, setShowFocusedPickerIcon, setShowHint, setShowIcons, setShowIconsOnFocus, setShowIfCondition, setShowImageAsURL, setShowOldValueInHover, setShowOver, setShowOverIcons, setShowPending, setShowPickerIcon, setShowPickerIconOnFocus, setShowRTL, setShowTitle, setShowValueIconOnly, setStartRow, setStateCustomizer, setStaticHeight, setStopOnError, setStoreDisplayValues, setSupportsCutPasteEvents, setSuppressValueIcon, setSynchronousValidation, setTabIndex, setTextAlign, setTextFormula, setTimeFormatter, setTitle, setTitleAlign, setTitleColSpan, setTitleHoverFormatter, setTitleOrientation, setTitleStyle, setTitleVAlign, setTooltip, setTop, setType, setUpdateControlOnOver, setUpdatePickerIconOnOver, setUpdateTextBoxOnOver, setUseAdvancedCriteria, setUseDisabledHintStyleForReadOnly, setUseLocalDisplayFieldValue, setUseObjectFactoryForTypeFallback, setValidateOnChange, setValidateOnExit, setValidators, setValidOperators, setVAlign, setValue, setValue, setValue, setValue, setValue, setValue, setValueDeselectedCSSText, setValueFormatter, setValueHoverFormatter, setValueIconHeight, setValueIconLeftPadding, setValueIconMapper, setValueIconRightPadding, setValueIcons, setValueIconSize, setValueIconWidth, setValueMap, setValueMap, setVisible, setVisibleWhen, setWarnOnEditorTypeConversion, setWarnOnEditorTypeConversionDefault, setWidth, setWidth, setWrapHintText, setWrapTitle, shouldApplyHeightToTextBox, shouldFetchMissingValue, shouldSaveOnEnter, shouldStopKeyPressBubbling, show, showIcon, showPicker, stopHover, storeValue, storeValue, updateState, validate, valueClipped
getRef, getRef, internalSetID
applyFactoryProperties, doAddHandler, fireEvent, getAttributeAsDoubleArray, getAttributeAsElement, getAttributeAsIntArray, getAttributeAsLong, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsStringArray, getAttributes, getHandlerCount, isFactoryCreated, setAttribute, setAttribute, setAttribute, setAttributeAsJavaObject, setFactoryCreated
public MultiPickerItem()
public MultiPickerItem(com.google.gwt.core.client.JavaScriptObject jsObj)
public MultiPickerItem(java.lang.String name)
public static MultiPickerItem 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. For usage tips on this
param, see SGWTProperties
.AutoChildUsage
public 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. For usage tips on this
param, see SGWTProperties
.AutoChildUsage
public static void changePickerIconDefaults(FormItemIcon defaults)
public MultiPickerItem setCanExpand(java.lang.Boolean canExpand)
expansionIcon
expand
button allowing the user to show an expanded view of the pickList
with multiple fields.
canExpand
only applies to MultiPickerItems with selectionStyle set to "pickList" or "pickTree" and an
explicitly specified set of expandedPickListFields
to display within the expanded view.
canExpand
- New canExpand value. Default value is trueMultiPickerItem
instance, for chaining setter callspublic java.lang.Boolean getCanExpand()
expansionIcon
expand
button allowing the user to show an expanded view of the pickList
with multiple fields.
canExpand
only applies to MultiPickerItems with selectionStyle set to "pickList" or "pickTree" and an
explicitly specified set of expandedPickListFields
to display within the expanded view.
public MultiPickerItem setCanSelectFolders(java.lang.Boolean canSelectFolders)
selectionStyle:"pickTree"
, should the user be
able to select and deselect folders? If false, selection checkboxes will only be visible by leaf nodes within the pickTree data set.
Note that this flag may be set to true in conjunction with includeSelectedParents:false
. In this
case the user may check and uncheck parent nodes as a convenient way to select or unselect all their children due to
cascading selection
, but the parent
nodes themselves won't be present in the item's value.
canSelectFolders
- New canSelectFolders value. Default value is trueMultiPickerItem
instance, for chaining setter callspublic java.lang.Boolean getCanSelectFolders()
selectionStyle:"pickTree"
, should the user be
able to select and deselect folders? If false, selection checkboxes will only be visible by leaf nodes within the pickTree data set.
Note that this flag may be set to true in conjunction with includeSelectedParents:false
. In this
case the user may check and uncheck parent nodes as a convenient way to select or unselect all their children due to
cascading selection
, but the parent
nodes themselves won't be present in the item's value.
public MultiPickerItem setCascadeSelection(java.lang.Boolean cascadeSelection)
selectionStyle:"pickTree"
, and canSelectFolders:true
, should TreeGrid.cascadeSelection
be enabled on our pickTree?cascadeSelection
- New cascadeSelection value. Default value is trueMultiPickerItem
instance, for chaining setter callspublic java.lang.Boolean getCascadeSelection()
selectionStyle:"pickTree"
, and canSelectFolders:true
, should TreeGrid.cascadeSelection
be enabled on our pickTree?public MultiPickerItem setCollapseIconSrc(java.lang.String collapseIconSrc)
SCImgURL
for the expansionIcon
while in expanded modecollapseIconSrc
- New collapseIconSrc value. Default value is "[SKINIMG]/actions/collapse_left.png"MultiPickerItem
instance, for chaining setter callspublic java.lang.String getCollapseIconSrc()
SCImgURL
for the expansionIcon
while in expanded modepublic MultiPickerItem setDeriveUniqueValues(java.lang.Boolean deriveUniqueValues)
grouping by
the value field for this item? This is not necessary if the
target dataSource value field is already unique - for example if this is the primaryKey field for a dataSource. Note
that for MultiPickerItems with deriveUniqueValues:true
, any expandedPickListFields
to be
displayed in the expanded view
will not be
able to display meaningful values unless a summaryFunction
is supplied to produce aggregated values from the grouped data. This may be achieved by specifying
summaryFunctions directly on the optionFilterContext
, or on the operationBinding
for
the fetch operation
.
Note : This is an advanced setting
deriveUniqueValues
- New deriveUniqueValues value. Default value is falseMultiPickerItem
instance, for chaining setter callspublic java.lang.Boolean getDeriveUniqueValues()
grouping by
the value field for this item? This is not necessary if the
target dataSource value field is already unique - for example if this is the primaryKey field for a dataSource. Note
that for MultiPickerItems with deriveUniqueValues:true
, any expandedPickListFields
to be
displayed in the expanded view
will not be
able to display meaningful values unless a summaryFunction
is supplied to produce aggregated values from the grouped data. This may be achieved by specifying
summaryFunctions directly on the optionFilterContext
, or on the operationBinding
for
the fetch operation
.
public ToolStripButton getDeselectAllButton()
com.smartgwt.client.types.AutoChild
This component is an AutoChild named "deselectAllButton". For an overview of how to use and
configure AutoChildren, see Using AutoChildren
.
public MultiPickerItem setDeselectAllButtonTitle(java.lang.String deselectAllButtonTitle)
deselectAllButton
deselectAllButtonTitle
- New deselectAllButtonTitle value. Default value is "Clear All"MultiPickerItem
instance, for chaining setter callspublic java.lang.String getDeselectAllButtonTitle()
deselectAllButton
public MultiPickerItem setDeselectAllWhileFiltered_disabledPrompt(java.lang.String deselectAllWhileFiltered_disabledPrompt)
deselectAllButton
while filtered if selectAllWhileFiltered
is set to
"disable"
.deselectAllWhileFiltered_disabledPrompt
- New deselectAllWhileFiltered_disabledPrompt value. Default value is "Clear All disabled while filtered"MultiPickerItem
instance, for chaining setter callspublic java.lang.String getDeselectAllWhileFiltered_disabledPrompt()
deselectAllButton
while filtered if selectAllWhileFiltered
is set to
"disable"
.public MultiPickerItem setDeselectAllWhileFiltered_partialCachePrompt(java.lang.String deselectAllWhileFiltered_partialCachePrompt)
deselectAllButton
while filtered if selectAllWhileFiltered
is set to
"whenLoaded"
and the PickList does not have a complete data set loaded on the client.deselectAllWhileFiltered_partialCachePrompt
- New deselectAllWhileFiltered_partialCachePrompt value. Default value is "Unable to Clear All as the full set of options has not been fetched from the server."MultiPickerItem
instance, for chaining setter callspublic java.lang.String getDeselectAllWhileFiltered_partialCachePrompt()
deselectAllButton
while filtered if selectAllWhileFiltered
is set to
"whenLoaded"
and the PickList does not have a complete data set loaded on the client.public MultiPickerItem setDisplayField(java.lang.String displayField)
field name
. This property is used in two ways:
The item will display the displayField value from the record currently being edited
if FormItem.useLocalDisplayFieldValue
is true, (or if unset and the conditions outlined in the documentation for that
property are met).
If this field has an FormItem.optionDataSource
, this property is used by default to identify which value to use as a display value in
records from this related dataSource. In this usage the specified displayField must be explicitly defined in the
optionDataSource to be used - see getDisplayFieldName()
for more on this behavior.
If not using local display values
, the display value
for this item will be derived by performing a fetch against the option dataSource
to find a record where the
value field
matches this item's value, and
use the displayField
value from that record.
In addition to this, PickList-based form items that
provide a list of possible options such as the SelectItem
or ComboBoxItem
will show the displayField
values to the user by
default, allowing them to choose a new data value (see FormItem.valueField
) from a list of user-friendly
display values.
This essentially allows the specified optionDataSource
to be used as a server based
valueMap
.
If local
display values
are being used and FormItem.storeDisplayValues
is true, selecting a new value will update both the value for this field and the associated
display-field value on the record being edited.
Note: Developers may specify the FormItem.foreignDisplayField
property in
addition to displayField
. This is useful for cases where the display field name in the local dataSource
differs from the display field name in the optionDataSource. See the documentation for DataSourceField.foreignDisplayField
for more on
this.
If a foreignDisplayField is specified, as with just displayField, if local display values
are being used and
FormItem.storeDisplayValues
is true, when
the user chooses a value the associated display-field value on the record being edited will be updated. In this case
it would be set to the foreignDisplayField value from the related record. This means foreignDisplayField is always
expected to be set to the equivalent field in the related dataSources.
Developers looking to display some
other arbitrary field(s) from the related dataSource during editing should consider using custom
PickList.pickListFields instead of setting a foreignDisplayField.
Note that if optionDataSource
is set
and no valid display field is specified, FormItem.getDisplayFieldName()
will return the dataSource title field by default.
If a displayField is specified
for a freeform text based item (such as a ComboBoxItem
), any
user-entered value will be treated as a display value. In this scenario, items will derive the data value for the item
from the first record where the displayField value matches the user-entered value. To avoid ambiguity, developers may
wish to avoid this usage if display values are not unique.
setDisplayField
in class FormItem
displayField
- New displayField value. Default value is nullMultiPickerItem
instance, for chaining setter callsFormItem.getDisplayFieldName()
,
FormItem.invalidateDisplayValueCache()
,
DataBinding
public java.lang.String getDisplayField()
field name
. This property is used in two ways:
The item will display the displayField value from the record currently being edited
if FormItem.useLocalDisplayFieldValue
is true, (or if unset and the conditions outlined in the documentation for that
property are met).
If this field has an FormItem.optionDataSource
, this property is used by default to identify which value to use as a display value in
records from this related dataSource. In this usage the specified displayField must be explicitly defined in the
optionDataSource to be used - see getDisplayFieldName()
for more on this behavior.
If not using local display values
, the display value
for this item will be derived by performing a fetch against the option dataSource
to find a record where the
value field
matches this item's value, and
use the displayField
value from that record.
In addition to this, PickList-based form items that
provide a list of possible options such as the SelectItem
or ComboBoxItem
will show the displayField
values to the user by
default, allowing them to choose a new data value (see FormItem.valueField
) from a list of user-friendly
display values.
This essentially allows the specified optionDataSource
to be used as a server based
valueMap
.
If local
display values
are being used and FormItem.storeDisplayValues
is true, selecting a new value will update both the value for this field and the associated
display-field value on the record being edited.
Note: Developers may specify the FormItem.foreignDisplayField
property in
addition to displayField
. This is useful for cases where the display field name in the local dataSource
differs from the display field name in the optionDataSource. See the documentation for DataSourceField.foreignDisplayField
for more on
this.
If a foreignDisplayField is specified, as with just displayField, if local display values
are being used and
FormItem.storeDisplayValues
is true, when
the user chooses a value the associated display-field value on the record being edited will be updated. In this case
it would be set to the foreignDisplayField value from the related record. This means foreignDisplayField is always
expected to be set to the equivalent field in the related dataSources.
Developers looking to display some
other arbitrary field(s) from the related dataSource during editing should consider using custom
PickList.pickListFields instead of setting a foreignDisplayField.
Note that if optionDataSource
is set
and no valid display field is specified, FormItem.getDisplayFieldName()
will return the dataSource title field by default.
If a displayField is specified
for a freeform text based item (such as a ComboBoxItem
), any
user-entered value will be treated as a display value. In this scenario, items will derive the data value for the item
from the first record where the displayField value matches the user-entered value. To avoid ambiguity, developers may
wish to avoid this usage if display values are not unique.
getDisplayField
in class FormItem
FormItem.getDisplayFieldName()
,
FormItem.invalidateDisplayValueCache()
,
DataBinding
public MultiPickerItem setExpandedPickListFields(ListGridField... expandedPickListFields)
canExpand
is true, this is the list of
fields to display in the PickList or pickTree
when the picker is expandedexpandedPickListFields
- New expandedPickListFields value. Default value is nullMultiPickerItem
instance, for chaining setter callspublic ListGridField[] getExpandedPickListFields()
canExpand
is true, this is the list of
fields to display in the PickList or pickTree
when the picker is expandedpublic MultiPickerItem setExpandIconSrc(java.lang.String expandIconSrc)
SCImgURL
for the expansionIcon
while not in expanded modeexpandIconSrc
- New expandIconSrc value. Default value is "[SKINIMG]/actions/expand_right.png"MultiPickerItem
instance, for chaining setter callspublic java.lang.String getExpandIconSrc()
SCImgURL
for the expansionIcon
while not in expanded modepublic MultiPickerItem setExpansionHeight(java.lang.Integer expansionHeight)
pickerLayout
in expanded
mode when canExpand
is trueexpansionHeight
- New expansionHeight value. Default value is 500MultiPickerItem
instance, for chaining setter callspublic java.lang.Integer getExpansionHeight()
pickerLayout
in expanded
mode when canExpand
is truepublic ToolStripButton getExpansionIcon()
canExpand
is true
This component is an AutoChild named "expansionIcon". For an overview of how to use and
configure AutoChildren, see Using AutoChildren
.
public MultiPickerItem setExpansionWidth(java.lang.Integer expansionWidth)
pickerLayout
in expanded
mode when canExpand
is trueexpansionWidth
- New expansionWidth value. Default value is 500MultiPickerItem
instance, for chaining setter callspublic java.lang.Integer getExpansionWidth()
pickerLayout
in expanded
mode when canExpand
is truepublic DynamicForm getFilterForm()
SelectionStyle
is "pickList". May be hidden by setting showFilterForm
to false.
If canExpand
is true, the filter form will not be
displayed in the expanded view, as it would be unclear to the user which of the expanded fields would be filtered by it.
Instead if showFilterForm
is true, the pickList will show the filterEditor
by default, allowing the user to filter by
field
Instead of the
filterForm, developers may display the standard filterEditor for the pickList in non-expanded view via pickList autoChild properties
. If you do this the filterForm will not be
displayed even ifshowFilterForm
is true.
This component is an AutoChild named "filterForm". For an overview of how to use and
configure AutoChildren, see Using AutoChildren
.
public MultiPickerItem setFilterHint(java.lang.String filterHint)
filterHint
- New filterHint value. Default value is "Filter"MultiPickerItem
instance, for chaining setter callspublic java.lang.String getFilterHint()
public FormItemIcon getFilterIcon()
filterForm
text box. This icon may be
customized using the standard AutoChild pattern as well as via filterIconSrc
, filterIconWidth
, filterIconHeight
This component is an AutoChild named "filterIcon". For an overview of how to use and
configure AutoChildren, see Using AutoChildren
.
public MultiPickerItem setFilterIconHeight(java.lang.Integer filterIconHeight)
height
for the filterIcon
filterIconHeight
- New filterIconHeight value. Default value is 16MultiPickerItem
instance, for chaining setter callspublic java.lang.Integer getFilterIconHeight()
height
for the filterIcon
public MultiPickerItem setFilterIconSrc(java.lang.String filterIconSrc)
src
for the filterIcon
filterIconSrc
- New filterIconSrc value. Default value is "[SKINIMG]actions/view.png"MultiPickerItem
instance, for chaining setter callspublic java.lang.String getFilterIconSrc()
src
for the filterIcon
public MultiPickerItem setFilterIconWidth(java.lang.Integer filterIconWidth)
width
for the filterIcon
filterIconWidth
- New filterIconWidth value. Default value is 16MultiPickerItem
instance, for chaining setter callspublic java.lang.Integer getFilterIconWidth()
width
for the filterIcon
public MultiPickerItem setFilterPickListOnKeypress(boolean filterPickListOnKeypress)
filterOnKeypress
be active for the
pickList? This behavior applies to filter values entered in the filterForm
as well as the the standard
filterEditor for the picklist in expanded
view
.
filterPickListOnKeypress
- New filterPickListOnKeypress value. Default value is trueMultiPickerItem
instance, for chaining setter callspublic boolean getFilterPickListOnKeypress()
filterOnKeypress
be active for the
pickList? This behavior applies to filter values entered in the filterForm
as well as the the standard
filterEditor for the picklist in expanded
view
.
public MultiPickerItem setIncludeSelectedParents(java.lang.Boolean includeSelectedParents)
selectionStyle:"pickTree"
, and canSelectFolders:true
, should selected
parent nodes be included in the item's value? When cascading selection
is enabled for a tree,
the selected state of parent nodes always reflects the selected state of their children, and it may not be necessary or
desirable to explictly record the parents' selected state in the item's value.
Some specific use cases where this is the case might include:
TreeGrid.keepParentsOnFilter
is true. In this case
filter criteria would not need to include selected parent nodes for the children to be visible in the target
tree.cascading selection
may be useful to allow the user to easily select all items within a category but application
code may not want to include the categories as part of a MultiPickerItem's value This property only
applies when cascadeSelection
is
true. If cascadeSelection is false, all selected nodes will be present in the items value regardless of their
parent/child relationships.
includeSelectedParents
- New includeSelectedParents value. Default value is falseMultiPickerItem
instance, for chaining setter callspublic java.lang.Boolean getIncludeSelectedParents()
selectionStyle:"pickTree"
, and canSelectFolders:true
, should selected
parent nodes be included in the item's value? When cascading selection
is enabled for a tree,
the selected state of parent nodes always reflects the selected state of their children, and it may not be necessary or
desirable to explictly record the parents' selected state in the item's value.
Some specific use cases where this is the case might include:
TreeGrid.keepParentsOnFilter
is true. In this case
filter criteria would not need to include selected parent nodes for the children to be visible in the target
tree.cascading selection
may be useful to allow the user to easily select all items within a category but application
code may not want to include the categories as part of a MultiPickerItem's value This property only
applies when cascadeSelection
is
true. If cascadeSelection is false, all selected nodes will be present in the items value regardless of their
parent/child relationships.
public MultiPickerItem setInitialSort(SortSpecifier... initialSort)
Initial sort specifiers
for this item's list of
options. Will be applied to the pickList
,
pickTree
or shuttle
depending on the selectionStyle
of this item.initialSort
- New initialSort value. Default value is nullMultiPickerItem
instance, for chaining setter callspublic SortSpecifier[] getInitialSort()
Initial sort specifiers
for this item's list of
options. Will be applied to the pickList
,
pickTree
or shuttle
depending on the selectionStyle
of this item.public MultiPickerItem setMultiple(java.lang.Boolean multiple)
setMultiple
in class FormItem
multiple
- New multiple value. Default value is trueMultiPickerItem
instance, for chaining setter callsAppearance overview and related methods
public java.lang.Boolean getMultiple()
getMultiple
in class FormItem
Appearance overview and related methods
public MultiPickerItem setOptionDataSource(DataSource optionDataSource)
com.smartgwt.client.types.ValueMap
were specified, by fetching records from the specified optionDataSource
and extracting the valueField
and displayField
in loaded records, to derive one valueMap
entry per record loaded from the optionDataSource. With the default setting of fetchMissingValues
, fetches will be initiated
against the optionDataSource any time the FormItem has a non-null value and no corresponding display value is available.
This includes when the form is first initialized, as well as any subsequent calls to FormItem.setValue()
, such as may happen when DynamicForm.editRecord()
is called. Retrieved values are
automatically cached by the FormItem.
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.
In a databound form, if FormItem.displayField
is specified for a FormItem and
optionDataSource
is unset, optionDataSource
will default to the form's current DataSource
setOptionDataSource
in class FormItem
optionDataSource
- New optionDataSource value. Default value is nullMultiPickerItem
instance, for chaining setter callsFormItem.invalidateDisplayValueCache()
,
List - Combo Box Examplepublic DataSource getOptionDataSource()
com.smartgwt.client.types.ValueMap
were specified, by fetching records from the specified optionDataSource
and extracting the valueField
and displayField
in loaded records, to derive one valueMap
entry per record loaded from the optionDataSource. With the default setting of fetchMissingValues
, fetches will be initiated
against the optionDataSource any time the FormItem has a non-null value and no corresponding display value is available.
This includes when the form is first initialized, as well as any subsequent calls to FormItem.setValue()
, such as may happen when DynamicForm.editRecord()
is called. Retrieved values are
automatically cached by the FormItem.
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.
In a databound form, if FormItem.displayField
is specified for a FormItem and
optionDataSource
is unset, optionDataSource
will default to the form's current DataSource
getOptionDataSource
in class FormItem
FormItem.invalidateDisplayValueCache()
,
List - Combo Box Examplepublic MultiPickerItem setOptionFilterContext(DSRequest optionFilterContext)
optionDataSource
, and this property is not null, the context is passed to the
dataSource as RPCRequest
properties when performing fetch operations on the dataSource
to obtain a data-value to display-value mapping, and when fetching for grid-based pickers. This attribute is a
direct shortcut for setting fetch-request properties via
item.pickerProperties.dataProperties.requestProperties
.
optionFilterContext
- New optionFilterContext value. Default value is nullMultiPickerItem
instance, for chaining setter callspublic DSRequest getOptionFilterContext()
optionDataSource
, and this property is not null, the context is passed to the
dataSource as RPCRequest
properties when performing fetch operations on the dataSource
to obtain a data-value to display-value mapping, and when fetching for grid-based pickers. This attribute is a
direct shortcut for setting fetch-request properties via
item.pickerProperties.dataProperties.requestProperties
.
getOptionFilterContext
in class FormItem
public MultiPickerItem setOptionOperationId(java.lang.String optionOperationId)
optionDataSource
, this attribute may be set to specify an explicit DSRequest.operationId
when performing a fetch against the option
dataSource to pick up display value mapping.setOptionOperationId
in class FormItem
optionOperationId
- New optionOperationId value. Default value is nullMultiPickerItem
instance, for chaining setter callsDataBinding
public java.lang.String getOptionOperationId()
optionDataSource
, this attribute may be set to specify an explicit DSRequest.operationId
when performing a fetch against the option
dataSource to pick up display value mapping.getOptionOperationId
in class FormItem
DataBinding
public VLayout getPickerLayout()
Shuttle
.
This component is an AutoChild named "pickerLayout". For an overview of how to use and
configure AutoChildren, see Using AutoChildren
.
public HLayout getPickerToolbar()
selectAllButton
, deselectAllButton
and expansionIcon
. Shown within the
pickerLayout
if SelectionStyle
is "pickList"
This component is an AutoChild named "pickerToolbar". For an overview of how to use and
configure AutoChildren, see Using AutoChildren
.
public ListGrid getPickList()
pickList
is a filterable ListGrid com.smartgwt.client.types.AutoChild
for
viewing and selecting the list of available options when SelectionStyle
is
"pickList"
. It is rendered inside the pickerLayout
along with the optional selectionList
This component is an AutoChild named "pickList". For an overview of how to use and
configure AutoChildren, see Using AutoChildren
.
public MultiPickerItem setPickListFetchDelay(java.lang.Integer pickListFetchDelay)
filterPickListOnKeypress
is true, how long to wait in ms after the last keystroke from a user before filtering the pickList. If not
explicitly specified, the default fetchDelay will be derived from the pickList fetchDelay
.
pickListFetchDelay
- New pickListFetchDelay value. Default value is nullMultiPickerItem
instance, for chaining setter callspublic java.lang.Integer getPickListFetchDelay()
filterPickListOnKeypress
is true, how long to wait in ms after the last keystroke from a user before filtering the pickList. If not
explicitly specified, the default fetchDelay will be derived from the pickList fetchDelay
.
public MultiPickerItem setPickListHeight(java.lang.Integer pickListHeight)
pickListHeight
- New pickListHeight value. Default value is 400MultiPickerItem
instance, for chaining setter callspublic java.lang.Integer getPickListHeight()
public MultiPickerItem setPickListWidth(java.lang.Integer pickListWidth)
pickListWidth
- New pickListWidth value. Default value is 250MultiPickerItem
instance, for chaining setter callspublic java.lang.Integer getPickListWidth()
public TreeGrid getPickTree()
pickTree
is a TreeGrid com.smartgwt.client.types.AutoChild
for viewing and
selecting a tree of available options when SelectionStyle
is "pickTree"
.
It is rendered inside the pickerLayout
along with the optional selectionList
This component is an AutoChild named "pickTree". For an overview of how to use and
configure AutoChildren, see Using AutoChildren
.
public ToolStripButton getSelectAllButton()
com.smartgwt.client.types.AutoChild
This component is an AutoChild named "selectAllButton". For an overview of how to use and
configure AutoChildren, see Using AutoChildren
.
public MultiPickerItem setSelectAllButtonTitle(java.lang.String selectAllButtonTitle)
selectAllButton
selectAllButtonTitle
- New selectAllButtonTitle value. Default value is "Select All"MultiPickerItem
instance, for chaining setter callspublic java.lang.String getSelectAllButtonTitle()
selectAllButton
public MultiPickerItem setSelectAllWhileFiltered(FilteredSelectAllAction selectAllWhileFiltered)
Note : This is an advanced setting
selectAllWhileFiltered
- New selectAllWhileFiltered value. Default value is "whenLoaded"MultiPickerItem
instance, for chaining setter callspublic FilteredSelectAllAction getSelectAllWhileFiltered()
public MultiPickerItem setSelectAllWhileFiltered_disabledPrompt(java.lang.String selectAllWhileFiltered_disabledPrompt)
selectAllButton
while filtered if selectAllWhileFiltered
is set to
"disable"
.selectAllWhileFiltered_disabledPrompt
- New selectAllWhileFiltered_disabledPrompt value. Default value is "Select All disabled while filtered"MultiPickerItem
instance, for chaining setter callspublic java.lang.String getSelectAllWhileFiltered_disabledPrompt()
selectAllButton
while filtered if selectAllWhileFiltered
is set to
"disable"
.public MultiPickerItem setSelectAllWhileFiltered_partialCachePrompt(java.lang.String selectAllWhileFiltered_partialCachePrompt)
selectAllButton
while filtered if selectAllWhileFiltered
is set to
"whenLoaded"
and the PickList does not have a complete data set loaded on the client.selectAllWhileFiltered_partialCachePrompt
- New selectAllWhileFiltered_partialCachePrompt value. Default value is "Unable to Select All as the full set of options has not been fetched from the server."MultiPickerItem
instance, for chaining setter callspublic java.lang.String getSelectAllWhileFiltered_partialCachePrompt()
selectAllButton
while filtered if selectAllWhileFiltered
is set to
"whenLoaded"
and the PickList does not have a complete data set loaded on the client.public MultiPickerItem setSelectedSelectionListTitle(java.lang.String selectedSelectionListTitle)
selectionList
.selectedSelectionListTitle
- New selectedSelectionListTitle value. Default value is "Included Items"MultiPickerItem
instance, for chaining setter callspublic java.lang.String getSelectedSelectionListTitle()
selectionList
.public ListGrid getSelectionList()
selectionStyle:"pickList"
. Has canRemoveRecords
enabled as an alternative UI for deselecting records to unchecking the item in the PickList.
This component is an AutoChild named "selectionList". For an overview of how to use and
configure AutoChildren, see Using AutoChildren
.
public Label getSelectionListLabel()
selectedSelectionListTitle
This component is an AutoChild named "selectionListLabel". For an overview of how to use and
configure AutoChildren, see Using AutoChildren
.
public MultiPickerItem setSelectionStyle(MultiPickerSelectionStyle selectionStyle)
Shuttle
style interface to indicate the
currently selected / unselected values?
Note : This is an advanced setting
selectionStyle
- New selectionStyle value. Default value is "pickList"MultiPickerItem
instance, for chaining setter callspublic MultiPickerSelectionStyle getSelectionStyle()
Shuttle
style interface to indicate the
currently selected / unselected values?public MultiPickerItem setShowFilterForm(boolean showFilterForm)
filterForm
be shown? This only applies to selectionStyle "pickList".
showFilterForm
- New showFilterForm value. Default value is trueMultiPickerItem
instance, for chaining setter callspublic boolean getShowFilterForm()
filterForm
be shown? This only applies to selectionStyle "pickList".
public MultiPickerItem setShowSelectionLabel(java.lang.Boolean showSelectionLabel)
selectionListLabel
for the selectedSelectionListTitle
above
the selectionList
. Will never be
shown if showSelectionList
is false
or if selectionStyle is not "pickList".
showSelectionLabel
- New showSelectionLabel value. Default value is trueMultiPickerItem
instance, for chaining setter callspublic java.lang.Boolean getShowSelectionLabel()
selectionListLabel
for the selectedSelectionListTitle
above
the selectionList
. Will never be
shown if showSelectionList
is false
or if selectionStyle is not "pickList".
public MultiPickerItem setShowSelectionList(java.lang.Boolean showSelectionList)
showSelectionList
- New showSelectionList value. Default value is trueMultiPickerItem
instance, for chaining setter callspublic java.lang.Boolean getShowSelectionList()
public Shuttle getShuttle()
Shuttle
shown in the pickerLayout
when SelectionStyle
is set to "shuttle"
.
This component is an AutoChild named "shuttle". For an overview of how to use and
configure AutoChildren, see Using AutoChildren
.
public MultiPickerItem setShuttleHeight(java.lang.Integer shuttleHeight)
shuttleHeight
- New shuttleHeight value. Default value is 400MultiPickerItem
instance, for chaining setter callspublic java.lang.Integer getShuttleHeight()
public MultiPickerItem setShuttleWidth(java.lang.Integer shuttleWidth)
shuttleWidth
- New shuttleWidth value. Default value is 500MultiPickerItem
instance, for chaining setter callspublic java.lang.Integer getShuttleWidth()
public MultiPickerItem setSortDirection(SortDirection sortDirection)
Sort direction
for this item's list of options. Will
be applied to the pickList
, pickTree
or shuttle
depending on the selectionStyle
of this item.sortDirection
- New sortDirection value. Default value is nullMultiPickerItem
instance, for chaining setter callspublic SortDirection getSortDirection()
Sort direction
for this item's list of options. Will
be applied to the pickList
, pickTree
or shuttle
depending on the selectionStyle
of this item.public MultiPickerItem setSortField(java.lang.String sortField)
Sort field
for this item's list of options. Will be
applied to the pickList
, pickTree
or shuttle
depending on the selectionStyle
of this item.sortField
- New sortField value. Default value is nullMultiPickerItem
instance, for chaining setter callspublic java.lang.String getSortField()
Sort field
for this item's list of options. Will be
applied to the pickList
, pickTree
or shuttle
depending on the selectionStyle
of this item.public MultiPickerItem setSortField(java.lang.String... sortField)
Sort field
for this item's list of options. Will be
applied to the pickList
, pickTree
or shuttle
depending on the selectionStyle
of this item.sortField
- New sortField value. Default value is nullMultiPickerItem
instance, for chaining setter callspublic java.lang.String[] getSortFieldAsStringArray()
Sort field
for this item's list of options. Will be
applied to the pickList
, pickTree
or shuttle
depending on the selectionStyle
of this item.public MultiPickerItem setSortField(java.lang.Integer sortField)
Sort field
for this item's list of options. Will be
applied to the pickList
, pickTree
or shuttle
depending on the selectionStyle
of this item.sortField
- New sortField value. Default value is nullMultiPickerItem
instance, for chaining setter callspublic java.lang.Integer getSortFieldAsInt()
Sort field
for this item's list of options. Will be
applied to the pickList
, pickTree
or shuttle
depending on the selectionStyle
of this item.public MultiPickerItem setTextMatchStyle(TextMatchStyle textMatchStyle)
option
criteria
for this itemtextMatchStyle
- New textMatchStyle value. Default value is "substring"MultiPickerItem
instance, for chaining setter callspublic TextMatchStyle getTextMatchStyle()
option
criteria
for this itempublic MultiPickerItem setValueField(java.lang.String valueField)
FormItem.displayField
values from an optionDataSource
, this property denotes the the
field to use as the underlying data value in records from the optionDataSource.FormItem.getValueFieldName()
.setValueField
in class FormItem
valueField
- New valueField value. Default value is nullMultiPickerItem
instance, for chaining setter callsDataBinding
public java.lang.String getValueField()
FormItem.displayField
values from an optionDataSource
, this property denotes the the
field to use as the underlying data value in records from the optionDataSource.FormItem.getValueFieldName()
.getValueField
in class FormItem
FormItem.valueField
for this item. For items with a specified FormItem.optionDataSource
, this determines which field in that dataSource corresponds to the value for this item.
If unset, if a foreignKey relationship
exists between
this field and the optionDataSource, this will be used, otherwise default behavior will return the FormItem.name
of this field. Default value is null
DataBinding
public java.lang.String getValueFieldName()
FormItem.valueField
for this item. For items with a specified FormItem.optionDataSource
, this determines which field in that dataSource corresponds to the value for this item.
If unset, if a foreignKey relationship
exists between
this field and the optionDataSource, this will be used, otherwise default behavior will return the FormItem.name
of this field.
getValueFieldName
in class FormItem
FormItem.optionDataSource
public static void setDefaultProperties(MultiPickerItem multiPickerItemProperties)
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.
multiPickerItemProperties
- properties that should be used as new defaults when instances of this class are createdSGWTProperties
public void setOptionCriteria(Criteria optionCriteria)
Note : This is an advanced setting
setOptionCriteria
in class FormItem
optionCriteria
- New optionCriteria value. Default value is nullpublic Criteria getOptionCriteria()
getOptionCriteria
in class FormItem
optionCriteria
for
this item. Default value is null