Package io.jmix.flowui.component.logicalfilter

Class GroupFilter

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.Composite<com.vaadin.flow.component.orderedlayout.VerticalLayout>

io.jmix.flowui.component.logicalfilter.GroupFilter

All Implemented Interfaces:

com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasStyle, FilterComponent, LogicalFilterComponent<GroupFilter>, SupportsResponsiveSteps, Serializable, org.springframework.beans.factory.Aware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware

public class GroupFilter
extends com.vaadin.flow.component.Composite<com.vaadin.flow.component.orderedlayout.VerticalLayout>
implements LogicalFilterComponent<GroupFilter>, SupportsResponsiveSteps, org.springframework.context.ApplicationContextAware, org.springframework.beans.factory.InitializingBean

This component can contain FilterComponents and can be used for filtering entities returned by the DataLoader.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface io.jmix.flowui.component.logicalfilter.LogicalFilterComponent

LogicalFilterComponent.FilterComponentsChangeEvent<C extends com.vaadin.flow.component.Component & LogicalFilterComponent<C>>, LogicalFilterComponent.Operation

Nested classes/interfaces inherited from interface io.jmix.flowui.component.SupportsResponsiveSteps

SupportsResponsiveSteps.ResponsiveStep

Field Summary

Fields

Modifier and Type	Field	Description
protected org.springframework.context.ApplicationContext	applicationContext
protected boolean	autoApply
protected boolean	conditionModificationDelegated
protected com.vaadin.flow.component.formlayout.FormLayout	conditionsLayout
protected DataLoader	dataLoader
protected Map<FilterComponent,com.vaadin.flow.component.formlayout.FormLayout.FormItem>	filterComponentFormItemMap
protected static final String	GROUP_FILTER_CLASS_NAME
protected Condition	initialDataLoaderCondition
protected boolean	initialDataLoaderConditionInitialized
protected Condition	lastConditionSetByFilter
protected Runnable	loaderConditionRecomposeDelegate
protected LogicalFilterSupport	logicalFilterSupport
protected LogicalFilterComponent.Operation	operation
protected Map<FilterComponent,com.vaadin.flow.shared.Registration>	operationChangeRegistrations
protected boolean	operationTextVisible
protected List<FilterComponent>	ownFilterComponentsOrder
protected LogicalCondition	queryCondition
protected List<SupportsResponsiveSteps.ResponsiveStep>	responsiveSteps
protected com.vaadin.flow.component.html.Div	summaryComponent
protected String	summaryText
protected UiComponents	uiComponents

Constructor Summary

Constructors

