Package io.jmix.ui.component

Interface GroupFilter

All Superinterfaces:

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

All Known Implementing Classes:

GroupFilterImpl

public interface GroupFilter
extends LogicalFilterComponent, Component.BelongToFrame, CompositeWithHtmlCaption, CompositeWithHtmlDescription, CompositeWithIcon, CompositeWithContextHelp, HasHtmlSanitizer, SupportsCaptionPosition, SupportsColumnsCount

GroupFilter is a UI component that has a GroupBoxLayout with a ResponsiveGridLayout as its root element. This component can contain FilterComponents and can be used for filtering entities returned by 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

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
static final String	NAME

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

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Method Summary

Modifier and Type	Method	Description
SupportsCaptionPosition.CaptionPosition	getCaptionPosition()
float	getCaptionWidth()
SizeUnit	getCaptionWidthSizeUnit()
int	getColumnsCount()	Returns the number of columns to be displayed on one row.
void	setCaptionPosition(SupportsCaptionPosition.CaptionPosition position)	Sets caption position of logical filter child components.
void	setCaptionWidth(String width)	Sets caption width of logical filter child components.
void	setColumnsCount(int columnsCount)	Sets the number of columns to be displayed on one row.

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, setFrame

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

getCaption, setCaption

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

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

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

isHtmlSanitizerEnabled, setHtmlSanitizerEnabled

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

add, getFilterComponents, getOperation, getOwnFilterComponents, getQueryCondition, isOperationCaptionVisible, remove, removeAll, setOperation, setOperationCaptionVisible

Field Details

NAME

static final String NAME

See Also:

• Constant Field Values

Method Details

getCaptionPosition

SupportsCaptionPosition.CaptionPosition getCaptionPosition()

Specified by:

getCaptionPosition in interface SupportsCaptionPosition

Returns:

caption position of logical filter child components

setCaptionPosition

void setCaptionPosition(SupportsCaptionPosition.CaptionPosition position)

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 SupportsCaptionPosition

Parameters:

position - caption position of logical filter child components

getCaptionWidth

float getCaptionWidth()

Returns:

caption width of logical filter child components

getCaptionWidthSizeUnit

SizeUnit getCaptionWidthSizeUnit()

Returns:

caption width size unit of logical filter child components

setCaptionWidth

void setCaptionWidth(String width)

Sets caption width of logical filter child components.

Parameters:

width - caption width of logical filter child components

getColumnsCount

int getColumnsCount()

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

Specified by:

getColumnsCount in interface SupportsColumnsCount

Returns:

the number of columns to be displayed on one row

setColumnsCount

void setColumnsCount(int columnsCount)

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

Specified by:

setColumnsCount in interface SupportsColumnsCount

Parameters:

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