Package io.jmix.ui.component.impl

Class GroupFilterImpl

java.lang.Object

io.jmix.ui.component.CompositeComponent<GroupBoxLayout>

io.jmix.ui.component.impl.GroupFilterImpl

All Implemented Interfaces:

AttachNotifier, Component, Component.BelongToFrame, Component.HasCaption, Component.HasDescription, Component.HasIcon, CompositeWithCaption, CompositeWithContextHelp, CompositeWithDescription, CompositeWithHtmlCaption, CompositeWithHtmlDescription, CompositeWithIcon, FilterComponent, GroupFilter, HasContextHelp, HasDebugId, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, LogicalFilterComponent, SupportsCaptionPosition, SupportsColumnsCount

public class GroupFilterImpl
extends CompositeComponent<GroupBoxLayout>
implements GroupFilter

Nested Class Summary

Nested classes/interfaces inherited from class io.jmix.ui.component.CompositeComponent

CompositeComponent.CreateEvent

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

LogicalFilterComponent.Operation

Nested classes/interfaces inherited from interface io.jmix.ui.component.SupportsCaptionPosition

SupportsCaptionPosition.CaptionPosition

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	autoApply
protected String	caption
protected SupportsCaptionPosition.CaptionPosition	captionPosition
protected int	columnsCount
protected boolean	conditionModificationDelegated
protected ResponsiveGridLayout	conditionsLayout
protected DataLoader	dataLoader
protected static final String	GROUP_FILTER_STYLENAME
protected Condition	initialDataLoaderCondition
protected LogicalFilterSupport	logicalFilterSupport
protected LogicalFilterComponent.Operation	operation
protected boolean	operationCaptionVisible
protected List<FilterComponent>	ownFilterComponentsOrder
protected LogicalCondition	queryCondition
protected UiComponents	uiComponents

Fields inherited from class io.jmix.ui.component.CompositeComponent

applicationContext, frame, id, prefixId, root

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

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

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

NAME

Constructor Summary

Constructors

Constructor	Description
GroupFilterImpl()

Method Summary

Modifier and Type	Method	Description
void	add(FilterComponent filterComponent)	Adds a FilterComponent to the component.
protected void	addFilterComponentToConditionsLayoutRow(FilterComponent filterComponent, ResponsiveGridLayout.Row row)
protected void	addLogicalFilterComponentToConditionsLayoutRow(LogicalFilterComponent logicalFilterComponent, ResponsiveGridLayout.Row row)
void	apply()	Applies the current filter component condition.
protected void	attachToFrame(Component childComponent)
protected ResponsiveGridLayout	createConditionsLayout()
protected ResponsiveGridLayout.Row	createConditionsLayoutRow(ResponsiveGridLayout layout)
protected ResponsiveGridLayout.Column	createFilterComponentColumn(ResponsiveGridLayout.Row row)
protected ResponsiveGridLayout.Column	createLogicalFilterComponentColumn(ResponsiveGridLayout.Row row)
protected GroupBoxLayout	createRootComponent()
String	getCaption()
SupportsCaptionPosition.CaptionPosition	getCaptionPosition()
int	getColumnsCount()	Returns the number of columns to be displayed on one row.
DataLoader	getDataLoader()
List<FilterComponent>	getFilterComponents()
LogicalFilterComponent.Operation	getOperation()
List<FilterComponent>	getOwnFilterComponents()
LogicalCondition	getQueryCondition()
boolean	isAutoApply()
boolean	isConditionModificationDelegated()
boolean	isOperationCaptionVisible()
protected void	onCreate(CompositeComponent.CreateEvent createEvent)
void	remove(FilterComponent filterComponent)	Removes a FilterComponent from the component.
void	removeAll()	Removes all filter components from the component.
void	setAutoApply(boolean autoApply)	Sets whether the filter component should be automatically applied to the DataLoader when the value component value is changed.
void	setCaption(String caption)	Sets the component's caption.
void	setCaptionPosition(SupportsCaptionPosition.CaptionPosition position)	Sets caption position of logical filter child components.
void	setColumnsCount(int columnsCount)	Sets the number of columns to be displayed on one row.
void	setConditionModificationDelegated(boolean conditionModificationDelegated)	Sets whether the modification of DataLoader condition is delegated to the owner FilterComponent or Filter.
void	setDataLoader(DataLoader dataLoader)	Sets a DataLoader related to the current filter component.
void	setFrame(Frame frame)
void	setLogicalFilterSupport(LogicalFilterSupport logicalFilterSupport)
void	setOperation(LogicalFilterComponent.Operation operation)	Sets a filtering operation.
void	setOperationCaptionVisible(boolean operationCaptionVisible)	Sets whether to show operation caption.
void	setUiComponentProperties(UiComponentProperties componentProperties)
void	setUiComponents(UiComponents uiComponents)
protected void	updateCaption()
protected void	updateConditionsLayout()
protected void	updateDataLoaderCondition()
protected void	updateQueryCondition()

