io.jmix.searchui.component.impl

Class SearchFieldImpl

java.lang.Object

io.jmix.ui.component.CompositeComponent<io.jmix.ui.component.CssLayout>

io.jmix.searchui.component.impl.SearchFieldImpl

All Implemented Interfaces:

SearchField, io.jmix.ui.component.AttachNotifier, io.jmix.ui.component.Component, io.jmix.ui.component.Component.BelongToFrame, io.jmix.ui.component.Component.Editable, io.jmix.ui.component.Component.HasCaption, io.jmix.ui.component.Component.HasDescription, io.jmix.ui.component.Component.HasIcon, io.jmix.ui.component.CompositeWithCaption, io.jmix.ui.component.CompositeWithContextHelp, io.jmix.ui.component.CompositeWithDescription, io.jmix.ui.component.CompositeWithHtmlCaption, io.jmix.ui.component.CompositeWithHtmlDescription, io.jmix.ui.component.CompositeWithIcon, io.jmix.ui.component.data.HasValueSource<java.lang.String>, io.jmix.ui.component.Field<java.lang.String>, io.jmix.ui.component.HasContextHelp, io.jmix.ui.component.HasDebugId, io.jmix.ui.component.HasHtmlCaption, io.jmix.ui.component.HasHtmlDescription, io.jmix.ui.component.HasHtmlSanitizer, io.jmix.ui.component.HasValidator<java.lang.String>, io.jmix.ui.component.HasValue<java.lang.String>, io.jmix.ui.component.Requirable, io.jmix.ui.component.Validatable

public class SearchFieldImpl
extends io.jmix.ui.component.CompositeComponent<io.jmix.ui.component.CssLayout>
implements SearchField, io.jmix.ui.component.CompositeWithCaption, io.jmix.ui.component.CompositeWithHtmlCaption, io.jmix.ui.component.CompositeWithHtmlDescription, io.jmix.ui.component.CompositeWithIcon, io.jmix.ui.component.CompositeWithContextHelp

Nested Class Summary

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

io.jmix.ui.component.CompositeComponent.CreateEvent

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

SearchField.SearchCompletedEvent

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

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<java.lang.String>	entities
protected EntitySearcher	entitySearcher
protected io.jmix.ui.component.TextField<java.lang.String>	inputField
protected io.jmix.core.Messages	messages
protected io.jmix.ui.ScreenBuilders	screenBuilders
protected io.jmix.ui.component.Button	searchButton
protected java.util.function.Consumer<SearchField.SearchCompletedEvent>	searchCompletedHandler
protected SearchProperties	searchProperties
protected SearchStrategy	searchStrategy

Fields inherited from class io.jmix.ui.component.CompositeComponent

applicationContext, frame, id, prefixId, root

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

NAME

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

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Constructor Summary

Constructors

Constructor and Description
SearchFieldImpl()

Method Summary

