com.haulmont.cuba.web.gui.components

Class WebSearchField<V extends io.jmix.core.Entity>

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<io.jmix.ui.widget.JmixComboBox<V>,V,V>

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

com.haulmont.cuba.web.gui.components.WebLookupField<V>

com.haulmont.cuba.web.gui.components.WebSearchField<V>

All Implemented Interfaces:

DatasourceComponent<V>, HasCaptionMode, HasOptionsStyleProvider<V>, LookupField<V>, SearchField<V>, io.jmix.ui.component.AttachNotifier, io.jmix.ui.component.Buffered, io.jmix.ui.component.ComboBox<V>, io.jmix.ui.component.Component, io.jmix.ui.component.Component.BelongToFrame, io.jmix.ui.component.Component.Editable, io.jmix.ui.component.Component.Focusable, io.jmix.ui.component.Component.HasCaption, io.jmix.ui.component.Component.HasDescription, io.jmix.ui.component.Component.HasIcon, io.jmix.ui.component.Component.HasXmlDescriptor, io.jmix.ui.component.Component.Wrapper, io.jmix.ui.component.data.HasValueSource<V>, io.jmix.ui.component.Field<V>, io.jmix.ui.component.HasContextHelp, io.jmix.ui.component.HasDebugId, io.jmix.ui.component.HasEnterPressHandler, io.jmix.ui.component.HasFilterMode, io.jmix.ui.component.HasHtmlCaption, io.jmix.ui.component.HasHtmlDescription, io.jmix.ui.component.HasHtmlSanitizer, io.jmix.ui.component.HasInputPrompt, io.jmix.ui.component.HasOptionCaptionProvider<V>, io.jmix.ui.component.HasOptionIconProvider<V>, io.jmix.ui.component.HasOptionImageProvider<V>, io.jmix.ui.component.HasOptionStyleProvider<V>, io.jmix.ui.component.HasValidator<V>, io.jmix.ui.component.HasValue<V>, io.jmix.ui.component.LookupComponent<V>, io.jmix.ui.component.OptionsField<V,V>, io.jmix.ui.component.Requirable, io.jmix.ui.component.Validatable, org.springframework.beans.factory.InitializingBean

Deprecated.

@Deprecated
public class WebSearchField<V extends io.jmix.core.Entity>
extends WebLookupField<V>
implements SearchField<V>

Nested Class Summary

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.SearchField

SearchField.Mode, SearchField.SearchNotifications

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.LookupField

LookupField.FilterPredicate, LookupField.NewOptionHandler, LookupField.OptionIconProvider<T>

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.Field

Field.Validator<T>

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

io.jmix.ui.component.ComboBox.OptionsCaptionFilteringContext

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

io.jmix.ui.component.HasValue.ValueChangeEvent<V>

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

io.jmix.ui.component.Component.Alignment, io.jmix.ui.component.Component.BelongToFrame, io.jmix.ui.component.Component.Disposable, io.jmix.ui.component.Component.Editable, io.jmix.ui.component.Component.Focusable, io.jmix.ui.component.Component.HasCaption, io.jmix.ui.component.Component.HasDescription, io.jmix.ui.component.Component.HasIcon, io.jmix.ui.component.Component.HasXmlDescriptor, io.jmix.ui.component.Component.Wrapper

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

io.jmix.ui.component.HasContextHelp.ContextHelpIconClickEvent

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

io.jmix.ui.component.HasFilterMode.FilterMode

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

io.jmix.ui.component.HasEnterPressHandler.EnterPressEvent

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.LookupComponent

LookupComponent.LookupSelectionChangeNotifier<T>

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

io.jmix.ui.component.LookupComponent.LookupSelectionChangeEvent<T>

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.HasOptionsStyleProvider

HasOptionsStyleProvider.OptionsStyleProvider

Field Summary

Fields

Modifier and Type	Field and Description
protected Frame.NotificationType	defaultNotificationType Deprecated.
protected boolean	escapeValueForLike Deprecated.
protected int	minSearchStringLength Deprecated.
protected SearchField.Mode	mode Deprecated.
protected SearchField.SearchNotifications	searchNotifications Deprecated.
protected static java.lang.String	SEARCHSELECT_STYLENAME Deprecated.

Fields inherited from class com.haulmont.cuba.web.gui.components.WebLookupField

nullOption

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

