io.jmix.ui.component.impl

Class ComboBoxImpl<V>

java.lang.Object

io.jmix.ui.component.impl.AbstractComponent<T>

io.jmix.ui.component.impl.AbstractValueComponent<T,P,V>

io.jmix.ui.component.impl.AbstractField<JmixComboBox<V>,V,V>

io.jmix.ui.component.impl.ComboBoxImpl<V>

All Implemented Interfaces:

AttachNotifier, Buffered, ComboBox<V>, Component, Component.BelongToFrame, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper, HasValueSource<V>, Field<V>, HasContextHelp, HasDebugId, HasEnterPressHandler, HasFilterMode, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, HasInputPrompt, HasOptionCaptionProvider<V>, HasOptionIconProvider<V>, HasOptionImageProvider<V>, HasOptionStyleProvider<V>, HasValidator<V>, HasValue<V>, OptionsField<V,V>, Requirable, Validatable, org.springframework.beans.factory.InitializingBean

public class ComboBoxImpl<V>
extends AbstractField<JmixComboBox<V>,V,V>
implements ComboBox<V>, org.springframework.beans.factory.InitializingBean

Nested Class Summary

Nested classes/interfaces inherited from interface io.jmix.ui.component.ComboBox

ComboBox.OptionsCaptionFilteringContext

Nested classes/interfaces inherited from interface io.jmix.ui.component.HasValue

HasValue.ValueChangeEvent<V>

Nested classes/interfaces inherited from interface io.jmix.ui.component.Component

Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper

Nested classes/interfaces inherited from interface io.jmix.ui.component.HasContextHelp

HasContextHelp.ContextHelpIconClickEvent

Nested classes/interfaces inherited from interface io.jmix.ui.component.HasFilterMode

HasFilterMode.FilterMode

Nested classes/interfaces inherited from interface io.jmix.ui.component.HasEnterPressHandler

HasEnterPressHandler.EnterPressEvent

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.function.Consumer<HasEnterPressHandler.EnterPressEvent>	enterPressHandler
protected HasFilterMode.FilterMode	filterMode
protected IconResolver	iconResolver
protected io.jmix.core.MetadataTools	metadataTools
static com.vaadin.ui.IconGenerator	NULL_ITEM_ICON_GENERATOR
static com.vaadin.ui.StyleGenerator	NULL_STYLE_GENERATOR
protected boolean	nullOptionVisible
protected java.util.function.Function<? super V,java.lang.String>	optionCaptionProvider
protected java.util.function.Function<? super V,java.lang.String>	optionIconProvider
protected java.util.function.Function<? super V,Resource>	optionImageProvider
protected OptionsBinding<V>	optionsBinding
protected java.util.function.Predicate<ComboBox.OptionsCaptionFilteringContext>	optionsCaptionFilter
protected java.util.function.Function<? super V,java.lang.String>	optionStyleProvider

Fields inherited from class io.jmix.ui.component.impl.AbstractField

editable, parentEditableChangeListener, validators, VALIDATORS_LIST_INITIAL_CAPACITY

Fields inherited from class io.jmix.ui.component.impl.AbstractValueComponent

internalValue, uiTestIdsSupport, valueBinding

Fields inherited from class io.jmix.ui.component.impl.AbstractComponent

alignment, applicationContext, component, contextHelpIconClickHandler, contextHelpIconClickListener, descriptionAsHtml, element, frame, htmlSanitizerEnabled, icon, ICON_STYLE, id, parent

Fields inherited from interface io.jmix.ui.component.ComboBox

NAME, TYPE_STRING

Fields inherited from interface io.jmix.ui.component.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Constructor Summary

Constructors