Methods inherited from class io.jmix.ui.component.CompositeComponent

addAttachListener, addCreateListener, addDetachListener, addStyleName, assignDebugId, attached, detached, disableEventListeners, enableEventListeners, getAlignment, getComposition, getCompositionOrNull, getDebugId, getEventHub, getFrame, getFullId, getHeight, getHeightSizeUnit, getId, getInnerComponent, getInnerComponentOptional, getParent, getPrefixId, getStyleName, getUiEventListeners, getWidth, getWidthSizeUnit, hasSubscriptions, isAttached, isEnabled, isEnabledRecursive, isHtmlSanitizerEnabled, isResponsive, isVisible, isVisibleRecursive, publish, removeStyleName, setAlignment, setApplicationContext, setComposition, setDebugId, setEnabled, setHeight, setHtmlSanitizerEnabled, setId, setParent, setResponsive, setStyleName, setUiEventListeners, setVisible, setWidth, unsubscribe, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, updateComponentIds, updateIdIfNeeded, withUnwrapped, withUnwrappedComposition

Methods inherited from class java.lang.Object

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

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

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

getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled

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

getDescription, setDescription

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

isCaptionAsHtml, setCaptionAsHtml

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

isDescriptionAsHtml, setDescriptionAsHtml

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

getIcon, setIcon, setIconFromSet

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

isHtmlSanitizerEnabled, setHtmlSanitizerEnabled

Field Details

GROUP_FILTER_STYLENAME

protected static final String GROUP_FILTER_STYLENAME

See Also:

• Constant Field Values

uiComponents

protected UiComponents uiComponents

logicalFilterSupport

protected LogicalFilterSupport logicalFilterSupport

dataLoader

protected DataLoader dataLoader

initialDataLoaderCondition

protected Condition initialDataLoaderCondition

autoApply

protected boolean autoApply

conditionModificationDelegated

protected boolean conditionModificationDelegated

columnsCount

protected int columnsCount

captionPosition

protected SupportsCaptionPosition.CaptionPosition captionPosition

caption

protected String caption

operationCaptionVisible

protected boolean operationCaptionVisible

operation

protected LogicalFilterComponent.Operation operation

queryCondition

protected LogicalCondition queryCondition

ownFilterComponentsOrder

protected List<FilterComponent> ownFilterComponentsOrder

conditionsLayout

protected ResponsiveGridLayout conditionsLayout

Constructor Details

GroupFilterImpl

public GroupFilterImpl()

Method Details

setUiComponents

@Autowired
public void setUiComponents(UiComponents uiComponents)

setUiComponentProperties

@Autowired
public void setUiComponentProperties(UiComponentProperties componentProperties)

setLogicalFilterSupport

@Autowired
public void setLogicalFilterSupport(LogicalFilterSupport logicalFilterSupport)

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

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

isConditionModificationDelegated

public boolean isConditionModificationDelegated()

Specified by:

isConditionModificationDelegated in interface FilterComponent

Returns:

true if the filter component is located inside the Filter or LogicalFilterComponent and the modification of DataLoader condition is delegated to the owner FilterComponent or Filter, 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 Filter.

Specified by:

setConditionModificationDelegated in interface FilterComponent

Parameters:

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

getOperation

public LogicalFilterComponent.Operation getOperation()

Specified by:

getOperation in interface LogicalFilterComponent

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

Parameters:

operation - a filtering operation

getColumnsCount

public int getColumnsCount()

Description copied from interface: GroupFilter

Returns the number of columns to be displayed on one row. The default value is taken from UiComponentProperties.getFilterColumnsCount().

Specified by:

getColumnsCount in interface GroupFilter

Specified by:

getColumnsCount in interface SupportsColumnsCount

Returns:

the number of columns to be displayed on one row

setColumnsCount

public void setColumnsCount(int columnsCount)

Description copied from interface: GroupFilter

Sets the number of columns to be displayed on one row. The default value is taken from UiComponentProperties.getFilterColumnsCount().

