public interface GroupFilter extends LogicalFilterComponent, Component.BelongToFrame, CompositeWithHtmlCaption, CompositeWithHtmlDescription, CompositeWithIcon, CompositeWithContextHelp, HasHtmlSanitizer, SupportsCaptionPosition, SupportsColumnsCount
GroupBoxLayout
with a ResponsiveGridLayout
as its root element. This component can contain FilterComponent
s and can be used for filtering entities
returned by the DataLoader
.LogicalFilterComponent.Operation
Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper
HasContextHelp.ContextHelpIconClickEvent
SupportsCaptionPosition.CaptionPosition
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
NAME |
AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE
Modifier and Type | Method and Description |
---|---|
SupportsCaptionPosition.CaptionPosition |
getCaptionPosition() |
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 |
setColumnsCount(int columnsCount)
Sets the number of columns to be displayed on one row.
|
add, getFilterComponents, getOperation, getOwnFilterComponents, getQueryCondition, isOperationCaptionVisible, remove, removeAll, setOperation, setOperationCaptionVisible
apply, getDataLoader, isAutoApply, isConditionModificationDelegated, setAutoApply, setConditionModificationDelegated, setDataLoader
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
getFrame, setFrame
isCaptionAsHtml, setCaptionAsHtml
getCaption, setCaption
getDescription, setDescription
isDescriptionAsHtml, setDescriptionAsHtml
getIcon, setIcon, setIconFromSet
getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled
isHtmlSanitizerEnabled, setHtmlSanitizerEnabled
static final java.lang.String NAME
SupportsCaptionPosition.CaptionPosition getCaptionPosition()
getCaptionPosition
in interface SupportsCaptionPosition
void setCaptionPosition(SupportsCaptionPosition.CaptionPosition position)
CaptionPosition#LEFT
- component captions will be placed
in a separate column on the left side of the componentsCaptionPosition#TOP
- component captions will be placed
above the componentssetCaptionPosition
in interface SupportsCaptionPosition
position
- caption position of logical filter child componentsint getColumnsCount()
UiComponentProperties.getFilterColumnsCount()
.getColumnsCount
in interface SupportsColumnsCount
void setColumnsCount(int columnsCount)
UiComponentProperties.getFilterColumnsCount()
.setColumnsCount
in interface SupportsColumnsCount
columnsCount
- the number of columns to be displayed on one row