io.jmix.searchui.component

Interface SearchField

All Superinterfaces:

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.Field<java.lang.String>, io.jmix.ui.component.HasContextHelp, 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.data.HasValueSource<java.lang.String>, io.jmix.ui.component.Requirable, io.jmix.ui.component.Validatable

All Known Implementing Classes:

SearchFieldImpl

@StudioComponent(caption="SearchField",
                 category="Search",
                 xmlElement="searchField",
                 xmlns="http://jmix.io/schema/search/ui",
                 xmlnsAlias="search",
                 icon="io/jmix/searchui/icon/searchField.svg",
                 canvasBehaviour=SEARCH_FIELD,
                 documentationURL="https://docs.jmix.io/jmix/%VERSION%/search/search-in-ui.html",
                 unsupportedProperties={"colspan","rowspan"})
public interface SearchField
extends io.jmix.ui.component.Field<java.lang.String>

UI component that performs full text search

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	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
static java.lang.String	NAME

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

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getEntities()
java.util.function.Consumer<SearchField.SearchCompletedEvent>	getSearchCompletedHandler() Returns the handler to be invoked when the search is successfully completed.
SearchStrategy	getSearchStrategy()
void	performSearch() Performs search.
void	setEntities(java.util.List<java.lang.String> entities) Sets names of entities to search within.
void	setSearchCompletedHandler(java.util.function.Consumer<SearchField.SearchCompletedEvent> handler) Sets the handler to be invoked when the search is successfully completed.
void	setSearchStrategy(SearchStrategy strategy) Sets SearchStrategy to this SearchField.

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, 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, setRequired, setRequiredMessage

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

getSearchStrategy

SearchStrategy getSearchStrategy()

Returns:

SearchStrategy related to this SearchField.

setSearchStrategy

@StudioProperty(name="strategy",
                type=STRING,
                defaultValue="anyTermAnyField",
                options={"anyTermAnyField","allTermsAnyField","allTermsSingleField","phrase"})
void setSearchStrategy(SearchStrategy strategy)

Sets SearchStrategy to this SearchField.

Parameters:

strategy - SearchStrategy

getEntities

java.util.List<java.lang.String> getEntities()

Returns:

Names of entities configured to search within

setEntities

@StudioProperty(name="entities",
                type=ENTITY_NAMES)
void setEntities(java.util.List<java.lang.String> entities)

Sets names of entities to search within.

Parameters:

entities - List of entity names

performSearch

void performSearch()

Performs search.

setSearchCompletedHandler

void setSearchCompletedHandler(java.util.function.Consumer<SearchField.SearchCompletedEvent> handler)

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();
     //...
 }
 

Parameters:

handler - handler

getSearchCompletedHandler

java.util.function.Consumer<SearchField.SearchCompletedEvent> getSearchCompletedHandler()

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

Returns:

handler