Package io.jmix.ui.component.impl

Class FilterImpl

java.lang.Object

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

io.jmix.ui.component.impl.FilterImpl

All Implemented Interfaces:

ActionsHolder, AttachNotifier, Collapsable, Component, Component.BelongToFrame, Component.HasCaption, Component.HasDescription, Component.HasIcon, CompositeWithCaption, CompositeWithContextHelp, CompositeWithDescription, CompositeWithHtmlCaption, CompositeWithHtmlDescription, CompositeWithIcon, Filter, HasContextHelp, HasDebugId, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, HasSubParts, SupportsCaptionPosition, SupportsColumnsCount

public class FilterImpl
extends CompositeComponent<GroupBoxLayout>
implements Filter, CompositeWithHtmlCaption, CompositeWithHtmlDescription, CompositeWithContextHelp, CompositeWithIcon

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

Collapsable.ExpandedStateChangeEvent

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

Filter.Configuration, Filter.ConfigurationChangeEvent

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

HasContextHelp.ContextHelpIconClickEvent

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

SupportsCaptionPosition.CaptionPosition

Field Summary

Fields

Modifier and Type	Field	Description
protected Actions	actions
protected LinkButton	addConditionButton
protected KeyCombination	applyShortcut
protected boolean	autoApply
protected SupportsCaptionPosition.CaptionPosition	captionPosition
protected float	captionWidth
protected SizeUnit	captionWidthUnit
protected int	columnsCount
protected List<FilterComponent>	conditions
protected boolean	configurationModifyPermitted
protected List<Filter.Configuration>	configurations
protected ResponsiveGridLayout	controlsLayout
protected CurrentAuthentication	currentAuthentication
protected Filter.Configuration	currentConfiguration
protected DataLoader	dataLoader
protected Filter.Configuration	emptyConfiguration
protected static final String	FILTER_ROOT_COMPONENT_STYLENAME
protected static final String	FILTER_STYLENAME
protected FilterSupport	filterSupport
protected static final String	GLOBAL_CONFIGURATION_CAPTION_POSTFIX
protected Condition	initialDataLoaderCondition
protected Messages	messages
protected Metadata	metadata
protected Predicate<MetaPropertyPath>	propertiesFilterPredicate
protected LogicalFilterComponent	rootLogicalFilterComponent
protected ScreenBuilders	screenBuilders
protected Button	searchButton
protected CssLayout	searchLayout
protected PopupButton	selectConfigurationButton
protected PopupButton	settingsButton
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.Filter

NAME

Constructor Summary

Constructors

Constructor	Description
FilterImpl()

Method Summary

