Package io.jmix.ui.component.impl

Class EntityComboBoxImpl<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<JmixPickerField<V>,V,V>

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

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

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

All Implemented Interfaces:

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

public class EntityComboBoxImpl<V>
extends EntityPickerImpl<V>
implements EntityComboBox<V>, SecuredActionsHolder

Nested Class Summary

Nested classes/interfaces inherited from class io.jmix.ui.component.impl.ValuePickerImpl

ValuePickerImpl.WebValuePickerActionHandler

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

ComboBox.OptionsCaptionFilteringContext

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.EntityPicker

EntityPicker.EntityPickerAction

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

HasContextHelp.ContextHelpIconClickEvent

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

HasEnterPressHandler.EnterPressEvent

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

HasFilterMode.FilterMode

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

HasValue.ValueChangeEvent<V>

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

LookupComponent.LookupSelectionChangeEvent<T>, LookupComponent.LookupSelectionChangeNotifier<T>

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

ValuePicker.FieldValueChangeEvent<V>, ValuePicker.ValuePickerAction

Field Summary

Fields

Modifier and Type	Field	Description
protected Consumer<HasEnterPressHandler.EnterPressEvent>	enterPressHandler
protected HasFilterMode.FilterMode	filterMode
protected IconResolver	iconResolver
protected boolean	nullOptionVisible
protected Function<? super V,String>	optionCaptionProvider
protected Function<? super V,String>	optionIconProvider
protected Function<? super V,Resource>	optionImageProvider
protected OptionsBinding<V>	optionsBinding
protected Predicate<ComboBox.OptionsCaptionFilteringContext>	optionsCaptionFilter
protected Function<? super V,String>	optionStyleProvider

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

metaClass, metadata

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

actionButtons, actionHandler, actionPropertyChangeListener, actions, actionsPermissions, fieldIconProvider, fieldListenerRegistration, formatter, metadataTools

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

TYPE_STRING

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

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

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

NAME

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

NAME

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

NAME, TYPE_STRING

Constructor Summary

Constructors

Constructor	Description
EntityComboBoxImpl()

Method Summary