Constructor and Description
ComboBoxImpl()

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
void	commit() Updates all changes since the previous commit to the data source.
protected JmixComboBox<V>	createComponent()
void	discard() Discards all changes since last commit.
protected boolean	filterItemTest(java.lang.String itemCaption, java.lang.String filterText)
void	focus() Sets focus to this component
protected java.lang.String	generateDefaultItemCaption(V item)
protected java.lang.String	generateItemCaption(V item)
protected java.lang.String	generateItemStylename(V item)
protected com.vaadin.server.Resource	generateOptionIcon(V item)
protected com.vaadin.server.Resource	generateOptionImage(V item)
java.util.function.Consumer<HasEnterPressHandler.EnterPressEvent>	getEnterPressHandler()
HasFilterMode.FilterMode	getFilterMode()
java.lang.String	getInputPrompt()
java.lang.String	getNullSelectionCaption()
java.util.function.Function<? super V,java.lang.String>	getOptionCaptionProvider()
java.util.function.Function<? super V,java.lang.String>	getOptionIconProvider()
java.util.function.Function<? super V,Resource>	getOptionImageProvider()
Options<V>	getOptions()
java.util.function.Predicate<ComboBox.OptionsCaptionFilteringContext>	getOptionsCaptionFilter()
java.util.function.Function<? super V,java.lang.String>	getOptionStyleProvider()
int	getPageLength()
java.lang.String	getPopupWidth() Returns the suggestion popup's width as a string.
int	getTabIndex() Gets the tabulator index of the HasTabIndex component.
V	getValue()
protected void	handleClearShortcut(java.lang.Object sender, java.lang.Object target)
protected void	initComponent(JmixComboBox<V> component)
boolean	isAutomaticPopupOnFocus()
boolean	isBuffered()
boolean	isModified() Tests if the value stored in the object has been modified since it was last updated from the data source.
boolean	isNullOptionVisible()
boolean	isTextInputAllowed()
protected void	onEnterPressed(java.lang.String text)
void	setAutomaticPopupOnFocus(boolean popup) When enabled popup automatically opens on focus.
void	setBuffered(boolean buffered) Sets the buffered mode.
void	setEnterPressHandler(java.util.function.Consumer<HasEnterPressHandler.EnterPressEvent> handler) Sets an ENTER press handler.
void	setFilterMode(HasFilterMode.FilterMode filterMode) Sets filter mode for the dropdown list in the field.
void	setIconResolver(IconResolver iconResolver)
void	setInputPrompt(java.lang.String inputPrompt) Sets the input prompt - a textual prompt that is displayed when the field would otherwise be empty, to prompt the user for input.
protected void	setItemsToPresentation(java.util.stream.Stream<V> options)
void	setMetadataTools(io.jmix.core.MetadataTools metadataTools)
void	setNullOptionVisible(boolean nullOptionVisible) Sets visibility for first null element in suggestion popup.
void	setNullSelectionCaption(java.lang.String nullOption) Sets the null selection caption.
void	setOptionCaptionProvider(java.util.function.Function<? super V,java.lang.String> optionCaptionProvider) Sets function that provides caption for option items.
void	setOptionIconProvider(java.util.function.Function<? super V,java.lang.String> optionIconProvider) Sets a function that provides an icon for options.
void	setOptionImageProvider(java.util.function.Function<? super V,Resource> optionImageProvider) Sets a function that provides option images.
void	setOptions(Options<V> options) Sets options for UI component.
void	setOptionsCaptionFilter(java.util.function.Predicate<ComboBox.OptionsCaptionFilteringContext> filter) Sets a predicate that tests whether an item with the given caption matches to the given search string.
void	setOptionStyleProvider(java.util.function.Function<? super V,java.lang.String> optionStyleProvider) Sets the style provider that is used to produce custom class names for option items.
void	setPageLength(int pageLength) Sets the page length for the suggestion popup.
void	setPopupWidth(java.lang.String width) Sets the suggestion popup's width as a string.
void	setRequired(boolean required) Sets whether the component must contain a non-null value.
void	setTabIndex(int tabIndex) Sets the tabulator index of the Focusable component.
void	setTextInputAllowed(boolean textInputAllowed) Sets whether it is possible to input text into the field or whether the field area of the component is just used to show what is selected.
protected void	valueBindingConnected(ValueSource<V> valueSource)

Methods inherited from class io.jmix.ui.component.impl.AbstractField

addValidator, attachValueChangeListener, getDatatypeConversionErrorMsg, getErrorMessage, getRequiredMessage, getValidators, isEditable, isRequired, isValid, removeValidator, setEditable, setEditableToComponent, setParent, setRequiredMessage, setupComponentErrorProvider, triggerValidators, validate

Methods inherited from class io.jmix.ui.component.impl.AbstractValueComponent

addValueChangeListener, componentValueChanged, convertToModel, convertToPresentation, fieldValueEquals, getValueSource, setUiTestId, setUiTestIdsSupport, setValue, setValueSource, setValueToPresentation, valueBindingActivated