Modifier and Type	Method	Description
void	addAction(Action action)	Add an action to the component
void	addAction(Action action, int index)	Add an action to the component with index.
void	addCondition(FilterComponent filterComponent)	Adds a condition to the filter.
void	addConfiguration(Filter.Configuration configuration)	Adds a configuration to the filter.
DesignTimeConfiguration	addConfiguration(String id, String name)	Adds design-time configuration with given id and name.
DesignTimeConfiguration	addConfiguration(String id, String name, LogicalFilterComponent.Operation rootOperation)	Adds design-time configuration with given id and name.
Subscription	addConfigurationChangeListener(Consumer<Filter.ConfigurationChangeEvent> listener)	Adds a listener that is invoked when the Filter.Configuration changes.
Subscription	addExpandedStateChangeListener(Consumer<Collapsable.ExpandedStateChangeEvent> listener)
void	addPropertiesFilterPredicate(Predicate<MetaPropertyPath> propertiesFilterPredicate)	Adds a predicate to the current properties filter predicate.
protected void	addSelectConfigurationAction(Filter.Configuration configuration)
void	apply()	Applies the current configuration.
protected void	attachToFrame(Component childComponent)
protected void	clearValues()
protected Condition	copy(Condition condition)
protected LinkButton	createConditionRemoveButton(SingleFilterComponent<?> singleFilter, String removeButtonId)
protected LogicalFilterComponent	createConfigurationRootLogicalFilterComponent(LogicalFilterComponent.Operation rootOperation)
protected Action	createResetFilterAction()
Action	getAction(String id)
Collection<Action>	getActions()
SupportsCaptionPosition.CaptionPosition	getCaptionPosition()
float	getCaptionWidth()
SizeUnit	getCaptionWidthSizeUnit()
int	getColumnsCount()	Returns the number of columns to be displayed on one row.
List<FilterComponent>	getConditions()
Filter.Configuration	getConfiguration(String id)	Gets a configuration by id.
protected String	getConfigurationCaption(Filter.Configuration configuration)
List<Filter.Configuration>	getConfigurations()
Filter.Configuration	getCurrentConfiguration()	Gets the current configuration that is currently displayed inside the filter.
DataLoader	getDataLoader()
Filter.Configuration	getEmptyConfiguration()	Gets an empty configuration that is used when the user has not selected any of the existing configurations.
Predicate<MetaPropertyPath>	getPropertiesFilterPredicate()
Condition	getQueryCondition()
KeyCombination	getShortcutCombination()
protected void	initAddConditionButton()
protected void	initEmptyConfiguration()
protected void	initRootComponent()
protected void	initSearchButton()
protected void	initSelectConfigurationButton()
protected void	initSettingsButton()
boolean	isAutoApply()
boolean	isCollapsable()
boolean	isExpanded()
void	loadConfigurationsAndApplyDefault()	Loads configurations for Filter and apply default.
protected void	onCreate(CompositeComponent.CreateEvent createEvent)
void	refreshCurrentConfigurationLayout()	Refreshes the display of the current configuration.
void	removeAction(Action action)	Remove the action from the component
void	removeAction(String id)	Remove the action by its ID.
void	removeAllActions()	Remove all actions from the component
void	removeCondition(FilterComponent filterComponent)	Removes a condition from filter.
void	removeConfiguration(Filter.Configuration configuration)	Removes a configuration from filter.
protected void	removeFilterComponent(FilterComponent filterComponent)
protected void	resetFilterComponentDefaultValue(PropertyFilter<?> propertyFilter)
void	setAccessManager(AccessManager accessManager)
void	setActions(Actions actions)
void	setApplyShortcut(String applyShortcut)	Sets shortcut for apply Filter from string representation.
void	setApplyShortcutCombination(KeyCombination applyShortcut)	Sets shortcut combination for apply Filter.
void	setAutoApply(boolean autoApply)	Sets whether the filter 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 filter child components.
void	setCaptionWidth(String width)	Sets caption width of filter child components.
void	setCollapsable(boolean collapsable)
void	setColumnsCount(int columnsCount)	Sets the number of columns to be displayed on one row.
void	setCurrentAuthentication(CurrentAuthentication currentAuthentication)
void	setCurrentConfiguration(Filter.Configuration currentConfiguration)	Sets the given configuration as current and displays filter components from the current configuration.
void	setDataLoader(DataLoader dataLoader)	Sets a DataLoader related to the filter.
void	setExpanded(boolean expanded)
void	setFilterSupport(FilterSupport filterSupport)
void	setFrame(Frame frame)
void	setMessages(Messages messages)
void	setMetadata(Metadata metadata)
void	setPropertiesFilterPredicate(Predicate<MetaPropertyPath> propertiesFilterPredicate)	Sets a predicate that tests whether a property with the given path should be available for filtering.
void	setScreenBuilders(ScreenBuilders screenBuilders)
void	setUiComponentProperties(UiComponentProperties componentProperties)
void	setUiComponents(UiComponents uiComponents)
protected void	setupLoaderFirstResult()
protected void	updateActionsState()
protected void	updateConditionRemoveButton(SingleFilterComponent<?> singleFilter)
protected void	updateDataLoaderCondition()
protected void	updateDataLoaderInitialCondition(Condition condition)
protected void	updateRootLayoutCaption()
protected void	updateRootLogicalFilterComponent(LogicalFilterComponent logicalFilterComponent)
protected void	updateSearchButtonCaption(boolean autoApply)
protected void	updateSelectConfigurationButton()

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

