public interface SearchField<V> extends LookupField<V>
Modifier and Type | Interface and Description |
---|---|
static class |
SearchField.Mode
Determines how search string case should be considered.
|
static interface |
SearchField.SearchNotifications
Notifications configuration object.
|
LookupField.FilterMode, LookupField.FilterPredicate, LookupField.NewOptionHandler, LookupField.OptionIconProvider<T>
Field.Validator<T>
HasValue.ValueChangeEvent<V>
Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.OptionsStyleProvider, Component.Wrapper
HasContextHelp.ContextHelpIconClickEvent
LookupComponent.LookupSelectionChangeEvent<T extends Entity>, LookupComponent.LookupSelectionChangeNotifier<T extends Entity>
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
NAME |
static java.lang.String |
SEARCH_STRING_PARAM |
TYPE_STRING
AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE, UNITS_PERCENTAGE, UNITS_PIXELS
Modifier and Type | Method and Description |
---|---|
Frame.NotificationType |
getDefaultNotificationType() |
int |
getMinSearchStringLength() |
SearchField.Mode |
getMode() |
SearchField.SearchNotifications |
getSearchNotifications() |
boolean |
isEscapeValueForLike() |
static <T> com.google.common.reflect.TypeToken<SearchField<T>> |
of(java.lang.Class<T> valueClass) |
void |
setDefaultNotificationType(Frame.NotificationType defaultNotificationType)
Sets a type of notifications (
TRAY , WARNING , etc) that will be shown in case of too small
search string or absence of matches. |
void |
setEscapeValueForLike(boolean escapeValueForLike)
Sets whether special symbols (like %, \, _) should be escaped in a search string.
|
void |
setMinSearchStringLength(int searchStringLength)
Sets minimal required search string length.
|
void |
setMode(SearchField.Mode mode)
Sets whether search string case should be considered or it should be converted to upper or lower case.
|
void |
setSearchNotifications(SearchField.SearchNotifications searchNotifications)
Sets notifications configuration object that determines what messages will be shown in case of too small
search string or absence of matches.
|
getFilterMode, getFilterPredicate, getNewOptionHandler, getNullOption, getNullSelectionCaption, getOptionIconProvider, getPageLength, getPopupWidth, isAutomaticPopupOnFocus, isNewOptionAllowed, isNullOptionVisible, isTextInputAllowed, setAutomaticPopupOnFocus, setFilterMode, setFilterPredicate, setNewOptionAllowed, setNewOptionHandler, setNullOption, setNullOptionVisible, setNullSelectionCaption, setOptionIconProvider, setOptionIconProvider, setPageLength, setPopupWidth, setTextInputAllowed
getOptions, getOptionsDatasource, getOptionsEnum, getOptionsList, getOptionsMap, setOptions, setOptionsDatasource, setOptionsEnum, setOptionsList, setOptionsMap
addValidator, addValidators, getRequiredMessage, getValidators, isRequired, removeValidator, setRequired, setRequiredMessage
getDatasource, getMetaProperty, getMetaPropertyPath, setDatasource
addValueChangeListener, clear, getEmptyValue, getValue, isEmpty, removeValueChangeListener, setValue
addStyleName, getAlignment, getHeight, getHeightSizeUnit, getHeightUnits, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, getWidthUnits, isEnabled, isEnabledItself, isEnabledRecursive, isResponsive, isVisible, isVisibleItself, isVisibleRecursive, removeStyleName, requestFocus, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition
getValueSource, setValueSource
isEditable, isEditableWithParent, setEditable
getFrame, setFrame
isValid, isValidateOnCommit, validate
getIcon, setIcon, setIconFromSet
getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled
isCaptionAsHtml, setCaptionAsHtml
getCaption, setCaption
getDescription, setDescription
isDescriptionAsHtml, setDescriptionAsHtml
getOptionCaptionProvider, setOptionCaptionProvider
getCaptionMode, getCaptionProperty, setCaptionMode, setCaptionProperty
getInputPrompt, setInputPrompt
commit, discard, isBuffered, isModified, setBuffered
getLookupSelectedItems, setLookupSelectHandler
focus, getTabIndex, isFocusable, setFocusable, setTabIndex
getOptionsStyleProvider, getOptionStyleProvider, setOptionsStyleProvider, setOptionStyleProvider
static final java.lang.String NAME
static final java.lang.String SEARCH_STRING_PARAM
static <T> com.google.common.reflect.TypeToken<SearchField<T>> of(java.lang.Class<T> valueClass)
of
in interface LookupField<V>
void setMinSearchStringLength(int searchStringLength)
searchStringLength
- minimal string lengthint getMinSearchStringLength()
void setSearchNotifications(SearchField.SearchNotifications searchNotifications)
Frame.NotificationType.TRAY
is the default value.
searchNotifications
- SearchField.SearchNotifications
instanceSearchField.SearchNotifications getSearchNotifications()
void setDefaultNotificationType(Frame.NotificationType defaultNotificationType)
TRAY
, WARNING
, etc) that will be shown in case of too small
search string or absence of matches.defaultNotificationType
- notification typeFrame.NotificationType getDefaultNotificationType()
void setMode(SearchField.Mode mode)
SearchField.Mode.CASE_SENSITIVE
is the default mode.
mode
- search modeSearchField.Mode getMode()
void setEscapeValueForLike(boolean escapeValueForLike)
escapeValueForLike
- escape special symbols if true, don't otherwiseboolean isEscapeValueForLike()