Methods inherited from class io.jmix.ui.component.impl.AbstractComponent

addAttachListener, addDetachListener, addStyleName, assignDebugId, attached, detached, getAlignment, getCaption, getComponent, getComposition, getContextHelpIconClickHandler, getContextHelpText, getDebugId, getDescription, getEventHub, getFrame, getHeight, getHeightSizeUnit, getHtmlSanitizer, getIcon, getIconName, getIconResource, getId, getParent, getStyleName, getUiComponentProperties, getUiProperties, getWidth, getWidthSizeUnit, getXmlDescriptor, hasSubscriptions, hasValidationError, isAttached, isCaptionAsHtml, isContextHelpTextHtmlEnabled, isDescriptionAsHtml, isEnabled, isEnabledRecursive, isHtmlSanitizerEnabled, isResponsive, isVisible, isVisibleRecursive, onContextHelpIconClick, publish, removeStyleName, sanitize, setAlignment, setApplicationContext, setCaption, setCaptionAsHtml, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled, setDebugId, setDescription, setDescriptionAsHtml, setEnabled, setFrame, setHeight, setHtmlSanitizerEnabled, setIcon, setIconFromSet, setId, setResponsive, setStyleName, setValidationError, setVisible, setWidth, setXmlDescriptor, unsubscribe, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.jmix.ui.component.ComboBox

of

Methods inherited from interface io.jmix.ui.component.OptionsField

setOptionsEnum, setOptionsList, setOptionsMap

Methods inherited from interface io.jmix.ui.component.data.HasValueSource

getValueSource, setValueSource

Methods inherited from interface io.jmix.ui.component.HasValue

addValueChangeListener, clear, getEmptyValue, isEmpty, setValue

Methods inherited from interface io.jmix.ui.component.Component.Editable

isEditable, isEditableWithParent, setEditable

Methods inherited from interface io.jmix.ui.component.Component.BelongToFrame

getFrame, setFrame

Methods inherited from interface io.jmix.ui.component.Component

addStyleName, getAlignment, getHeight, getHeightSizeUnit, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, isEnabled, isEnabledRecursive, isResponsive, isVisible, isVisibleRecursive, removeStyleName, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Methods inherited from interface io.jmix.ui.component.Validatable

isValid, isValidateOnCommit, validate

Methods inherited from interface io.jmix.ui.component.Component.HasIcon

getIcon, setIcon, setIconFromSet

Methods inherited from interface io.jmix.ui.component.HasContextHelp

getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled

Methods inherited from interface io.jmix.ui.component.HasHtmlCaption

isCaptionAsHtml, setCaptionAsHtml

Methods inherited from interface io.jmix.ui.component.Component.HasCaption

getCaption, setCaption

Methods inherited from interface io.jmix.ui.component.Component.HasDescription

getDescription, setDescription

Methods inherited from interface io.jmix.ui.component.HasHtmlDescription

isDescriptionAsHtml, setDescriptionAsHtml

Methods inherited from interface io.jmix.ui.component.HasHtmlSanitizer

isHtmlSanitizerEnabled, setHtmlSanitizerEnabled

Methods inherited from interface io.jmix.ui.component.HasValidator

addValidator, addValidators, getValidators, removeValidator

Methods inherited from interface io.jmix.ui.component.Requirable

getRequiredMessage, isRequired, setRequiredMessage

Methods inherited from interface io.jmix.ui.component.Component.Focusable

isFocusable, setFocusable

Field Detail

NULL_STYLE_GENERATOR

public static final com.vaadin.ui.StyleGenerator NULL_STYLE_GENERATOR

NULL_ITEM_ICON_GENERATOR

public static final com.vaadin.ui.IconGenerator NULL_ITEM_ICON_GENERATOR

filterMode

protected HasFilterMode.FilterMode filterMode

nullOptionVisible

protected boolean nullOptionVisible

enterPressHandler

protected java.util.function.Consumer<HasEnterPressHandler.EnterPressEvent> enterPressHandler

optionIconProvider

protected java.util.function.Function<? super V,java.lang.String> optionIconProvider

optionImageProvider

protected java.util.function.Function<? super V,Resource> optionImageProvider

optionCaptionProvider

protected java.util.function.Function<? super V,java.lang.String> optionCaptionProvider

optionStyleProvider

protected java.util.function.Function<? super V,java.lang.String> optionStyleProvider

optionsCaptionFilter