getActionNN, getSubPart

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

getCaption

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

FILTER_STYLENAME

protected static final String FILTER_STYLENAME

See Also:

• Constant Field Values

FILTER_ROOT_COMPONENT_STYLENAME

protected static final String FILTER_ROOT_COMPONENT_STYLENAME

See Also:

• Constant Field Values

GLOBAL_CONFIGURATION_CAPTION_POSTFIX

protected static final String GLOBAL_CONFIGURATION_CAPTION_POSTFIX

See Also:

• Constant Field Values

actions

protected Actions actions

currentAuthentication

protected CurrentAuthentication currentAuthentication

filterSupport

protected FilterSupport filterSupport

messages

protected Messages messages

metadata

protected Metadata metadata

screenBuilders

protected ScreenBuilders screenBuilders

uiComponents

protected UiComponents uiComponents

rootLogicalFilterComponent

protected LogicalFilterComponent rootLogicalFilterComponent

controlsLayout

protected ResponsiveGridLayout controlsLayout

searchLayout

protected CssLayout searchLayout

searchButton

protected Button searchButton

selectConfigurationButton

protected PopupButton selectConfigurationButton

addConditionButton

protected LinkButton addConditionButton

settingsButton

protected PopupButton settingsButton

dataLoader

protected DataLoader dataLoader

initialDataLoaderCondition

protected Condition initialDataLoaderCondition

autoApply

protected boolean autoApply

applyShortcut

protected KeyCombination applyShortcut

columnsCount

protected int columnsCount

captionPosition

protected SupportsCaptionPosition.CaptionPosition captionPosition

propertiesFilterPredicate

protected Predicate<MetaPropertyPath> propertiesFilterPredicate

captionWidth

protected float captionWidth

captionWidthUnit

protected SizeUnit captionWidthUnit

emptyConfiguration

protected Filter.Configuration emptyConfiguration

currentConfiguration

protected Filter.Configuration currentConfiguration

configurations

protected List<Filter.Configuration> configurations

conditions

protected List<FilterComponent> conditions

configurationModifyPermitted

protected boolean configurationModifyPermitted

Constructor Details

FilterImpl

public FilterImpl()

Method Details

setActions

@Autowired
public void setActions(Actions actions)

setCurrentAuthentication

@Autowired
public void setCurrentAuthentication(CurrentAuthentication currentAuthentication)

setFilterSupport

@Autowired
public void setFilterSupport(FilterSupport filterSupport)

setMessages

@Autowired
public void setMessages(Messages messages)

setMetadata

@Autowired
public void setMetadata(Metadata metadata)

setScreenBuilders

@Autowired
public void setScreenBuilders(ScreenBuilders screenBuilders)

setUiComponents

@Autowired
public void setUiComponents(UiComponents uiComponents)

setUiComponentProperties

@Autowired
public void setUiComponentProperties(UiComponentProperties componentProperties)

setAccessManager

@Autowired
public void setAccessManager(AccessManager accessManager)

isExpanded

public boolean isExpanded()

Specified by:

isExpanded in interface Collapsable

setExpanded

public void setExpanded(boolean expanded)

Specified by:

setExpanded in interface Collapsable

isCollapsable

public boolean isCollapsable()

Specified by:

isCollapsable in interface Collapsable

setCollapsable

public void setCollapsable(boolean collapsable)

Specified by:

setCollapsable in interface Collapsable

addExpandedStateChangeListener

public Subscription addExpandedStateChangeListener(Consumer<Collapsable.ExpandedStateChangeEvent> listener)

Specified by:

addExpandedStateChangeListener in interface Collapsable

getDataLoader

public DataLoader getDataLoader()

Specified by:

getDataLoader in interface Filter

Returns:

a DataLoader related to the filter

setDataLoader

public void setDataLoader(DataLoader dataLoader)

Description copied from interface: Filter

Sets a DataLoader related to the filter.

Specified by:

setDataLoader in interface Filter

Parameters:

dataLoader - a DataLoader to set

updateDataLoaderInitialCondition

protected void updateDataLoaderInitialCondition(@Nullable
 Condition condition)

isAutoApply

public boolean isAutoApply()

Specified by:

isAutoApply in interface Filter

Returns:

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

setAutoApply

public void setAutoApply(boolean autoApply)

Description copied from interface: Filter

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

Specified by:

setAutoApply in interface Filter

Parameters:

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

getShortcutCombination

@Nullable
public KeyCombination getShortcutCombination()

Specified by:

getShortcutCombination in interface Filter

Returns:

apply Filter key combination

setApplyShortcutCombination

public void setApplyShortcutCombination(@Nullable
 KeyCombination applyShortcut)

Description copied from interface: Filter

Sets shortcut combination for apply Filter.

Specified by:

setApplyShortcutCombination in interface Filter

Parameters:

applyShortcut - key combination

setApplyShortcut

public void setApplyShortcut(@Nullable
 String applyShortcut)

Description copied from interface: Filter

Sets shortcut for apply Filter from string representation.

Specified by:

setApplyShortcut in interface Filter

Parameters:

applyShortcut - string of type "Modifiers-Key", e.g. "Alt-N". Case-insensitive

apply

public void apply()

Description copied from interface: Filter

Applies the current configuration.

Specified by:

apply in interface Filter

getCaptionPosition

public SupportsCaptionPosition.CaptionPosition getCaptionPosition()

Specified by:

getCaptionPosition in interface Filter

Specified by:

getCaptionPosition in interface SupportsCaptionPosition

Returns:

caption position of filter child components

setCaptionPosition

public void setCaptionPosition(SupportsCaptionPosition.CaptionPosition position)

Description copied from interface: Filter

Sets caption position of 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 Filter

Specified by:

setCaptionPosition in interface SupportsCaptionPosition

Parameters:

position - caption position of filter child components

getCaptionWidth

public float getCaptionWidth()

Specified by:

getCaptionWidth in interface Filter

Returns:

caption width of filter child components

getCaptionWidthSizeUnit

public SizeUnit getCaptionWidthSizeUnit()

Specified by:

getCaptionWidthSizeUnit in interface Filter

Returns:

caption width size unit of filter child components

setCaptionWidth

public void setCaptionWidth(String width)

Description copied from interface: Filter

Sets caption width of filter child components.

Specified by:

setCaptionWidth in interface Filter

Parameters:

width - caption width of filter child components

getColumnsCount

public int getColumnsCount()

Description copied from interface: Filter

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

Specified by:

getColumnsCount in interface Filter

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: Filter

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

Specified by:

setColumnsCount in interface Filter

Specified by:

setColumnsCount in interface SupportsColumnsCount

Parameters:

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

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)

getPropertiesFilterPredicate

@Nullable
public Predicate<MetaPropertyPath> getPropertiesFilterPredicate()

Specified by:

getPropertiesFilterPredicate in interface Filter

Returns:

a properties filter predicate

setPropertiesFilterPredicate

public void setPropertiesFilterPredicate(@Nullable
 Predicate<MetaPropertyPath> propertiesFilterPredicate)

Description copied from interface: Filter

Sets a predicate that tests whether a property with the given path should be available for filtering.

Specified by:

setPropertiesFilterPredicate in interface Filter

Parameters:

propertiesFilterPredicate - a predicate to set

addPropertiesFilterPredicate

public void addPropertiesFilterPredicate(Predicate<MetaPropertyPath> propertiesFilterPredicate)

Description copied from interface: Filter

Adds a predicate to the current properties filter predicate. The result predicate is a composed predicate that represents a short-circuiting logical AND of given predicate and current properties filter predicate.

Specified by:

addPropertiesFilterPredicate in interface Filter

Parameters:

propertiesFilterPredicate - a predicate to add

setCurrentConfiguration

public void setCurrentConfiguration(Filter.Configuration currentConfiguration)

Description copied from interface: Filter

Sets the given configuration as current and displays filter components from the current configuration.

