public interface SuggestionField extends Field, Component.Focusable, Component.HasInputPrompt
Modifier and Type | Interface and Description |
---|---|
static interface |
SuggestionField.ArrowDownActionHandler |
static interface |
SuggestionField.EnterActionHandler |
static interface |
SuggestionField.ParametrizedSearchExecutor<E extends Entity> |
static interface |
SuggestionField.SearchExecutor<E extends Entity> |
Field.Validator
Component.ActionOwner, Component.ActionsHolder, Component.Alignment, Component.BelongToFrame, Component.Buffered, Component.ChildEditableController, Component.Collapsable, Component.Container, Component.Disposable, Component.Editable, Component.EditableChangeEvent, Component.EditableChangeListener, Component.EditableChangeNotifier, Component.ExpandedStateChangeEvent, Component.ExpandedStateChangeListener, Component.Focusable, Component.HasBorder, Component.HasButtonsPanel, Component.HasCaption, Component.HasFormatter, Component.HasIcon, Component.HasInputPrompt, Component.HasNamedComponents, Component.HasPresentations, Component.HasRowsCount, Component.HasSettings, Component.HasValue, Component.HasXmlDescriptor, Component.LayoutClickEvent, Component.LayoutClickListener, Component.LayoutClickNotifier, Component.Margin, Component.MouseEventDetails, Component.OrderedContainer, Component.OuterMargin, Component.SecuredActionsHolder, Component.ShortcutAction, Component.ShortcutNotifier, Component.ShortcutTriggeredEvent, Component.Spacing, Component.UiPermissionAware, Component.Validatable, Component.ValueChangeEvent, Component.ValueChangeListener, Component.Wrapper
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
NAME |
AUTO_SIZE, AUTO_SIZE_PX, UNITS_PERCENTAGE, UNITS_PIXELS
addValidator, getRequiredMessage, getValidators, isRequired, removeValidator, setRequired, setRequiredMessage
getDatasource, getMetaProperty, getMetaPropertyPath, setDatasource
addListener, addValueChangeListener, getValue, removeListener, removeValueChangeListener, setValue
isEditable, isEditableWithParent, setEditable
getFrame, setFrame
addStyleName, getAlignment, getDebugId, getHeight, getHeightUnits, getId, getParent, getStyleName, getWidth, getWidthUnits, isEnabled, isEnabledItself, isResponsive, isVisible, isVisibleItself, removeStyleName, requestFocus, setAlignment, setDebugId, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition
getCaption, getDescription, setCaption, setDescription
isValid, isValidateOnCommit, validate
getIcon, setIcon
getTabIndex, isFocusable, setFocusable, setTabIndex
getInputPrompt, setInputPrompt
static final java.lang.String NAME
@Deprecated int getAsyncSearchTimeoutMs()
getAsyncSearchDelayMs()
instead.@Deprecated void setAsyncSearchTimeoutMs(int asyncSearchTimeoutMs)
setAsyncSearchDelayMs(int)
instead.asyncSearchTimeoutMs
- delay in msint getAsyncSearchDelayMs()
void setAsyncSearchDelayMs(int asyncSearchDelayMs)
asyncSearchDelayMs
- delay in msSuggestionField.SearchExecutor getSearchExecutor()
SuggestionField.SearchExecutor
which performs searchvoid setSearchExecutor(SuggestionField.SearchExecutor searchExecutor)
SuggestionField.SearchExecutor
which performs search.searchExecutor
- SearchExecutor instanceSuggestionField.EnterActionHandler getEnterActionHandler()
SuggestionField.EnterActionHandler
which handles ENTER key pressingvoid setEnterActionHandler(SuggestionField.EnterActionHandler enterActionHandler)
SuggestionField.EnterActionHandler
which handles ENTER key pressing.enterActionHandler
- EnterActionHandler instanceSuggestionField.ArrowDownActionHandler getArrowDownActionHandler()
SuggestionField.ArrowDownActionHandler
which handles ARROW_DOWN key pressingvoid setArrowDownActionHandler(SuggestionField.ArrowDownActionHandler arrowDownActionHandler)
SuggestionField.ArrowDownActionHandler
which handles ARROW_DOWN key pressing.arrowDownActionHandler
- ArrowDownActionHandler instanceint getMinSearchStringLength()
void setMinSearchStringLength(int minSearchStringLength)
minSearchStringLength
- required string length to perform searchint getSuggestionsLimit()
void setSuggestionsLimit(int suggestionsLimit)
suggestionsLimit
- integer limit valuevoid showSuggestions(java.util.List<? extends Entity> suggestions)
suggestions
- suggestions to showCaptionMode getCaptionMode()
void setCaptionMode(CaptionMode captionMode)
java.lang.String getCaptionProperty()
void setCaptionProperty(java.lang.String captionProperty)