protected java.util.function.Predicate<ComboBox.OptionsCaptionFilteringContext> optionsCaptionFilter

metadataTools

protected io.jmix.core.MetadataTools metadataTools

iconResolver

protected IconResolver iconResolver

optionsBinding

protected OptionsBinding<V> optionsBinding

Constructor Detail

ComboBoxImpl

public ComboBoxImpl()

Method Detail

createComponent

protected JmixComboBox<V> createComponent()

setMetadataTools

@Autowired
public void setMetadataTools(io.jmix.core.MetadataTools metadataTools)

setIconResolver

@Autowired
public void setIconResolver(IconResolver iconResolver)

handleClearShortcut

protected void handleClearShortcut(java.lang.Object sender,
                                   java.lang.Object target)

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

initComponent

protected void initComponent(JmixComboBox<V> component)

generateDefaultItemCaption

protected java.lang.String generateDefaultItemCaption(V item)

generateItemCaption

protected java.lang.String generateItemCaption(@Nullable
                                               V item)

generateItemStylename

@Nullable
protected java.lang.String generateItemStylename(V item)

filterItemTest

protected boolean filterItemTest(java.lang.String itemCaption,
                                 java.lang.String filterText)

valueBindingConnected

protected void valueBindingConnected(ValueSource<V> valueSource)

Overrides:

valueBindingConnected in class AbstractValueComponent<JmixComboBox<V>,V,V>

getValue

@Nullable
public V getValue()

Specified by:

getValue in interface HasValue<V>

Overrides:

getValue in class AbstractValueComponent<JmixComboBox<V>,V,V>

setFilterMode

public void setFilterMode(HasFilterMode.FilterMode filterMode)

Description copied from interface: HasFilterMode

Sets filter mode for the dropdown list in the field.

Specified by:

setFilterMode in interface HasFilterMode

Parameters:

filterMode - filter mode to set

getFilterMode

public HasFilterMode.FilterMode getFilterMode()

Specified by:

getFilterMode in interface HasFilterMode

Returns:

filter mode for the dropdown list in the field

setRequired

public void setRequired(boolean required)

Description copied from interface: Requirable

Sets whether the component must contain a non-null value.

Specified by:

setRequired in interface Requirable

Overrides:

setRequired in class AbstractField<JmixComboBox<V>,V,V>

Parameters:

required - required

getNullSelectionCaption

public java.lang.String getNullSelectionCaption()

Specified by:

getNullSelectionCaption in interface ComboBox<V>

Returns:

the null selection caption, not null

setNullSelectionCaption

public void setNullSelectionCaption(java.lang.String nullOption)

Description copied from interface: ComboBox

Sets the null selection caption.

The empty string "" is the default null selection caption.

If null selection is allowed then the null item will be shown with the given caption.

Specified by:

setNullSelectionCaption in interface ComboBox<V>

Parameters:

nullOption - the caption to set, not null

getOptions

@Nullable
public Options<V> getOptions()

Specified by:

getOptions in interface OptionsField<V,V>

Returns:

options object

setOptions

public void setOptions(@Nullable
                       Options<V> options)

Description copied from interface: OptionsField

Sets options for UI component.

Specified by:

setOptions in interface OptionsField<V,V>

Parameters:

options - options

See Also:

ListOptions

setItemsToPresentation

protected void setItemsToPresentation(java.util.stream.Stream<V> options)

setOptionCaptionProvider

public void setOptionCaptionProvider(@Nullable
                                     java.util.function.Function<? super V,java.lang.String> optionCaptionProvider)

Description copied from interface: HasOptionCaptionProvider

Sets function that provides caption for option items.

Specified by:

setOptionCaptionProvider in interface HasOptionCaptionProvider<V>

Parameters:

optionCaptionProvider - caption provider for options

getOptionCaptionProvider

@Nullable
public java.util.function.Function<? super V,java.lang.String> getOptionCaptionProvider()

Specified by:

getOptionCaptionProvider in interface HasOptionCaptionProvider<V>

Returns:

caption provider for options

isTextInputAllowed

public boolean isTextInputAllowed()

Specified by:

isTextInputAllowed in interface ComboBox<V>

Returns:

true if text input allowed

setTextInputAllowed

public void setTextInputAllowed(boolean textInputAllowed)

Description copied from interface: ComboBox

