public interface FilterComponent extends Component
DataLoader
.
The filter component is related to Condition
which will be used together with
query when loading entities into the DataLoader
.Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper
AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE
Modifier and Type | Method and Description |
---|---|
void |
apply()
Applies the current filter component condition.
|
DataLoader |
getDataLoader() |
io.jmix.core.querycondition.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. |
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
DataLoader getDataLoader()
DataLoader
related to the current filter componentvoid setDataLoader(DataLoader dataLoader)
DataLoader
related to the current filter component.dataLoader
- a DataLoader
to setboolean isAutoApply()
true
if the filter component should be automatically applied to
the DataLoader
when the value component value is changedvoid setAutoApply(boolean autoApply)
DataLoader
when the value component value is changed.autoApply
- true
if the filter component should be automatically
applied to the DataLoader
when the value component
value is changedboolean isConditionModificationDelegated()
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
otherwisevoid setConditionModificationDelegated(boolean conditionModificationDelegated)
DataLoader
condition is delegated to the owner
FilterComponent
or Filter
.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
otherwiseio.jmix.core.querycondition.Condition getQueryCondition()
Condition
related to the current filter componentvoid apply()