enterPressHandler, filterMode, iconResolver, metadataTools, NULL_ITEM_ICON_GENERATOR, NULL_STYLE_GENERATOR, nullOptionVisible, optionCaptionProvider, optionIconProvider, optionImageProvider, optionsBinding, optionsCaptionFilter, 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 com.haulmont.cuba.gui.components.SearchField

NAME, SEARCH_STRING_PARAM

Fields inherited from interface com.haulmont.cuba.gui.components.LookupField

TYPE_STRING

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

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Constructor Summary

Constructors

Constructor and Description
WebSearchField() Deprecated.

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet() Deprecated.
protected io.jmix.ui.widget.JmixComboBox<V>	createComponent() Deprecated.
protected SearchField.SearchNotifications	createSearchNotifications() Deprecated.
protected void	executeSearch(java.lang.String newFilter) Deprecated.
Frame.NotificationType	getDefaultNotificationType() Deprecated.
int	getMinSearchStringLength() Deprecated.
SearchField.Mode	getMode() Deprecated.
protected io.jmix.ui.widget.JmixSearchSelect<V>	getSearchComponent() Deprecated.
SearchField.SearchNotifications	getSearchNotifications() Deprecated.
java.lang.String	getStyleName() Deprecated.
protected void	initComponent(io.jmix.ui.widget.JmixSearchSelect<V> component) Deprecated.
boolean	isEscapeValueForLike() Deprecated.
void	setDefaultNotificationType(Frame.NotificationType defaultNotificationType) Deprecated. 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) Deprecated. Sets whether special symbols (like %, \, _) should be escaped in a search string.
void	setMinSearchStringLength(int searchStringLength) Deprecated. Sets minimal required search string length.
void	setMode(SearchField.Mode mode) Deprecated. Sets whether search string case should be considered or it should be converted to upper or lower case.
void	setOptions(io.jmix.ui.component.data.Options<V> options) Deprecated.
void	setOptionsEnum(java.lang.Class<V> optionsEnum) Deprecated.
void	setOptionsList(java.util.List optionsList) Deprecated.
void	setOptionsMap(java.util.Map<java.lang.String,V> map) Deprecated.
void	setSearchNotifications(SearchField.SearchNotifications searchNotifications) Deprecated. Sets notifications configuration object that determines what messages will be shown in case of too small search string or absence of matches.
void	setStyleName(java.lang.String styleName) Deprecated.
void	setTextInputAllowed(boolean textInputAllowed) Deprecated.

Methods inherited from class com.haulmont.cuba.web.gui.components.WebLookupField

addValidator, getLookupSelectedItems, getNewOptionHandler, getNullOption, isNewOptionAllowed, removeValidator, setLookupSelectHandler, setNewOptionAllowed, setNewOptionHandler, setNullOption, setOptionIconProvider

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

commit, discard, filterItemTest, focus, generateDefaultItemCaption, generateItemCaption, generateItemStylename, generateOptionIcon, generateOptionImage, getEnterPressHandler, getFilterMode, getInputPrompt, getNullSelectionCaption, getOptionCaptionProvider, getOptionIconProvider, getOptionImageProvider, getOptions, getOptionsCaptionFilter, getOptionStyleProvider, getPageLength, getPopupWidth, getTabIndex, getValue, handleClearShortcut, initComponent, isAutomaticPopupOnFocus, isBuffered, isModified, isNullOptionVisible, isTextInputAllowed, onEnterPressed, setAutomaticPopupOnFocus, setBuffered, setEnterPressHandler, setFilterMode, setIconResolver, setInputPrompt, setItemsToPresentation, setMetadataTools, setNullOptionVisible, setNullSelectionCaption, setOptionCaptionProvider, setOptionIconProvider, setOptionImageProvider, setOptionsCaptionFilter, setOptionStyleProvider, setPageLength, setPopupWidth, setRequired, setTabIndex, valueBindingConnected

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, 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, 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 com.haulmont.cuba.gui.components.SearchField

of

Methods inherited from interface com.haulmont.cuba.gui.components.LookupField

getFilterPredicate, getNewOptionHandler, getNullOption, isNewOptionAllowed, setFilterPredicate, setNewOptionAllowed, setNewOptionHandler, setNullOption, setOptionIconProvider

Methods inherited from interface com.haulmont.cuba.gui.components.OptionsField