Constructor	Description
GroupFilter()

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<GroupFilter>> listener)
protected void	addFilterComponentToConditionsLayout(com.vaadin.flow.component.formlayout.FormLayout conditionsLayout, FilterComponent filterComponent)
void	afterPropertiesSet()
void	apply()	Applies the current filter component condition.
protected void	autowireDependencies()
protected @Nullable Condition	copy(@Nullable Condition condition)
protected com.vaadin.flow.component.formlayout.FormLayout	createConditionsLayout()
protected com.vaadin.flow.component.html.Div	createSummaryComponent()
protected void	fireFilterComponentsChanged()
DataLoader	getDataLoader()
List<FilterComponent>	getFilterComponents()
LogicalFilterComponent.Operation	getOperation()
List<FilterComponent>	getOwnFilterComponents()
LogicalCondition	getQueryCondition()
List<SupportsResponsiveSteps.ResponsiveStep>	getResponsiveSteps()	Get the list of SupportsResponsiveSteps.ResponsiveSteps used to configure this layout.
protected @Nullable com.vaadin.flow.component.html.Div	getSummaryComponent()
@Nullable String	getSummaryText()
protected void	initComponent()
protected void	initConditionsLayout(com.vaadin.flow.component.formlayout.FormLayout layout)
protected com.vaadin.flow.component.orderedlayout.VerticalLayout	initContent()
protected void	initDefaultResponsiveSteps()
protected void	initLayout()
protected void	initSummaryComponent(com.vaadin.flow.component.html.Div summaryComponent)
protected boolean	isAnyFilterComponentVisible()
boolean	isAutoApply()
boolean	isConditionModificationDelegated()
protected boolean	isLoaderConditionOutdated()	Returns whether the loader condition was replaced by the application since this group composed it last, so the composition no longer contains this group's conditions.
boolean	isOperationTextVisible()
protected void	recomposeLoaderConditionIfOutdated()	Recomposes the loader condition if the application has replaced it since the last contribution; an untouched loader condition is left as is.
void	remove(FilterComponent filterComponent)	Removes a FilterComponent from the component.
void	removeAll()	Removes all filter components from the component.
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	setAutoApply(boolean autoApply)	Sets whether the filter component should be automatically applied to the DataLoader when the value component value is changed.
void	setConditionModificationDelegated(boolean conditionModificationDelegated)	Sets whether the modification of DataLoader condition is delegated to the owner FilterComponent or GenericFilter.
void	setDataLoader(DataLoader dataLoader)	Sets a DataLoader related to the current filter component.
void	setLoaderConditionRecomposeDelegate(@Nullable Runnable loaderConditionRecomposeDelegate)	Sets the recomposition callback this group forwards to instead of composing the loader condition itself: for a configuration's root group the owning filter sets it at creation, for a nested group the owning group sets it on add and clears it on removal.
protected void	setLoaderConditionRecomposeDelegateOn(FilterComponent filterComponent, @Nullable Runnable delegate)	Sets or clears the recomposition delegate on a child component of this group, so the child's direct load can first let the group's chain recompose an outdated loader condition.
void	setOperation(LogicalFilterComponent.Operation operation)	Sets a filtering operation.
void	setOperationTextVisible(boolean operationTextVisible)	Sets whether to show operation caption.
void	setResponsiveSteps(List<SupportsResponsiveSteps.ResponsiveStep> steps)	Configure the responsive steps used in this layout.
void	setSummaryText(@Nullable String summaryText)
protected void	updateConditionsLayout()
protected void	updateDataLoaderCondition()
protected void	updateDataLoaderInitialCondition(@Nullable Condition condition)	Deprecated, for removal: This API element is subject to removal in a future version. no longer used internally; the initial data loader condition is now captured lazily in updateDataLoaderCondition() before the first filter contribution.
protected void	updateQueryCondition()
protected void	updateSummaryText()

Methods inherited from class com.vaadin.flow.component.Composite

getChildren, getContent, getElement

Methods inherited from class com.vaadin.flow.component.Component

addListener, bindVisible, findAncestor, fireEvent, from, get, getEventBus, getId, getListeners, getLocale, getParent, getTestId, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, setTestId, setVisible, whenAttached

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

addAttachListener

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

addDetachListener

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

getElement

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

bindEnabled, isEnabled, setEnabled

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

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

Methods inherited from interface io.jmix.flowui.component.SupportsResponsiveSteps

setResponsiveSteps

Field Details

GROUP_FILTER_CLASS_NAME

protected static final String GROUP_FILTER_CLASS_NAME

See Also:

• Constant Field Values

applicationContext

protected org.springframework.context.ApplicationContext applicationContext

uiComponents

protected UiComponents uiComponents

logicalFilterSupport

protected LogicalFilterSupport logicalFilterSupport

dataLoader

protected DataLoader dataLoader

initialDataLoaderCondition

protected Condition initialDataLoaderCondition

initialDataLoaderConditionInitialized

protected boolean initialDataLoaderConditionInitialized

lastConditionSetByFilter

protected Condition lastConditionSetByFilter

autoApply

protected boolean autoApply

conditionModificationDelegated

protected boolean conditionModificationDelegated

loaderConditionRecomposeDelegate

protected Runnable loaderConditionRecomposeDelegate

responsiveSteps

protected List<SupportsResponsiveSteps.ResponsiveStep> responsiveSteps

summaryComponent

protected com.vaadin.flow.component.html.Div summaryComponent

summaryText

protected String summaryText

operationTextVisible

protected boolean operationTextVisible

operation

protected LogicalFilterComponent.Operation operation

queryCondition

protected LogicalCondition queryCondition

ownFilterComponentsOrder

protected List<FilterComponent> ownFilterComponentsOrder

conditionsLayout

protected com.vaadin.flow.component.formlayout.FormLayout conditionsLayout

filterComponentFormItemMap

protected Map<FilterComponent,com.vaadin.flow.component.formlayout.FormLayout.FormItem> filterComponentFormItemMap

operationChangeRegistrations

protected Map<FilterComponent,com.vaadin.flow.shared.Registration> operationChangeRegistrations

Constructor Details

GroupFilter

public GroupFilter()