Specified by:

setCurrentConfiguration in interface Filter

Parameters:

currentConfiguration - a configuration

getCurrentConfiguration

public Filter.Configuration getCurrentConfiguration()

Description copied from interface: Filter

Gets the current configuration that is currently displayed inside the filter.

Specified by:

getCurrentConfiguration in interface Filter

Returns:

a current configuration

getConfiguration

public Filter.Configuration getConfiguration(String id)

Description copied from interface: Filter

Gets a configuration by id.

Specified by:

getConfiguration in interface Filter

Parameters:

id - the configuration id

Returns:

the configuration of null if not found

getEmptyConfiguration

public Filter.Configuration getEmptyConfiguration()

Description copied from interface: Filter

Gets an empty configuration that is used when the user has not selected any of the existing configurations.

Specified by:

getEmptyConfiguration in interface Filter

Returns:

an empty configuration

getConfigurations

public List<Filter.Configuration> getConfigurations()

Specified by:

getConfigurations in interface Filter

Returns:

a list of all configurations related to the filter

addConfiguration

public DesignTimeConfiguration addConfiguration(String id,
 @Nullable
 String name)

Description copied from interface: Filter

Adds design-time configuration with given id and name. A configuration is a set of FilterComponents. The configuration does not store a reference to all components, but stores a reference only to the root element LogicalFilterComponent from which the rest FilterComponents can be obtained. The root LogicalFilterComponent is generated with a LogicalFilterComponent.Operation.AND operation.

The configuration defined in XML is a DesignTimeConfiguration.

Specified by:

addConfiguration in interface Filter

Parameters:

id - a configuration id. Must be unique within this filter

name - a configuration name

Returns:

DesignTimeConfiguration

See Also:

• LogicalFilterComponent

addConfiguration

public DesignTimeConfiguration addConfiguration(String id,
 @Nullable
 String name,
 LogicalFilterComponent.Operation rootOperation)

Description copied from interface: Filter

Adds design-time configuration with given id and name. A configuration is a set of FilterComponents. The configuration does not store a reference to all components, but stores a reference only to the root element LogicalFilterComponent from which the rest FilterComponents can be obtained. The root LogicalFilterComponent is generated with a given operation.

The configuration defined in XML is a DesignTimeConfiguration.

Specified by:

addConfiguration in interface Filter

Parameters:

id - a configuration id. Must be unique within this filter

name - a configuration name

rootOperation - an operation of root LogicalFilterComponent

Returns:

DesignTimeConfiguration

addConfiguration

public void addConfiguration(Filter.Configuration configuration)

Description copied from interface: Filter

Adds a configuration to the filter.

Specified by:

addConfiguration in interface Filter

Parameters:

configuration - configuration to add

See Also:

• DesignTimeConfiguration
• RunTimeConfiguration

removeConfiguration

public void removeConfiguration(Filter.Configuration configuration)

Description copied from interface: Filter

Removes a configuration from filter.

Specified by:

removeConfiguration in interface Filter

Parameters:

configuration - configuration to remove

addCondition

public void addCondition(FilterComponent filterComponent)

Description copied from interface: Filter

Adds a condition to the filter. A condition is a FilterComponent that is not initially added to any of the configurations, but the user can select this component in the AddConditionScreen in the Conditions section and add it to the RunTimeConfiguration.

Specified by:

addCondition in interface Filter

Parameters:

filterComponent - a filter component to add to conditions

See Also:

• FilterComponent
• AddConditionScreen
• RunTimeConfiguration

getConditions

public List<FilterComponent> getConditions()

Specified by:

getConditions in interface Filter

Returns:

a list of all conditions related to the filter

removeCondition

public void removeCondition(FilterComponent filterComponent)

Description copied from interface: Filter

Removes a condition from filter.

Specified by:

removeCondition in interface Filter

Parameters:

filterComponent - a filter component to remove from conditions

addConfigurationChangeListener

public Subscription addConfigurationChangeListener(Consumer<Filter.ConfigurationChangeEvent> listener)