getOptionsDatasource, getOptionsEnum, getOptionsList, getOptionsMap, setOptionsDatasource

Methods inherited from interface com.haulmont.cuba.gui.components.Field

addValidator, addValidators, getDatasource, getMetaProperty, getMetaPropertyPath, removeValidator, setDatasource

Methods inherited from interface com.haulmont.cuba.gui.components.HasCaptionMode

getCaptionMode, getCaptionProperty, setCaptionMode, setCaptionProperty

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

getNullSelectionCaption, getOptionsCaptionFilter, getPageLength, getPopupWidth, isAutomaticPopupOnFocus, isNullOptionVisible, isTextInputAllowed, setAutomaticPopupOnFocus, setNullOptionVisible, setNullSelectionCaption, setOptionsCaptionFilter, setPageLength, setPopupWidth

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

getOptions

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

getValueSource, setValueSource

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

addValueChangeListener, clear, getEmptyValue, getValue, 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, getWidth, getWidthSizeUnit, isEnabled, isEnabledRecursive, isResponsive, isVisible, isVisibleRecursive, removeStyleName, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, 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.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, setRequired, setRequiredMessage

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

getOptionCaptionProvider, setOptionCaptionProvider

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

getInputPrompt, setInputPrompt

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

commit, discard, isBuffered, isModified, setBuffered

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

focus, getTabIndex, isFocusable, setFocusable, setTabIndex

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

getOptionIconProvider, setOptionIconProvider

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

getOptionImageProvider, setOptionImageProvider

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

getFilterMode, setFilterMode

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

getEnterPressHandler, setEnterPressHandler

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

getLookupSelectedItems, setLookupSelectHandler

Methods inherited from interface com.haulmont.cuba.gui.components.HasOptionsStyleProvider

getOptionsStyleProvider, setOptionsStyleProvider

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

getOptionStyleProvider, setOptionStyleProvider

Field Detail

SEARCHSELECT_STYLENAME

protected static final java.lang.String SEARCHSELECT_STYLENAME

Deprecated.

See Also:

Constant Field Values

minSearchStringLength

protected int minSearchStringLength

Deprecated.

mode

protected SearchField.Mode mode

Deprecated.

escapeValueForLike

protected boolean escapeValueForLike

Deprecated.

defaultNotificationType

protected Frame.NotificationType defaultNotificationType

Deprecated.

searchNotifications

protected SearchField.SearchNotifications searchNotifications

Deprecated.

Constructor Detail

WebSearchField

public WebSearchField()

Deprecated.

Method Detail

createComponent

protected io.jmix.ui.widget.JmixComboBox<V> createComponent()

Deprecated.

Overrides:

createComponent in class io.jmix.ui.component.impl.ComboBoxImpl<V extends io.jmix.core.Entity>

afterPropertiesSet

public void afterPropertiesSet()

Deprecated.

Specified by:

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

Overrides:

afterPropertiesSet in class io.jmix.ui.component.impl.ComboBoxImpl<V extends io.jmix.core.Entity>

initComponent

protected void initComponent(io.jmix.ui.widget.JmixSearchSelect<V> component)

Deprecated.

createSearchNotifications

protected SearchField.SearchNotifications createSearchNotifications()

Deprecated.

executeSearch

protected void executeSearch(java.lang.String newFilter)

Deprecated.

getSearchComponent

protected io.jmix.ui.widget.JmixSearchSelect<V> getSearchComponent()

Deprecated.

setStyleName

public void setStyleName(java.lang.String styleName)

Deprecated.

Specified by:

setStyleName in interface io.jmix.ui.component.Component

Overrides:

setStyleName in class io.jmix.ui.component.impl.AbstractComponent<io.jmix.ui.widget.JmixComboBox<V extends io.jmix.core.Entity>>

getStyleName

public java.lang.String getStyleName()

Deprecated.

Specified by:

getStyleName in interface io.jmix.ui.component.Component

Overrides:

getStyleName in class io.jmix.ui.component.impl.AbstractComponent<io.jmix.ui.widget.JmixComboBox<V extends io.jmix.core.Entity>>

getMinSearchStringLength

public int getMinSearchStringLength()

Deprecated.

Specified by:

getMinSearchStringLength in interface SearchField<V extends io.jmix.core.Entity>

Returns:

minimal required search string length

setMinSearchStringLength