Sets whether it is possible to input text into the field or whether the field area of the component is just used to show what is selected.

Specified by:

setTextInputAllowed in interface ComboBox<V>

isAutomaticPopupOnFocus

public boolean isAutomaticPopupOnFocus()

Specified by:

isAutomaticPopupOnFocus in interface ComboBox<V>

Returns:

whether popup is automatically shows on focus.

setAutomaticPopupOnFocus

public void setAutomaticPopupOnFocus(boolean popup)

Description copied from interface: ComboBox

When enabled popup automatically opens on focus.

Specified by:

setAutomaticPopupOnFocus in interface ComboBox<V>

getEnterPressHandler

@Nullable
public java.util.function.Consumer<HasEnterPressHandler.EnterPressEvent> getEnterPressHandler()

Specified by:

getEnterPressHandler in interface HasEnterPressHandler

Returns:

an ENTER press handler

setEnterPressHandler

public void setEnterPressHandler(@Nullable
                                 java.util.function.Consumer<HasEnterPressHandler.EnterPressEvent> handler)

Description copied from interface: HasEnterPressHandler

Sets an ENTER press handler.

Specified by:

setEnterPressHandler in interface HasEnterPressHandler

Parameters:

handler - an ENTER press handler to set

onEnterPressed

protected void onEnterPressed(java.lang.String text)

getPageLength

public int getPageLength()

Specified by:

getPageLength in interface ComboBox<V>

Returns:

the page length of the suggestion popup.

setPageLength

public void setPageLength(int pageLength)

Description copied from interface: ComboBox

Sets the page length for the suggestion popup. Setting the page length to 0 will disable suggestion popup paging (all items visible).

Specified by:

setPageLength in interface ComboBox<V>

Parameters:

pageLength - the pageLength to set

setNullOptionVisible

public void setNullOptionVisible(boolean nullOptionVisible)

Description copied from interface: ComboBox

Sets visibility for first null element in suggestion popup.

Specified by:

setNullOptionVisible in interface ComboBox<V>

isNullOptionVisible

public boolean isNullOptionVisible()

Specified by:

isNullOptionVisible in interface ComboBox<V>

Returns:

true if first null element is visible.

setOptionIconProvider

public void setOptionIconProvider(@Nullable
                                  java.util.function.Function<? super V,java.lang.String> optionIconProvider)

Description copied from interface: HasOptionIconProvider

Sets a function that provides an icon for options.

Specified by:

setOptionIconProvider in interface HasOptionIconProvider<V>

Parameters:

optionIconProvider - icon provider for options to set

getOptionIconProvider

@Nullable
public java.util.function.Function<? super V,java.lang.String> getOptionIconProvider()

Specified by:

getOptionIconProvider in interface HasOptionIconProvider<V>

Returns:

options icon provider or null if not defined

generateOptionIcon

@Nullable
protected com.vaadin.server.Resource generateOptionIcon(V item)

setOptionImageProvider

public void setOptionImageProvider(@Nullable
                                   java.util.function.Function<? super V,Resource> optionImageProvider)

Description copied from interface: HasOptionImageProvider

Sets a function that provides option images.

Specified by:

setOptionImageProvider in interface HasOptionImageProvider<V>

Parameters:

optionImageProvider - options image provider

See Also:

Resource

getOptionImageProvider

@Nullable
public java.util.function.Function<? super V,Resource> getOptionImageProvider()

Specified by:

getOptionImageProvider in interface HasOptionImageProvider<V>

Returns:

options image provider.

generateOptionImage

@Nullable
protected com.vaadin.server.Resource generateOptionImage(V item)

getInputPrompt

@Nullable
public java.lang.String getInputPrompt()

Specified by:

getInputPrompt in interface HasInputPrompt

Returns:

current input prompt.

setInputPrompt

public void setInputPrompt(@Nullable
                           java.lang.String inputPrompt)

Description copied from interface: HasInputPrompt

Sets the input prompt - a textual prompt that is displayed when the field would otherwise be empty, to prompt the user for input.

Specified by:

setInputPrompt in interface HasInputPrompt

Parameters:

inputPrompt - input prompt

commit

public void commit()

Description copied from interface: Buffered

Updates all changes since the previous commit to the data source.

Specified by:

commit in interface Buffered

Overrides:

commit in class AbstractValueComponent<JmixComboBox<V>,V,V>

discard

public void discard()

Description copied from interface: Buffered