Method Details

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Throws:

org.springframework.beans.BeansException

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

autowireDependencies

protected void autowireDependencies()

initContent

protected com.vaadin.flow.component.orderedlayout.VerticalLayout initContent()

Overrides:

initContent in class com.vaadin.flow.component.Composite<com.vaadin.flow.component.orderedlayout.VerticalLayout>

initComponent

protected void initComponent()

initDefaultResponsiveSteps

protected void initDefaultResponsiveSteps()

initLayout

protected void initLayout()

createConditionsLayout

protected com.vaadin.flow.component.formlayout.FormLayout createConditionsLayout()

initConditionsLayout

protected void initConditionsLayout(com.vaadin.flow.component.formlayout.FormLayout layout)

isAnyFilterComponentVisible

protected boolean isAnyFilterComponentVisible()

addFilterComponentToConditionsLayout

protected void addFilterComponentToConditionsLayout(com.vaadin.flow.component.formlayout.FormLayout conditionsLayout,
 FilterComponent filterComponent)

getDataLoader

public DataLoader getDataLoader()

Specified by:

getDataLoader in interface FilterComponent

Returns:

a DataLoader related to the current filter component

setDataLoader

public void setDataLoader(DataLoader dataLoader)

Description copied from interface: FilterComponent

Sets a DataLoader related to the current filter component.

Specified by:

setDataLoader in interface FilterComponent

Parameters:

dataLoader - a DataLoader to set

updateDataLoaderInitialCondition

@Deprecated(since="3.0",
            forRemoval=true)
protected void updateDataLoaderInitialCondition(@Nullable Condition condition)

Deprecated, for removal: This API element is subject to removal in a future version.

no longer used internally; the initial data loader condition is now captured lazily in updateDataLoaderCondition() before the first filter contribution. Retained for backward compatibility.

updateDataLoaderCondition

protected void updateDataLoaderCondition()

isAutoApply

public boolean isAutoApply()

Specified by:

isAutoApply in interface FilterComponent

Returns:

true if the filter component should be automatically applied to the DataLoader when the value component value is changed

setAutoApply

public void setAutoApply(boolean autoApply)

Description copied from interface: FilterComponent

Sets whether the filter component should be automatically applied to the DataLoader when the value component value is changed.

Specified by:

setAutoApply in interface FilterComponent

Parameters:

autoApply - true if the filter component should be automatically applied to the DataLoader when the value component value is changed

apply

public void apply()

Description copied from interface: FilterComponent

Applies the current filter component condition.

Specified by:

apply in interface FilterComponent

recomposeLoaderConditionIfOutdated

protected void recomposeLoaderConditionIfOutdated()

Recomposes the loader condition if the application has replaced it since the last contribution; an untouched loader condition is left as is. A group with a recomposition delegate forwards the request to it instead of composing itself; child components of this group receive this method as their delegate, so a request from any nesting level reaches the outermost owner.

setLoaderConditionRecomposeDelegate

public void setLoaderConditionRecomposeDelegate(@Nullable Runnable loaderConditionRecomposeDelegate)

Sets the recomposition callback this group forwards to instead of composing the loader condition itself: for a configuration's root group the owning filter sets it at creation, for a nested group the owning group sets it on add and clears it on removal.

Parameters:

loaderConditionRecomposeDelegate - the owner's recomposition callback, or null

setLoaderConditionRecomposeDelegateOn

protected void setLoaderConditionRecomposeDelegateOn(FilterComponent filterComponent,
 @Nullable Runnable delegate)

Sets or clears the recomposition delegate on a child component of this group, so the child's direct load can first let the group's chain recompose an outdated loader condition.

isLoaderConditionOutdated

protected boolean isLoaderConditionOutdated()

Returns whether the loader condition was replaced by the application since this group composed it last, so the composition no longer contains this group's conditions.

getQueryCondition

public LogicalCondition getQueryCondition()

Specified by:

getQueryCondition in interface FilterComponent

Specified by:

getQueryCondition in interface LogicalFilterComponent<GroupFilter>

Returns:

a LogicalCondition related to the current component

updateQueryCondition

protected void updateQueryCondition()

add

public void add(FilterComponent filterComponent)

Description copied from interface: LogicalFilterComponent

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

Specified by:

add in interface LogicalFilterComponent<GroupFilter>

Parameters:

filterComponent - a FilterComponent to add

See Also:

• FilterComponent.getQueryCondition()

updateConditionsLayout

protected void updateConditionsLayout()

remove

public void remove(FilterComponent filterComponent)

Description copied from interface: LogicalFilterComponent

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

Specified by:

remove in interface LogicalFilterComponent<GroupFilter>

Parameters:

filterComponent - a FilterComponent to remove

removeAll

public void removeAll()

Description copied from interface: LogicalFilterComponent

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

Specified by:

removeAll in interface LogicalFilterComponent<GroupFilter>

getSummaryComponent

protected @Nullable com.vaadin.flow.component.html.Div getSummaryComponent()

getSummaryText

public @Nullable String getSummaryText()

setSummaryText

public void setSummaryText(@Nullable String summaryText)

updateSummaryText

protected void updateSummaryText()

createSummaryComponent

protected com.vaadin.flow.component.html.Div createSummaryComponent()

initSummaryComponent

protected void initSummaryComponent(com.vaadin.flow.component.html.Div summaryComponent)

getOperation

public LogicalFilterComponent.Operation getOperation()

Specified by:

getOperation in interface LogicalFilterComponent<GroupFilter>

Returns:

a filtering operation

setOperation

public void setOperation(LogicalFilterComponent.Operation operation)

Description copied from interface: LogicalFilterComponent

Sets a filtering operation.

Specified by:

setOperation in interface LogicalFilterComponent<GroupFilter>

Parameters:

operation - a filtering operation

isOperationTextVisible

public boolean isOperationTextVisible()

Specified by:

isOperationTextVisible in interface LogicalFilterComponent<GroupFilter>

Returns:

whether to show operation caption

setOperationTextVisible

public void setOperationTextVisible(boolean operationTextVisible)

Description copied from interface: LogicalFilterComponent

Sets whether to show operation caption.

Specified by:

setOperationTextVisible in interface LogicalFilterComponent<GroupFilter>

Parameters:

operationTextVisible - whether to show operation caption

getResponsiveSteps

public List<SupportsResponsiveSteps.ResponsiveStep> getResponsiveSteps()

Description copied from interface: SupportsResponsiveSteps

Get the list of SupportsResponsiveSteps.ResponsiveSteps used to configure this layout.

Specified by:

getResponsiveSteps in interface SupportsResponsiveSteps

Returns:

the list of SupportsResponsiveSteps.ResponsiveSteps used to configure this layout

See Also:

• SupportsResponsiveSteps.ResponsiveStep

setResponsiveSteps

public void setResponsiveSteps(List<SupportsResponsiveSteps.ResponsiveStep> steps)

Description copied from interface: SupportsResponsiveSteps

Configure the responsive steps used in this layout.

Specified by:

setResponsiveSteps in interface SupportsResponsiveSteps

Parameters:

steps - list of SupportsResponsiveSteps.ResponsiveSteps to set

See Also:

• SupportsResponsiveSteps.ResponsiveStep

getOwnFilterComponents

public List<FilterComponent> getOwnFilterComponents()

Specified by:

getOwnFilterComponents in interface LogicalFilterComponent<GroupFilter>

Returns:

the list of filter components directly owned by the current component

getFilterComponents

public List<FilterComponent> getFilterComponents()

Specified by:

getFilterComponents in interface LogicalFilterComponent<GroupFilter>

Returns:

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

isConditionModificationDelegated

public boolean isConditionModificationDelegated()

Specified by:

isConditionModificationDelegated in interface FilterComponent

Returns:

true if the filter component is located inside the GenericFilter and the modification of DataLoader condition is delegated to the owner FilterComponent or GenericFilter, false otherwise

setConditionModificationDelegated

public void setConditionModificationDelegated(boolean conditionModificationDelegated)

Description copied from interface: FilterComponent

Sets whether the modification of DataLoader condition is delegated to the owner FilterComponent or GenericFilter.

Specified by:

setConditionModificationDelegated in interface FilterComponent

Parameters:

conditionModificationDelegated - true if the filter component is located inside the GenericFilter and the modification of DataLoader condition is delegated to the owner FilterComponent or GenericFilter, false otherwise

addFilterComponentsChangeListener

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

Specified by:

addFilterComponentsChangeListener in interface LogicalFilterComponent<GroupFilter>

copy

protected @Nullable Condition copy(@Nullable Condition condition)

fireFilterComponentsChanged

protected void fireFilterComponentsChanged()