public void setMinSearchStringLength(int searchStringLength)

Deprecated.

Description copied from interface: SearchField

Sets minimal required search string length.

Specified by:

setMinSearchStringLength in interface SearchField<V extends io.jmix.core.Entity>

Parameters:

searchStringLength - minimal string length

getSearchNotifications

public SearchField.SearchNotifications getSearchNotifications()

Deprecated.

Specified by:

getSearchNotifications in interface SearchField<V extends io.jmix.core.Entity>

Returns:

notifications configuration object

setSearchNotifications

public void setSearchNotifications(SearchField.SearchNotifications searchNotifications)

Deprecated.

Description copied from interface: SearchField

Sets notifications configuration object that determines what messages will be shown in case of too small search string or absence of matches.

Frame.NotificationType.TRAY is the default value.

Specified by:

setSearchNotifications in interface SearchField<V extends io.jmix.core.Entity>

Parameters:

searchNotifications - SearchField.SearchNotifications instance

getDefaultNotificationType

public Frame.NotificationType getDefaultNotificationType()

Deprecated.

Specified by:

getDefaultNotificationType in interface SearchField<V extends io.jmix.core.Entity>

Returns:

notification type

setDefaultNotificationType

public void setDefaultNotificationType(Frame.NotificationType defaultNotificationType)

Deprecated.

Description copied from interface: SearchField

Sets a type of notifications (TRAY, WARNING, etc) that will be shown in case of too small search string or absence of matches.

Specified by:

setDefaultNotificationType in interface SearchField<V extends io.jmix.core.Entity>

Parameters:

defaultNotificationType - notification type

getMode

public SearchField.Mode getMode()

Deprecated.

Specified by:

getMode in interface SearchField<V extends io.jmix.core.Entity>

Returns:

search string case mode

setMode

public void setMode(SearchField.Mode mode)

Deprecated.

Description copied from interface: SearchField

Sets whether search string case should be considered or it should be converted to upper or lower case.

SearchField.Mode.CASE_SENSITIVE is the default mode.

Specified by:

setMode in interface SearchField<V extends io.jmix.core.Entity>

Parameters:

mode - search mode

isEscapeValueForLike

public boolean isEscapeValueForLike()

Deprecated.

Specified by:

isEscapeValueForLike in interface SearchField<V extends io.jmix.core.Entity>

Returns:

whether special symbols (like %, \, _) should be escaped in a search string.

setEscapeValueForLike

public void setEscapeValueForLike(boolean escapeValueForLike)

Deprecated.

Description copied from interface: SearchField

Sets whether special symbols (like %, \, _) should be escaped in a search string.

Specified by:

setEscapeValueForLike in interface SearchField<V extends io.jmix.core.Entity>

Parameters:

escapeValueForLike - escape special symbols if true, don't otherwise

setTextInputAllowed

public void setTextInputAllowed(boolean textInputAllowed)

Deprecated.

Specified by:

setTextInputAllowed in interface io.jmix.ui.component.ComboBox<V extends io.jmix.core.Entity>

Overrides:

setTextInputAllowed in class io.jmix.ui.component.impl.ComboBoxImpl<V extends io.jmix.core.Entity>

setOptionsList

public void setOptionsList(java.util.List optionsList)

Deprecated.

Specified by:

setOptionsList in interface io.jmix.ui.component.OptionsField<V extends io.jmix.core.Entity,V extends io.jmix.core.Entity>

setOptionsMap

public void setOptionsMap(java.util.Map<java.lang.String,V> map)

Deprecated.

Specified by:

setOptionsMap in interface io.jmix.ui.component.OptionsField<V extends io.jmix.core.Entity,V extends io.jmix.core.Entity>

setOptionsEnum

public void setOptionsEnum(java.lang.Class<V> optionsEnum)

Deprecated.

Specified by:

setOptionsEnum in interface io.jmix.ui.component.OptionsField<V extends io.jmix.core.Entity,V extends io.jmix.core.Entity>

setOptions

public void setOptions(io.jmix.ui.component.data.Options<V> options)

Deprecated.

Specified by:

setOptions in interface io.jmix.ui.component.OptionsField<V extends io.jmix.core.Entity,V extends io.jmix.core.Entity>

Overrides:

setOptions in class io.jmix.ui.component.impl.ComboBoxImpl<V extends io.jmix.core.Entity>