Discards all changes since last commit. The object updates its value from the data source.

Specified by:

discard in interface Buffered

Overrides:

discard in class AbstractValueComponent<JmixComboBox<V>,V,V>

isBuffered

public boolean isBuffered()

Specified by:

isBuffered in interface Buffered

Overrides:

isBuffered in class AbstractValueComponent<JmixComboBox<V>,V,V>

Returns:

true if buffered mode is on, false otherwise

setBuffered

public void setBuffered(boolean buffered)

Description copied from interface: Buffered

Sets the buffered mode.

When in buffered mode, an internal buffer will be used to store changes until Buffered.commit() is called. Calling Buffered.discard() will revert the internal buffer to the value of the data source.

When in non-buffered mode both read and write operations will be done directly on the data source. In this mode the Buffered.commit() and Buffered.discard() methods serve no purpose.

Specified by:

setBuffered in interface Buffered

Overrides:

setBuffered in class AbstractValueComponent<JmixComboBox<V>,V,V>

Parameters:

buffered - true if buffered mode should be turned on, false otherwise

isModified

public boolean isModified()

Description copied from interface: Buffered

Tests if the value stored in the object has been modified since it was last updated from the data source.

Specified by:

isModified in interface Buffered

Overrides:

isModified in class AbstractValueComponent<JmixComboBox<V>,V,V>

Returns:

true if the value in the object has been modified since the last data source update, false if not.

setOptionStyleProvider

public void setOptionStyleProvider(@Nullable
                                   java.util.function.Function<? super V,java.lang.String> optionStyleProvider)

Description copied from interface: HasOptionStyleProvider

Sets the style provider that is used to produce custom class names for option items.

Specified by:

setOptionStyleProvider in interface HasOptionStyleProvider<V>

Parameters:

optionStyleProvider - style provider

getOptionStyleProvider

@Nullable
public java.util.function.Function<? super V,java.lang.String> getOptionStyleProvider()

Specified by:

getOptionStyleProvider in interface HasOptionStyleProvider<V>

Returns:

the currently used item style provider

getOptionsCaptionFilter

@Nullable
public java.util.function.Predicate<ComboBox.OptionsCaptionFilteringContext> getOptionsCaptionFilter()

Specified by:

getOptionsCaptionFilter in interface ComboBox<V>

Returns:

a predicate that tests whether an item with the given caption matches to the given search string.

setOptionsCaptionFilter

public void setOptionsCaptionFilter(@Nullable
                                    java.util.function.Predicate<ComboBox.OptionsCaptionFilteringContext> filter)

Description copied from interface: ComboBox

Sets a predicate that tests whether an item with the given caption matches to the given search string.

Specified by:

setOptionsCaptionFilter in interface ComboBox<V>

Parameters:

filter - a predicate to set

getPopupWidth

@Nullable
public java.lang.String getPopupWidth()

Description copied from interface: ComboBox

Returns the suggestion popup's width as a string. By default this width is set to null.

Specified by:

getPopupWidth in interface ComboBox<V>

Returns:

explicitly set popup width as size string or null if not set

setPopupWidth

public void setPopupWidth(@Nullable
                          java.lang.String width)

Description copied from interface: ComboBox

Sets the suggestion popup's width as a string. By using relative units (e.g. "50%") it's possible to set the popup's width relative to the LookupField itself.

By default this width is set to null so that the popup's width can be greater than a component width to fit the content of all displayed items. By setting width to "100%" the popup's width will be equal to the width of the LookupField.

Specified by:

setPopupWidth in interface ComboBox<V>

Parameters:

width - the width

focus

public void focus()

Description copied from interface: Component.Focusable

Sets focus to this component

Specified by:

focus in interface Component.Focusable

getTabIndex

public int getTabIndex()

Description copied from interface: Component.Focusable

Gets the tabulator index of the HasTabIndex component.

Specified by:

getTabIndex in interface Component.Focusable

Returns:

tab index set for the HasTabIndex component

setTabIndex

public void setTabIndex(int tabIndex)

Description copied from interface: Component.Focusable

Sets the tabulator index of the Focusable component. The tab index property is used to specify the order in which the fields are focused when the user presses the Tab key. Components with a defined tab index are focused sequentially first, and then the components with no tab index.

Specified by:

setTabIndex in interface Component.Focusable

Parameters:

tabIndex - tab index