Description copied from interface: Filter

Adds a listener that is invoked when the Filter.Configuration changes.

Specified by:

addConfigurationChangeListener in interface Filter

Parameters:

listener - a listener to add

Returns:

a registration object for removing an event listener

loadConfigurationsAndApplyDefault

public void loadConfigurationsAndApplyDefault()

Description copied from interface: Filter

Loads configurations for Filter and apply default. NOTE: call this method after the frame is fully initialized (for example, in ComponentLoader.InitTask in a loader).

Specified by:

loadConfigurationsAndApplyDefault in interface Filter

refreshCurrentConfigurationLayout

public void refreshCurrentConfigurationLayout()

Description copied from interface: Filter

Refreshes the display of the current configuration. Allows the user to refresh the display after changing the current configuration.

Specified by:

refreshCurrentConfigurationLayout in interface Filter

addAction

public void addAction(Action action)

Description copied from interface: ActionsHolder

Add an action to the component

Specified by:

addAction in interface ActionsHolder

addAction

public void addAction(Action action,
 int index)

Description copied from interface: ActionsHolder

Add an action to the component with index.

Specified by:

addAction in interface ActionsHolder

removeAction

public void removeAction(Action action)

Description copied from interface: ActionsHolder

Remove the action from the component

Specified by:

removeAction in interface ActionsHolder

removeAction

public void removeAction(String id)

Description copied from interface: ActionsHolder

Remove the action by its ID. If there is no action with that ID, nothing happens.

Specified by:

removeAction in interface ActionsHolder

removeAllActions

public void removeAllActions()

Description copied from interface: ActionsHolder

Remove all actions from the component

Specified by:

removeAllActions in interface ActionsHolder

getActions

public Collection<Action> getActions()

Specified by:

getActions in interface ActionsHolder

Returns:

unmodifiable collection of actions

getAction

@Nullable
public Action getAction(String id)

Specified by:

getAction in interface ActionsHolder

Returns:

an action by its ID, or null if not found

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

getQueryCondition

public Condition getQueryCondition()

onCreate

protected void onCreate(CompositeComponent.CreateEvent createEvent)

initRootComponent

protected void initRootComponent()

initEmptyConfiguration

protected void initEmptyConfiguration()

initAddConditionButton

protected void initAddConditionButton()

initSearchButton

protected void initSearchButton()

initSelectConfigurationButton

protected void initSelectConfigurationButton()

initSettingsButton

protected void initSettingsButton()

createConditionRemoveButton

protected LinkButton createConditionRemoveButton(SingleFilterComponent<?> singleFilter,
 String removeButtonId)

removeFilterComponent

protected void removeFilterComponent(FilterComponent filterComponent)

createResetFilterAction

protected Action createResetFilterAction()

createConfigurationRootLogicalFilterComponent

protected LogicalFilterComponent createConfigurationRootLogicalFilterComponent(LogicalFilterComponent.Operation rootOperation)

addSelectConfigurationAction

protected void addSelectConfigurationAction(Filter.Configuration configuration)

getConfigurationCaption

protected String getConfigurationCaption(Filter.Configuration configuration)

updateRootLayoutCaption

protected void updateRootLayoutCaption()

updateSearchButtonCaption

protected void updateSearchButtonCaption(boolean autoApply)

updateDataLoaderCondition

protected void updateDataLoaderCondition()

updateActionsState

protected void updateActionsState()

updateRootLogicalFilterComponent

protected void updateRootLogicalFilterComponent(LogicalFilterComponent logicalFilterComponent)

updateConditionRemoveButton

protected void updateConditionRemoveButton(SingleFilterComponent<?> singleFilter)

resetFilterComponentDefaultValue

protected void resetFilterComponentDefaultValue(PropertyFilter<?> propertyFilter)

updateSelectConfigurationButton

protected void updateSelectConfigurationButton()

clearValues

protected void clearValues()

copy

@Nullable
protected Condition copy(@Nullable
 Condition condition)

setupLoaderFirstResult

protected void setupLoaderFirstResult()