Modifier and Type	Method	Description
Subscription	addFieldValueChangeListener(Consumer<ValuePicker.FieldValueChangeEvent<V>> listener)	Adds a listener that will be fired in case field is editable.
void	afterPropertiesSet()
protected void	checkValueType(V value)
protected void	componentValueChanged(V prevComponentValue, V newComponentValue, boolean isUserOriginated)
protected JmixPickerField<V>	createComponent()
protected boolean	filterItemTest(String itemCaption, String filterText)
protected String	generateDefaultItemCaption(V item)
protected String	generateItemCaption(V item)
protected String	generateItemStylename(V item)
protected com.vaadin.server.Resource	generateOptionIcon(V item)
protected com.vaadin.server.Resource	generateOptionImage(V item)
JmixComboBoxPickerField<V>	getComponent()
Consumer<HasEnterPressHandler.EnterPressEvent>	getEnterPressHandler()
Function<? super V,String>	getFieldIconProvider()
HasFilterMode.FilterMode	getFilterMode()
Formatter<V>	getFormatter()
String	getNullSelectionCaption()
Function<? super V,String>	getOptionCaptionProvider()
Function<? super V,String>	getOptionIconProvider()
Function<? super V,Resource>	getOptionImageProvider()
Options<V>	getOptions()
Predicate<ComboBox.OptionsCaptionFilteringContext>	getOptionsCaptionFilter()
Function<? super V,String>	getOptionStyleProvider()
int	getPageLength()
String	getPopupWidth()	Returns the suggestion popup's width as a string.
protected void	handleClearShortcut(Object sender, Object target)
protected void	initComponent(JmixPickerField<V> component)
boolean	isAutomaticPopupOnFocus()
boolean	isFieldEditable()
boolean	isNullOptionVisible()
boolean	isTextInputAllowed()
protected void	onEnterPressed(String text)
void	setAutomaticPopupOnFocus(boolean automaticPopupOnFocus)	When enabled popup automatically opens on focus.
void	setEnterPressHandler(Consumer<HasEnterPressHandler.EnterPressEvent> handler)	Sets an ENTER press handler.
void	setFieldEditable(boolean editable)	Sets whether a user can input the value manually.
void	setFieldIconProvider(Function<? super V,String> iconProvider)	Sets a function that provides an icon for the field.
void	setFilterMode(HasFilterMode.FilterMode filterMode)	Sets filter mode for the dropdown list in the field.
void	setFormatter(Formatter<? super V> formatter)
void	setIconResolver(IconResolver iconResolver)
void	setInputPrompt(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(Stream<V> options)
void	setNullOptionVisible(boolean nullOptionVisible)	Sets visibility for first null element in suggestion popup.
void	setNullSelectionCaption(String nullOption)	Sets the null selection caption.
void	setOptionCaptionProvider(Function<? super V,String> optionCaptionProvider)	Sets function that provides caption for option items.
void	setOptionIconProvider(Function<? super V,String> optionIconProvider)	Sets a function that provides an icon for options.
void	setOptionImageProvider(Function<? super V,Resource> optionImageProvider)	Sets a function that provides option images.
void	setOptions(Options<V> options)	Sets options for UI component.
void	setOptionsCaptionFilter(Predicate<ComboBox.OptionsCaptionFilteringContext> filter)	Sets a predicate that tests whether an item with the given caption matches to the given search string.
void	setOptionsContainer(CollectionContainer<V> container)	Sets options from the passed CollectionContainer.
void	setOptionStyleProvider(Function<? super V,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(String width)	Sets the suggestion popup's width as a string.
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.

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

getLookupSelectedItems, getMetaClass, setLookupSelectHandler, setMetaClass, setMetadata, setValue, setValueFromUser

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

actionPropertyChanged, addAction, addAction, applyDefaultValueFormat, commit, discard, focus, formatValue, getAction, getActions, getActionsPermissions, getInputPrompt, getTabIndex, isBuffered, isModified, onFieldValueChange, refreshActionsState, removeAction, removeAction, removeAllActions, setBuffered, setButtonIcon, setDebugId, setEditableToComponent, setFrame, setMetadataTools, setTabIndex, setUiComponentProperties, setupButtonAction

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

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

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

addValueChangeListener, convertToModel, convertToPresentation, fieldValueEquals, getValue, getValueSource, setUiTestId, setUiTestIdsSupport, setValueSource, setValueToPresentation, valueBindingActivated, valueBindingConnected

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

addAttachListener, addDetachListener, addStyleName, assignDebugId, attached, detached, getAlignment, getCaption, 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, setDescription, setDescriptionAsHtml, setEnabled, 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.ActionsHolder

addAction, addAction, getAction, getActionNN, getActions, getSubPart, removeAction, removeAction, removeAllActions

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

commit, discard, isBuffered, isModified, setBuffered

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.Component.BelongToFrame

getFrame, setFrame

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

isEditable, isEditableWithParent, setEditable

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

focus, getTabIndex, isFocusable, setFocusable, setTabIndex

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.Component.HasIcon

getIcon, setIcon, setIconFromSet

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

getMetaClass, setMetaClass

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.HasHtmlDescription

isDescriptionAsHtml, setDescriptionAsHtml

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

isHtmlSanitizerEnabled, setHtmlSanitizerEnabled

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

getInputPrompt

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

addValidator, addValidators, getValidators, removeValidator

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

addValueChangeListener, clear, getEmptyValue, getValue, isEmpty, setValue

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

getValueSource, setValueSource

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

getLookupSelectedItems, setLookupSelectHandler

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

setOptionsEnum, setOptionsList, setOptionsMap

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

getRequiredMessage, isRequired, setRequired, setRequiredMessage

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

getActionsPermissions

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

setValueFromUser

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

isValid, isValidateOnCommit, validate

Field Details

nullOptionVisible

protected boolean nullOptionVisible

filterMode

protected HasFilterMode.FilterMode filterMode

optionsCaptionFilter

protected Predicate<ComboBox.OptionsCaptionFilteringContext> optionsCaptionFilter

enterPressHandler

protected Consumer<HasEnterPressHandler.EnterPressEvent> enterPressHandler

optionCaptionProvider

protected Function<? super V,String> optionCaptionProvider

optionIconProvider

protected Function<? super V,String> optionIconProvider

optionImageProvider

protected Function<? super V,Resource> optionImageProvider

optionStyleProvider

protected Function<? super V,String> optionStyleProvider

optionsBinding

protected OptionsBinding<V> optionsBinding

iconResolver

protected IconResolver iconResolver

Constructor Details

EntityComboBoxImpl

public EntityComboBoxImpl()

Method Details

createComponent

protected JmixPickerField<V> createComponent()

Overrides:

createComponent in class EntityPickerImpl<V>

getComponent

public JmixComboBoxPickerField<V> getComponent()

Specified by:

getComponent in interface Component.Wrapper

Overrides:

getComponent in class AbstractComponent<JmixPickerField<V>>

setIconResolver

@Autowired
public void setIconResolver(IconResolver iconResolver)

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

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

Overrides:

afterPropertiesSet in class ValuePickerImpl<V>

initComponent

protected void initComponent(JmixPickerField<V> component)

Overrides:

initComponent in class ValuePickerImpl<V>

handleClearShortcut

protected void handleClearShortcut(Object sender,
 Object target)

generateDefaultItemCaption

protected String generateDefaultItemCaption(V item)

generateItemCaption

protected String generateItemCaption(@Nullable
 V item)

generateItemStylename

@Nullable
protected String generateItemStylename(V item)

getNullSelectionCaption

public String getNullSelectionCaption()

Specified by:

getNullSelectionCaption in interface ComboBox<V>

Returns:

the null selection caption, not null

setNullSelectionCaption

public void setNullSelectionCaption(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

getFilterMode

public HasFilterMode.FilterMode getFilterMode()

Specified by:

getFilterMode in interface HasFilterMode

Returns:

filter mode for the dropdown list in the field

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

addFieldValueChangeListener

public Subscription addFieldValueChangeListener(Consumer<ValuePicker.FieldValueChangeEvent<V>> listener)

Description copied from interface: ValuePicker

Adds a listener that will be fired in case field is editable.

Specified by:

addFieldValueChangeListener in interface ValuePicker<V>

Overrides:

addFieldValueChangeListener in class ValuePickerImpl<V>

Parameters:

listener - a listener to add

Returns:

a Subscription object

See Also:

• ValuePicker.setFieldEditable(boolean)

isFieldEditable

public boolean isFieldEditable()

Specified by:

isFieldEditable in interface ValuePicker<V>

Overrides:

isFieldEditable in class ValuePickerImpl<V>

Returns:

whether a user can input the value manually

setFieldEditable

public void setFieldEditable(boolean editable)

Description copied from interface: ValuePicker

Sets whether a user can input the value manually. false by default. Doesn't set entered value to the model. To handle user input, the ValuePicker.FieldValueChangeEvent listener must be used.

Specified by:

setFieldEditable in interface ValuePicker<V>

Overrides:

setFieldEditable in class ValuePickerImpl<V>

Parameters:

editable - true to enable manual input, false otherwise

See Also:

• ValuePicker.addFieldValueChangeListener(Consumer)

getFormatter

@Nullable
public Formatter<V> getFormatter()

Specified by:

getFormatter in interface HasFormatter<V>

Overrides:

getFormatter in class ValuePickerImpl<V>

setFormatter

public void setFormatter(@Nullable
 Formatter<? super V> formatter)

Specified by:

setFormatter in interface HasFormatter<V>

Overrides:

setFormatter in class ValuePickerImpl<V>

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>

setAutomaticPopupOnFocus

public void setAutomaticPopupOnFocus(boolean automaticPopupOnFocus)

Description copied from interface: ComboBox

When enabled popup automatically opens on focus.

Specified by:

setAutomaticPopupOnFocus in interface ComboBox<V>

isAutomaticPopupOnFocus

public boolean isAutomaticPopupOnFocus()

Specified by:

isAutomaticPopupOnFocus in interface ComboBox<V>

Returns:

whether popup is automatically shows on focus.

getEnterPressHandler

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

Specified by:

getEnterPressHandler in interface HasEnterPressHandler

Returns:

an ENTER press handler

setEnterPressHandler

public void setEnterPressHandler(@Nullable
 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(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

isNullOptionVisible

public boolean isNullOptionVisible()

Specified by:

isNullOptionVisible in interface ComboBox<V>

Returns:

true if first null element is visible.

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>

setOptionIconProvider

public void setOptionIconProvider(@Nullable
 Function<? super V,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 Function<? super V,String> getOptionIconProvider()

Specified by:

getOptionIconProvider in interface HasOptionIconProvider<V>

Returns:

options icon provider or null if not defined

generateOptionIcon

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

Overrides:

generateOptionIcon in class ValuePickerImpl<V>

getFieldIconProvider

@Nullable
public Function<? super V,String> getFieldIconProvider()

Specified by:

getFieldIconProvider in interface ValuePicker<V>

Overrides:

getFieldIconProvider in class ValuePickerImpl<V>

Returns:

an icon provider or {code null} if not set

setFieldIconProvider

public void setFieldIconProvider(@Nullable
 Function<? super V,String> iconProvider)

Description copied from interface: ValuePicker

Sets a function that provides an icon for the field.

Specified by:

setFieldIconProvider in interface ValuePicker<V>

Overrides:

setFieldIconProvider in class ValuePickerImpl<V>

Parameters:

iconProvider - icon provider to set

setOptionImageProvider

public void setOptionImageProvider(@Nullable
 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 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)

getOptionsCaptionFilter

@Nullable
public 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
 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 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
 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

setInputPrompt

public void setInputPrompt(@Nullable
 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

Overrides:

setInputPrompt in class ValuePickerImpl<V>

Parameters:

inputPrompt - input prompt

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

setOptionsContainer

public void setOptionsContainer(CollectionContainer<V> container)

Description copied from interface: SupportsOptionsContainer

Sets options from the passed CollectionContainer.

Specified by:

setOptionsContainer in interface SupportsOptionsContainer<V>

Parameters:

container - a CollectionContainer to be used as options source

See Also:

• ContainerOptions

setItemsToPresentation

protected void setItemsToPresentation(Stream<V> options)

filterItemTest

protected boolean filterItemTest(String itemCaption,
 String filterText)

getOptionCaptionProvider

@Nullable
public Function<? super V,String> getOptionCaptionProvider()

Specified by:

getOptionCaptionProvider in interface HasOptionCaptionProvider<V>

Returns:

caption provider for options

setOptionCaptionProvider

public void setOptionCaptionProvider(@Nullable
 Function<? super V,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

setOptionStyleProvider

public void setOptionStyleProvider(@Nullable
 Function<? super V,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 Function<? super V,String> getOptionStyleProvider()

Specified by:

getOptionStyleProvider in interface HasOptionStyleProvider<V>

Returns:

the currently used item style provider

checkValueType

protected void checkValueType(@Nullable
 V value)

Overrides:

checkValueType in class EntityPickerImpl<V>

componentValueChanged

protected void componentValueChanged(V prevComponentValue,
 V newComponentValue,
 boolean isUserOriginated)

Overrides:

componentValueChanged in class AbstractValueComponent<JmixPickerField<V>,V,V>