Package io.jmix.searchui.component.impl

Class SearchFieldImpl

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<String>

io.jmix.searchui.component.impl.SearchFieldImpl

All Implemented Interfaces:

SearchField, ActionsHolder, AttachNotifier, Buffered, Component, Component.BelongToFrame, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper, HasValueSource<String>, Field<String>, HasContextHelp, HasDebugId, HasFormatter<String>, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, HasInputPrompt, HasSubParts, HasValidator<String>, HasValue<String>, Requirable, SecuredActionsHolder, SupportsUserAction<String>, Validatable, ValuePicker<String>, org.springframework.beans.factory.InitializingBean

public class SearchFieldImpl
extends ValuePickerImpl<String>
implements SearchField

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

HasValue.ValueChangeEvent<V>

Nested classes/interfaces inherited from interface io.jmix.searchui.component.SearchField

SearchField.SearchCompletedEvent

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 List<String>	entities
protected EntitySearcher	entitySearcher
protected Messages	messages
protected ScreenBuilders	screenBuilders
static final String	SEARCH_FIELD_STYLENAME
protected Consumer<SearchField.SearchCompletedEvent>	searchCompletedHandler
protected SearchProperties	searchProperties
protected SearchStrategy	searchStrategy

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

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Fields inherited from interface io.jmix.searchui.component.SearchField

NAME

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

NAME, TYPE_STRING

Constructor Summary

Constructors

Constructor	Description
SearchFieldImpl()

Method Summary

Modifier and Type	Method	Description
List<String>	getEntities()
Consumer<SearchField.SearchCompletedEvent>	getSearchCompletedHandler()	Returns the handler to be invoked when the search is successfully completed.
SearchStrategy	getSearchStrategy()
String	getStyleName()	Styles implementation is client-type-specific.
protected void	initActions()
protected void	initComponent(JmixPickerField<String> component)
protected void	openSearchResultsWindow(SearchResult searchResult)
void	performSearch()	Performs search.
void	setEntities(List<String> entities)	Sets names of entities to search within.
void	setSearchCompletedHandler(Consumer<SearchField.SearchCompletedEvent> handler)	Sets the handler to be invoked when the search is successfully completed.
void	setSearchStrategy(SearchStrategy searchStrategy)	Sets SearchStrategy to this SearchField.
void	setStyleName(String name)	Sets one or more style names of the component, replacing any previous styles.

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

actionPropertyChanged, addAction, addAction, addFieldValueChangeListener, afterPropertiesSet, applyDefaultValueFormat, commit, createComponent, discard, focus, formatValue, generateOptionIcon, getAction, getActions, getActionsPermissions, getFieldIconProvider, getFormatter, getInputPrompt, getTabIndex, isBuffered, isFieldEditable, isModified, onFieldValueChange, refreshActionsState, removeAction, removeAction, removeAllActions, setBuffered, setButtonIcon, setDebugId, setEditableToComponent, setFieldEditable, setFieldIconProvider, setFormatter, setFrame, setInputPrompt, setMetadataTools, setTabIndex, setUiComponentProperties, setupButtonAction, setValue, setValueFromUser

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, componentValueChanged, 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, 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, setDescription, setDescriptionAsHtml, setEnabled, 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 io.jmix.ui.component.ActionsHolder

getActionNN, getSubPart

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

isFocusable, setFocusable

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

getRequiredMessage, isRequired, setRequired, setRequiredMessage

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

isValid, isValidateOnCommit, validate

Field Details

SEARCH_FIELD_STYLENAME

public static final String SEARCH_FIELD_STYLENAME

See Also:

• Constant Field Values

messages

@Autowired
protected Messages messages

entitySearcher

@Autowired
protected EntitySearcher entitySearcher

screenBuilders

@Autowired
protected ScreenBuilders screenBuilders

searchProperties

@Autowired
protected SearchProperties searchProperties

searchStrategy

protected SearchStrategy searchStrategy

entities

protected List<String> entities

searchCompletedHandler

protected Consumer<SearchField.SearchCompletedEvent> searchCompletedHandler

Constructor Details

SearchFieldImpl

public SearchFieldImpl()

Method Details

initComponent

protected void initComponent(JmixPickerField<String> component)

Overrides:

initComponent in class ValuePickerImpl<String>

initActions

protected void initActions()

openSearchResultsWindow

protected void openSearchResultsWindow(SearchResult searchResult)

performSearch

public void performSearch()

Description copied from interface: SearchField

Performs search.

Specified by:

performSearch in interface SearchField

getStyleName

public String getStyleName()

Description copied from interface: Component

Styles implementation is client-type-specific.

Specified by:

getStyleName in interface Component

Overrides:

getStyleName in class AbstractComponent<JmixPickerField<String>>

Returns:

current style name.

setStyleName

public void setStyleName(@Nullable
 String name)

Description copied from interface: Component

Sets one or more style names of the component, replacing any previous styles. Multiple styles can be specified as a space-separated list of style names. Styles implementation is client-type-specific.

Specified by:

setStyleName in interface Component

Overrides:

setStyleName in class AbstractComponent<JmixPickerField<String>>

Parameters:

name - one or more style names separated by space.

getSearchStrategy

public SearchStrategy getSearchStrategy()

Specified by:

getSearchStrategy in interface SearchField

Returns:

SearchStrategy related to this SearchField.

setSearchStrategy

public void setSearchStrategy(SearchStrategy searchStrategy)

Description copied from interface: SearchField

Sets SearchStrategy to this SearchField.

Specified by:

setSearchStrategy in interface SearchField

Parameters:

searchStrategy - SearchStrategy

getEntities

public List<String> getEntities()

Specified by:

getEntities in interface SearchField

Returns:

Names of entities configured to search within

setEntities

public void setEntities(List<String> entities)

Description copied from interface: SearchField

Sets names of entities to search within.

Specified by:

setEntities in interface SearchField

Parameters:

entities - List of entity names

setSearchCompletedHandler

public void setSearchCompletedHandler(Consumer<SearchField.SearchCompletedEvent> handler)

Description copied from interface: SearchField

Sets the handler to be invoked when the search is successfully completed.

The preferred way to set the handler is using a controller method annotated with Install, e.g.:

 @Install(to = "mySearchField", subject = "searchCompletedHandler")
 public void mySearchFieldSearchCompletedHandler(SearchField.SearchCompletedEvent event) {
     SearchResult searchResult = event.getSearchResult();
     //...
 }
 

Specified by:

setSearchCompletedHandler in interface SearchField

Parameters:

handler - handler

getSearchCompletedHandler

@Nullable
public Consumer<SearchField.SearchCompletedEvent> getSearchCompletedHandler()

Description copied from interface: SearchField

Returns the handler to be invoked when the search is successfully completed.

Specified by:

getSearchCompletedHandler in interface SearchField

Returns:

handler