Package io.jmix.searchui.component

Interface FullTextFilter

All Superinterfaces:

Component, Component.BelongToFrame, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, FilterComponent, HasContextHelp, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, HasValue<String>, Requirable, SingleFilterComponent<String>, SupportsCaptionPosition, Validatable

All Known Implementing Classes:

FullTextFilterImpl

@StudioComponent(caption="FullTextFilter",
                 category="Search",
                 xmlElement="fullTextFilter",
                 xmlns="http://jmix.io/schema/search/ui",
                 xmlnsAlias="search",
                 canvasBehaviour=FULL_TEXT_FILTER,
                 documentationURL="https://docs.jmix.io/jmix/%VERSION%/search/search-in-ui.html#full-text-filter",
                 unsupportedProperties="captionVisible")
public interface FullTextFilter
extends SingleFilterComponent<String>

FullTextFilter is a UI component used for filtering entities returned by the DataLoader by joining JPQL query results with the data returned from Elasticsearch. The component renders a TextField for entering full-text search criteria.

Nested Class Summary

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.ui.component.SupportsCaptionPosition

SupportsCaptionPosition.CaptionPosition

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

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

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Method Summary

Modifier and Type	Method	Description
SearchStrategy	getSearchStrategy()	Returns a SearchStrategy that will be used for searching using this component.
void	setSearchStrategy(SearchStrategy searchStrategy)

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

apply, getDataLoader, getQueryCondition, isAutoApply, isConditionModificationDelegated, setAutoApply, setConditionModificationDelegated, setDataLoader

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

addValueChangeListener, clear, getEmptyValue, getValue, isEmpty, setValue

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

getRequiredMessage, isRequired, setRequired, setRequiredMessage

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

getCaptionWidth, getCaptionWidthSizeUnit, getParameterName, getValueComponent, isCaptionVisible, setCaptionVisible, setCaptionWidth, setParameterName, setValueComponent

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

getCaptionPosition, setCaptionPosition

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

isValid, isValidateOnCommit, validate

Field Details

NAME

static final String NAME

See Also:

• Constant Field Values

Method Details

getSearchStrategy

@Nullable
SearchStrategy getSearchStrategy()

Returns a SearchStrategy that will be used for searching using this component. If no explicit strategy is set to the full-text filter then a default strategy will be used.

Returns:

a SearchStrategy or null if the strategy is not explicitly set

See Also:

• SearchStrategyManager.getDefaultSearchStrategy()

setSearchStrategy

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