Package io.jmix.flowui.component.logicalfilter

Interface LogicalFilterComponent<C extends com.vaadin.flow.component.Component & LogicalFilterComponent<C>>

All Superinterfaces:

FilterComponent, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasStyle, Serializable

All Known Implementing Classes:

GroupFilter

public interface LogicalFilterComponent<C extends com.vaadin.flow.component.Component & LogicalFilterComponent<C>>
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 class	LogicalFilterComponent.FilterComponentsChangeEvent<C extends com.vaadin.flow.component.Component & LogicalFilterComponent<C>>
static enum	LogicalFilterComponent.Operation	Operation representing corresponding logical filtering condition.

Method Summary

Modifier and Type	Method	Description
void	add(FilterComponent filterComponent)	Adds a FilterComponent to the component.
com.vaadin.flow.shared.Registration	addFilterComponentsChangeListener(com.vaadin.flow.component.ComponentEventListener<LogicalFilterComponent.FilterComponentsChangeEvent<C>> listener)
List<FilterComponent>	getFilterComponents()
LogicalFilterComponent.Operation	getOperation()
List<FilterComponent>	getOwnFilterComponents()
LogicalCondition	getQueryCondition()
boolean	isOperationTextVisible()
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	setOperationTextVisible(boolean operationTextVisible)	Sets whether to show operation caption.

Methods inherited from interface io.jmix.flowui.component.filter.FilterComponent

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

Methods inherited from interface com.vaadin.flow.component.HasElement

getElement

Methods inherited from interface com.vaadin.flow.component.HasEnabled

isEnabled, setEnabled

Methods inherited from interface com.vaadin.flow.component.HasStyle

addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

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

void setOperation(LogicalFilterComponent.Operation operation)

Sets a filtering operation.

Parameters:

operation - a filtering operation

isOperationTextVisible

boolean isOperationTextVisible()

Returns:

whether to show operation caption

setOperationTextVisible

void setOperationTextVisible(boolean operationTextVisible)

Sets whether to show operation caption.

Parameters:

operationTextVisible - whether to show operation caption

addFilterComponentsChangeListener

com.vaadin.flow.shared.Registration addFilterComponentsChangeListener(com.vaadin.flow.component.ComponentEventListener<LogicalFilterComponent.FilterComponentsChangeEvent<C>> listener)