Package io.jmix.ui.component

Interface LogicalFilterComponent

All Superinterfaces:

Component, FilterComponent

All Known Subinterfaces:

GroupFilter

All Known Implementing Classes:

GroupFilterImpl

public interface LogicalFilterComponent
extends FilterComponent

Component which can contain other filter components and can be used for filtering entities returned by the DataLoader. The component is related to LogicalCondition which will be used together with query when loading entities into the DataLoader.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	LogicalFilterComponent.Operation	Operation representing corresponding logical filtering condition.

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

Field Summary

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

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Method Summary

Modifier and Type	Method	Description
void	add(FilterComponent filterComponent)	Adds a FilterComponent to the component.
List<FilterComponent>	getFilterComponents()
LogicalFilterComponent.Operation	getOperation()
List<FilterComponent>	getOwnFilterComponents()
LogicalCondition	getQueryCondition()
boolean	isOperationCaptionVisible()
void	remove(FilterComponent filterComponent)	Removes a FilterComponent from the component.
void	removeAll()	Removes all filter components from the component.
void	setOperation(LogicalFilterComponent.Operation operation)	Sets a filtering operation.
void	setOperationCaptionVisible(boolean operationCaptionVisible)	Sets whether to show operation caption.

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

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

Method Details

getQueryCondition

LogicalCondition getQueryCondition()

Specified by:

getQueryCondition in interface FilterComponent

Returns:

a LogicalCondition related to the current component

add

void add(FilterComponent filterComponent)

Adds a FilterComponent to the component. Updates the current LogicalCondition by adding a Condition from the FilterComponent.

Parameters:

filterComponent - a FilterComponent to add

See Also:

• FilterComponent.getQueryCondition()

remove

void remove(FilterComponent filterComponent)

Removes a FilterComponent from the component. Updates the current LogicalCondition.

Parameters:

filterComponent - a FilterComponent to remove

removeAll

void removeAll()

Removes all filter components from the component. Resets the current LogicalCondition.

getOwnFilterComponents

List<FilterComponent> getOwnFilterComponents()

Returns:

the list of filter components directly owned by the current component

getFilterComponents

List<FilterComponent> getFilterComponents()

Returns:

the list of filter components belonging to the whole components tree below this component

getOperation

LogicalFilterComponent.Operation getOperation()

Returns:

a filtering operation

setOperation

@StudioProperty(type=ENUMERATION,
                initialValue="AND",
                options={"AND","OR"},
                required=true)
void setOperation(LogicalFilterComponent.Operation operation)

Sets a filtering operation.

Parameters:

operation - a filtering operation

isOperationCaptionVisible

boolean isOperationCaptionVisible()

Returns:

whether to show operation caption

setOperationCaptionVisible

@StudioProperty(defaultValue="true")
void setOperationCaptionVisible(boolean operationCaptionVisible)

Sets whether to show operation caption.

Parameters:

operationCaptionVisible - whether to show operation caption