Modifier and Type	Method and Description
void	addValidator(io.jmix.ui.component.validation.Validator<? super java.lang.String> validator)
io.jmix.core.common.event.Subscription	addValueChangeListener(java.util.function.Consumer<io.jmix.ui.component.HasValue.ValueChangeEvent<java.lang.String>> listener)
java.util.List<java.lang.String>	getEntities()
java.lang.String	getRequiredMessage()
java.util.function.Consumer<SearchField.SearchCompletedEvent>	getSearchCompletedHandler() Returns the handler to be invoked when the search is successfully completed.
SearchStrategy	getSearchStrategy()
java.util.Collection<io.jmix.ui.component.validation.Validator<java.lang.String>>	getValidators()
java.lang.String	getValue()
io.jmix.ui.component.data.ValueSource<java.lang.String>	getValueSource()
boolean	isEditable()
boolean	isRequired()
boolean	isValid()
protected void	onCreate(io.jmix.ui.component.CompositeComponent.CreateEvent createEvent)
protected void	openSearchResultsWindow(SearchResult searchResult)
void	performSearch() Performs search.
void	removeValidator(io.jmix.ui.component.validation.Validator<java.lang.String> validator)
void	setEditable(boolean editable)
void	setEntities(java.util.List<java.lang.String> entities) Sets names of entities to search within.
void	setRequired(boolean required)
void	setRequiredMessage(java.lang.String msg)
void	setSearchCompletedHandler(java.util.function.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	setValue(java.lang.String value)
void	setValueSource(io.jmix.ui.component.data.ValueSource<java.lang.String> valueSource)
void	validate()

Methods inherited from class io.jmix.ui.component.CompositeComponent

addAttachListener, addCreateListener, addDetachListener, addStyleName, assignDebugId, attached, detached, disableEventListeners, enableEventListeners, getAlignment, getComposition, getCompositionOrNull, getDebugId, getEventHub, getFrame, getFullId, getHeight, getHeightSizeUnit, getId, getInnerComponent, getInnerComponentOptional, getParent, getPrefixId, getStyleName, getUiEventListeners, getWidth, getWidthSizeUnit, hasSubscriptions, isAttached, isEnabled, isEnabledRecursive, isHtmlSanitizerEnabled, isResponsive, isVisible, isVisibleRecursive, publish, removeStyleName, setAlignment, setApplicationContext, setComposition, setDebugId, setEnabled, setFrame, setHeight, setHtmlSanitizerEnabled, setId, setParent, setResponsive, setStyleName, setUiEventListeners, setVisible, setWidth, unsubscribe, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, updateComponentIds, updateIdIfNeeded, 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.HasValue

clear, getEmptyValue, isEmpty

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

isEditableWithParent

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

isValidateOnCommit

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

addValidators

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

isCaptionAsHtml, setCaptionAsHtml

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

getCaption, setCaption

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

getDescription, setDescription

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

isDescriptionAsHtml, setDescriptionAsHtml

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

getIcon, setIcon, setIconFromSet

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

getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled

Field Detail

messages

@Autowired
protected io.jmix.core.Messages messages

entitySearcher

@Autowired
protected EntitySearcher entitySearcher

screenBuilders

@Autowired
protected io.jmix.ui.ScreenBuilders screenBuilders

searchProperties

@Autowired
protected SearchProperties searchProperties

inputField

protected io.jmix.ui.component.TextField<java.lang.String> inputField

searchButton

protected io.jmix.ui.component.Button searchButton

searchStrategy

protected SearchStrategy searchStrategy

entities

protected java.util.List<java.lang.String> entities

searchCompletedHandler

protected java.util.function.Consumer<SearchField.SearchCompletedEvent> searchCompletedHandler

Constructor Detail

SearchFieldImpl

public SearchFieldImpl()

Method Detail

onCreate

protected void onCreate(io.jmix.ui.component.CompositeComponent.CreateEvent createEvent)

openSearchResultsWindow

protected void openSearchResultsWindow(SearchResult searchResult)

performSearch

public void performSearch()

Description copied from interface: SearchField

Performs search.

Specified by:

performSearch in interface SearchField

isEditable

public boolean isEditable()

Specified by:

isEditable in interface io.jmix.ui.component.Component.Editable

setEditable

public void setEditable(boolean editable)

Specified by:

setEditable in interface io.jmix.ui.component.Component.Editable

addValidator

public void addValidator(io.jmix.ui.component.validation.Validator<? super java.lang.String> validator)

Specified by:

addValidator in interface io.jmix.ui.component.HasValidator<java.lang.String>

removeValidator

public void removeValidator(io.jmix.ui.component.validation.Validator<java.lang.String> validator)

Specified by:

removeValidator in interface io.jmix.ui.component.HasValidator<java.lang.String>

getValidators

public java.util.Collection<io.jmix.ui.component.validation.Validator<java.lang.String>> getValidators()

Specified by:

getValidators in interface io.jmix.ui.component.HasValidator<java.lang.String>

getValue

@Nullable
public java.lang.String getValue()

Specified by:

getValue in interface io.jmix.ui.component.HasValue<java.lang.String>

setValue

public void setValue(@Nullable
                     java.lang.String value)

Specified by:

setValue in interface io.jmix.ui.component.HasValue<java.lang.String>

addValueChangeListener

public io.jmix.core.common.event.Subscription addValueChangeListener(java.util.function.Consumer<io.jmix.ui.component.HasValue.ValueChangeEvent<java.lang.String>> listener)

Specified by:

addValueChangeListener in interface io.jmix.ui.component.HasValue<java.lang.String>

isRequired

public boolean isRequired()

Specified by:

isRequired in interface io.jmix.ui.component.Requirable

setRequired

public void setRequired(boolean required)

Specified by:

setRequired in interface io.jmix.ui.component.Requirable

getRequiredMessage

@Nullable
public java.lang.String getRequiredMessage()

Specified by:

getRequiredMessage in interface io.jmix.ui.component.Requirable

setRequiredMessage

public void setRequiredMessage(@Nullable
                               java.lang.String msg)

Specified by:

setRequiredMessage in interface io.jmix.ui.component.Requirable

isValid

public boolean isValid()

Specified by:

isValid in interface io.jmix.ui.component.Validatable

validate

public void validate()
              throws io.jmix.ui.component.ValidationException

Specified by:

validate in interface io.jmix.ui.component.Validatable

Throws:

io.jmix.ui.component.ValidationException

setValueSource

public void setValueSource(@Nullable
                           io.jmix.ui.component.data.ValueSource<java.lang.String> valueSource)

Specified by:

setValueSource in interface io.jmix.ui.component.data.HasValueSource<java.lang.String>

getValueSource

@Nullable
public io.jmix.ui.component.data.ValueSource<java.lang.String> getValueSource()

Specified by:

getValueSource in interface io.jmix.ui.component.data.HasValueSource<java.lang.String>

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 java.util.List<java.lang.String> getEntities()

Specified by:

getEntities in interface SearchField

Returns:

Names of entities configured to search within

setEntities

public void setEntities(java.util.List<java.lang.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(java.util.function.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 java.util.function.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