Specified by:

setColumnsCount in interface GroupFilter

Specified by:

setColumnsCount in interface SupportsColumnsCount

Parameters:

columnsCount - the number of columns to be displayed on one row

getCaption

@Nullable
public String getCaption()

Specified by:

getCaption in interface Component.HasCaption

Specified by:

getCaption in interface CompositeWithCaption

Returns:

the caption of the component

setCaption

public void setCaption(@Nullable
 String caption)

Description copied from interface: Component.HasCaption

Sets the component's caption.

Specified by:

setCaption in interface Component.HasCaption

Specified by:

setCaption in interface CompositeWithCaption

Parameters:

caption - the new component's caption

isOperationCaptionVisible

public boolean isOperationCaptionVisible()

Specified by:

isOperationCaptionVisible in interface LogicalFilterComponent

Returns:

whether to show operation caption

setOperationCaptionVisible

public void setOperationCaptionVisible(boolean operationCaptionVisible)

Description copied from interface: LogicalFilterComponent

Sets whether to show operation caption.

Specified by:

setOperationCaptionVisible in interface LogicalFilterComponent

Parameters:

operationCaptionVisible - whether to show operation caption

updateCaption

protected void updateCaption()

getCaptionPosition

public SupportsCaptionPosition.CaptionPosition getCaptionPosition()

Specified by:

getCaptionPosition in interface GroupFilter

Specified by:

getCaptionPosition in interface SupportsCaptionPosition

Returns:

caption position of logical filter child components

setCaptionPosition

public void setCaptionPosition(SupportsCaptionPosition.CaptionPosition position)

Description copied from interface: GroupFilter

Sets caption position of logical filter child components.

• SupportsCaptionPosition.CaptionPosition.LEFT - component captions will be placed in a separate column on the left side of the components
• SupportsCaptionPosition.CaptionPosition.TOP - component captions will be placed above the components

Specified by:

setCaptionPosition in interface GroupFilter

Specified by:

setCaptionPosition in interface SupportsCaptionPosition

Parameters:

position - caption position of logical filter child components

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

Parameters:

filterComponent - a FilterComponent to add

See Also:

• FilterComponent.getQueryCondition()

setFrame

public void setFrame(@Nullable
 Frame frame)

Specified by:

setFrame in interface Component.BelongToFrame

Overrides:

setFrame in class CompositeComponent<GroupBoxLayout>

attachToFrame

protected void attachToFrame(Component childComponent)

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

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

getQueryCondition

public LogicalCondition getQueryCondition()

Specified by:

getQueryCondition in interface FilterComponent

Specified by:

getQueryCondition in interface LogicalFilterComponent

Returns:

a LogicalCondition related to the current component

apply

public void apply()

Description copied from interface: FilterComponent

Applies the current filter component condition.

Specified by:

apply in interface FilterComponent

getOwnFilterComponents

public List<FilterComponent> getOwnFilterComponents()

Specified by:

getOwnFilterComponents in interface LogicalFilterComponent

Returns:

the list of filter components directly owned by the current component

getFilterComponents

public List<FilterComponent> getFilterComponents()

Specified by:

getFilterComponents in interface LogicalFilterComponent

Returns:

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

onCreate

protected void onCreate(CompositeComponent.CreateEvent createEvent)

createRootComponent

protected GroupBoxLayout createRootComponent()

updateQueryCondition

protected void updateQueryCondition()

updateDataLoaderCondition

protected void updateDataLoaderCondition()

updateConditionsLayout

protected void updateConditionsLayout()

createConditionsLayout

protected ResponsiveGridLayout createConditionsLayout()

createConditionsLayoutRow

protected ResponsiveGridLayout.Row createConditionsLayoutRow(ResponsiveGridLayout layout)

addLogicalFilterComponentToConditionsLayoutRow

protected void addLogicalFilterComponentToConditionsLayoutRow(LogicalFilterComponent logicalFilterComponent,
 ResponsiveGridLayout.Row row)

createLogicalFilterComponentColumn

protected ResponsiveGridLayout.Column createLogicalFilterComponentColumn(ResponsiveGridLayout.Row row)

addFilterComponentToConditionsLayoutRow

protected void addFilterComponentToConditionsLayoutRow(FilterComponent filterComponent,
 ResponsiveGridLayout.Row row)

createFilterComponentColumn

protected ResponsiveGridLayout.Column createFilterComponentColumn(ResponsiveGridLayout.Row row)