Package io.jmix.ui.component

Interface FilterComponent

All Superinterfaces:

Component

All Known Subinterfaces:

FullTextFilter, GroupFilter, JpqlFilter<V>, LogicalFilterComponent, PropertyFilter<V>, SingleFilterComponent<V>

All Known Implementing Classes:

AbstractSingleFilterComponent, FullTextFilterImpl, GroupFilterImpl, JpqlFilterImpl, PropertyFilterImpl

public interface FilterComponent
extends Component

Component that can be used for filtering entities returned by the DataLoader. The filter component is related to Condition which will be used together with query when loading entities into the DataLoader.

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

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	apply()	Applies the current filter component condition.
DataLoader	getDataLoader()
Condition	getQueryCondition()
boolean	isAutoApply()
boolean	isConditionModificationDelegated()
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 Filter.
void	setDataLoader(DataLoader dataLoader)	Sets a DataLoader related to the current filter component.

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

Method Details

getDataLoader

DataLoader getDataLoader()

Returns:

a DataLoader related to the current filter component

setDataLoader

@StudioProperty(type=DATALOADER_REF,
                required=true)
void setDataLoader(DataLoader dataLoader)

Sets a DataLoader related to the current filter component.

Parameters:

dataLoader - a DataLoader to set

isAutoApply

boolean isAutoApply()

Returns:

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

setAutoApply

@StudioProperty(defaultValue="true")
void setAutoApply(boolean autoApply)

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

Parameters:

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

isConditionModificationDelegated

boolean isConditionModificationDelegated()

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

void setConditionModificationDelegated(boolean conditionModificationDelegated)

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

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

getQueryCondition

Condition getQueryCondition()

Returns:

a Condition related to the current filter component

apply

void apply()

Applies the current filter component condition.