com.haulmont.cuba.gui.components

Interface Filter

All Superinterfaces:

Collapsable, Component, Component.BelongToFrame, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, HasContextHelp, HasDataLoadingSettings, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, HasMargin, HasNamedComponents, HasSettings

public interface Filter
extends HasMargin, Component.BelongToFrame, HasNamedComponents, HasSettings, HasDataLoadingSettings, Component.HasCaption, HasContextHelp, Component.HasIcon, Collapsable, Component.Focusable, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer

Generic filter component.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Filter.AfterFilterAppliedHandler
static interface	Filter.BeforeFilterAppliedHandler
static interface	Filter.FilterEntityChangeListener
static class	Filter.FilterOptions
static interface	Filter.PropertiesFilterPredicate A predicate that tests whether a property with the given path should be available for filtering.

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.HasContextHelp

HasContextHelp.ContextHelpIconClickEvent

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.Collapsable

Collapsable.ExpandedStateChangeEvent

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.Component

Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.OptionsStyleProvider, Component.Wrapper

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	APPLY_ACTION_ID Action registered with list component and filter layout to apply filter.
static java.lang.String	NAME
static java.lang.String	SELECT_ACTION_ID Action registered with list component and filter layout to open filter select menu.

Fields inherited from interface com.haulmont.cuba.gui.components.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE, UNITS_PERCENTAGE, UNITS_PIXELS

Method Summary

Modifier and Type	Method and Description
void	addFilterEntityChangeListener(Filter.FilterEntityChangeListener listener)
boolean	apply(boolean notifyInvalidConditions) Applies the filter.
boolean	apply(Filter.FilterOptions options) Applies the filter.
void	createLayout() Recreates filter layout
Filter.AfterFilterAppliedHandler	getAfterFilterAppliedHandler()
Component	getApplyTo()
Filter.BeforeFilterAppliedHandler	getBeforeFilterAppliedHandler()
int	getColumnsCount()
java.lang.String	getControlsLayoutTemplate() Returns a template for filter controls layout.
BaseCollectionLoader	getDataLoader() Returns DataLoader which the filter is applied to.
CollectionDatasource	getDatasource()
java.util.List<Filter.FilterEntityChangeListener>	getFilterEntityChangeListeners()
java.lang.Boolean	getManualApplyRequired()
int	getMaxResults()
java.lang.Object	getParamValue(java.lang.String paramName) Gets the value of the filter parameter component.
Filter.PropertiesFilterPredicate	getPropertiesFilterPredicate()
boolean	getTextMaxResults()
boolean	getUseMaxResults()
boolean	isApplyImmediately()
boolean	isBorderVisible() Determines whether or not border is visible.
boolean	isEditable()
boolean	isFolderActionsEnabled()
boolean	isWindowCaptionUpdateEnabled()
void	setAfterFilterAppliedHandler(Filter.AfterFilterAppliedHandler afterFilterAppliedHandler)
void	setApplyImmediately(boolean immediately) Set to true if filter should be applied immediately after every parameter's value changing.
void	setApplyTo(Component component) Sets the component associated with the filter.
void	setBeforeFilterAppliedHandler(Filter.BeforeFilterAppliedHandler beforeFilterAppliedHandler) Sets the handler that will be invoked before the filter is applied.
void	setBorderVisible(boolean visible) Sets whether border is visible.
void	setColumnsCount(int columnsCount) Number of conditions to be displayed in one row
void	setControlsLayoutTemplate(java.lang.String controlsLayoutTemplate) Sets a template for filter controls layout.
void	setDataLoader(BaseCollectionLoader loader) Sets DataLoader which the filter is applied to.
void	setDatasource(CollectionDatasource datasource)
void	setEditable(boolean editable)
void	setFilterEntity(FilterEntity filterEntity)
void	setFolderActionsEnabled(boolean enabled)
void	setManualApplyRequired(java.lang.Boolean manualApplyRequired) Defines when the filter will be applied.
void	setMaxResults(int maxResults) Sets rows count restriction.
void	setModeSwitchVisible(boolean modeSwitchVisible) Sets filter mode switch visibility
void	setParamValue(java.lang.String paramName, java.lang.Object value) Sets the value to the filter parameter component.
void	setPropertiesFilterPredicate(Filter.PropertiesFilterPredicate predicate) Enables to setup which properties should be available for filtering.
void	setTextMaxResults(boolean textMaxResults) Whether to use a text field for entering a max results value.
void	setUseMaxResults(boolean useMaxResults) Whether to show field for rows count restriction.
void	setWindowCaptionUpdateEnabled(boolean windowCaptionUpdateEnabled) If windowCaptionUpdateEnabled is true then window caption will contain a filter name, e.g.
void	switchFilterMode(FilterDelegate.FilterMode filterMode) Changes the filter mode and repaints the filter layout

Methods inherited from interface com.haulmont.cuba.gui.components.HasMargin

getMargin, setMargin, setMargin, setMargin

Methods inherited from interface com.haulmont.cuba.gui.components.Component.BelongToFrame

getFrame, setFrame

Methods inherited from interface com.haulmont.cuba.gui.components.HasNamedComponents

getComponent

Methods inherited from interface com.haulmont.cuba.gui.components.HasSettings

applySettings, isSettingsEnabled, saveSettings, setSettingsEnabled

Methods inherited from interface com.haulmont.cuba.gui.components.HasDataLoadingSettings

applyDataLoadingSettings

Methods inherited from interface com.haulmont.cuba.gui.components.HasContextHelp

getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasIcon

getIcon, setIcon, setIconFromSet

Methods inherited from interface com.haulmont.cuba.gui.components.Collapsable

addExpandedStateChangeListener, isCollapsable, isExpanded, removeExpandedStateChangeListener, setCollapsable, setExpanded

Methods inherited from interface com.haulmont.cuba.gui.components.Component.Focusable

focus, getTabIndex, isFocusable, setFocusable, setTabIndex

Methods inherited from interface com.haulmont.cuba.gui.components.Component

addStyleName, getAlignment, getHeight, getHeightSizeUnit, getHeightUnits, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, getWidthUnits, isEnabled, isEnabledItself, isEnabledRecursive, isResponsive, isVisible, isVisibleItself, isVisibleRecursive, removeStyleName, requestFocus, 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 com.haulmont.cuba.gui.components.HasHtmlCaption

isCaptionAsHtml, setCaptionAsHtml

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasCaption

getCaption, setCaption

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasDescription

getDescription, setDescription

Methods inherited from interface com.haulmont.cuba.gui.components.HasHtmlDescription

isDescriptionAsHtml, setDescriptionAsHtml

Methods inherited from interface com.haulmont.cuba.gui.components.HasHtmlSanitizer

isHtmlSanitizerEnabled, setHtmlSanitizerEnabled

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

APPLY_ACTION_ID

static final java.lang.String APPLY_ACTION_ID

Action registered with list component and filter layout to apply filter.

See Also:

Constant Field Values

SELECT_ACTION_ID

static final java.lang.String SELECT_ACTION_ID

Action registered with list component and filter layout to open filter select menu.

See Also:

Constant Field Values

Method Detail

getBeforeFilterAppliedHandler

Filter.BeforeFilterAppliedHandler getBeforeFilterAppliedHandler()

setBeforeFilterAppliedHandler

void setBeforeFilterAppliedHandler(Filter.BeforeFilterAppliedHandler beforeFilterAppliedHandler)

Sets the handler that will be invoked before the filter is applied. If the Filter.BeforeFilterAppliedHandler.beforeFilterApplied() returns false, then the filter won't be applied

Parameters:

beforeFilterAppliedHandler - handler

getAfterFilterAppliedHandler

Filter.AfterFilterAppliedHandler getAfterFilterAppliedHandler()

setAfterFilterAppliedHandler

void setAfterFilterAppliedHandler(Filter.AfterFilterAppliedHandler afterFilterAppliedHandler)

getDataLoader

BaseCollectionLoader getDataLoader()

Returns DataLoader which the filter is applied to.

setDataLoader

void setDataLoader(BaseCollectionLoader loader)

Sets DataLoader which the filter is applied to.

createLayout

void createLayout()

Recreates filter layout

getDatasource

CollectionDatasource getDatasource()

setDatasource

void setDatasource(CollectionDatasource datasource)

setFilterEntity

void setFilterEntity(FilterEntity filterEntity)

apply

boolean apply(Filter.FilterOptions options)

Applies the filter. Before the filter is applied, conditions correctness is checked. If invalid conditions are found (i.e. empty required conditions) then the filter will not be applied.

Parameters:

options - an options object

apply

boolean apply(boolean notifyInvalidConditions)

Applies the filter. Before the filter is applied, conditions correctness is checked. If invalid conditions are found (i.e. empty required conditions) then the filter will not be applied.

Parameters:

notifyInvalidConditions - whether a notification about invalid conditions values should be displayed

Returns:

true if the filter was applied, false otherwise

setMaxResults

void setMaxResults(int maxResults)

Sets rows count restriction. Particularly useful when maxResults field is hidden. 0 in case of no limits.

Parameters:

maxResults - restriction on number of rows

getMaxResults

int getMaxResults()

setModeSwitchVisible

void setModeSwitchVisible(boolean modeSwitchVisible)

Sets filter mode switch visibility

switchFilterMode

void switchFilterMode(FilterDelegate.FilterMode filterMode)

Changes the filter mode and repaints the filter layout

setUseMaxResults

void setUseMaxResults(boolean useMaxResults)

Whether to show field for rows count restriction.

Automatically set to false for HierarchicalDatasource.

getUseMaxResults

boolean getUseMaxResults()

setTextMaxResults

void setTextMaxResults(boolean textMaxResults)

Whether to use a text field for entering a max results value. LookupField is used by default.

Parameters:

textMaxResults - true if use TextField

getTextMaxResults

boolean getTextMaxResults()

setApplyTo

void setApplyTo(Component component)

Sets the component associated with the filter.

getApplyTo

Component getApplyTo()

setManualApplyRequired

void setManualApplyRequired(java.lang.Boolean manualApplyRequired)

Defines when the filter will be applied. If the attribute value is false, the filter (default or empty) will be applied when the screen is opened. It means that the datasource will be refreshed and linked components (e.g. Table) will display data. If the value is true, the filter will be applied only after the Search button is clicked.

getManualApplyRequired

java.lang.Boolean getManualApplyRequired()

setEditable

void setEditable(boolean editable)

isEditable

boolean isEditable()

setFolderActionsEnabled

void setFolderActionsEnabled(boolean enabled)

isFolderActionsEnabled

boolean isFolderActionsEnabled()

setParamValue

void setParamValue(java.lang.String paramName,
                   java.lang.Object value)

Sets the value to the filter parameter component. Do not use this method in init() method of screen controller, because filter is not initialized by that time. The proper place to use the method is ready() method of the controller.

Parameters:

paramName - parameter name. It can be found at runtime in the filter editor window. Right click at the necessary condition and select 'Show component name' item in the popup menu. Component name there will be like 'component$genericFilter.email12482'. paramName parameter in this method requires only the last part of this string, i.e. you should pass 'email12482'

value - parameter value

getParamValue

java.lang.Object getParamValue(java.lang.String paramName)

Gets the value of the filter parameter component. Do not use this method in init() method of screen controller, because filter is not initialized by that time. The proper place to use the method is ready() method of the controller.

Parameters:

paramName - parameter name. It can be found at runtime in the filter editor window. Right click at the necessary condition and select 'Show component name' item in the popup menu. Component name there will be like 'component$genericFilter.email12482'. paramName parameter in this method requires only the last part of this string, i.e. you should pass 'email12482'

Returns:

parameter value

addFilterEntityChangeListener

void addFilterEntityChangeListener(Filter.FilterEntityChangeListener listener)

getFilterEntityChangeListeners

java.util.List<Filter.FilterEntityChangeListener> getFilterEntityChangeListeners()

setColumnsCount

void setColumnsCount(int columnsCount)

Number of conditions to be displayed in one row

getColumnsCount

int getColumnsCount()

setBorderVisible

void setBorderVisible(boolean visible)

Sets whether border is visible.

Parameters:

visible - true to show the border, false to hide it

isBorderVisible

boolean isBorderVisible()

Determines whether or not border is visible.

Returns:

true if the border is visible

setPropertiesFilterPredicate

void setPropertiesFilterPredicate(Filter.PropertiesFilterPredicate predicate)

Enables to setup which properties should be available for filtering.

Parameters:

predicate - properties filter predicate

getPropertiesFilterPredicate

Filter.PropertiesFilterPredicate getPropertiesFilterPredicate()

Returns:

properties filter predicate

setWindowCaptionUpdateEnabled

void setWindowCaptionUpdateEnabled(boolean windowCaptionUpdateEnabled)

If windowCaptionUpdateEnabled is true then window caption will contain a filter name, e.g. "Some Browser: filterName", if the parameter value is false, when window caption will not be modified when the filter is selected

isWindowCaptionUpdateEnabled

boolean isWindowCaptionUpdateEnabled()

setApplyImmediately

void setApplyImmediately(boolean immediately)

Set to true if filter should be applied immediately after every parameter's value changing. True, by default. Default value can be managed by using ClientConfig.getGenericFilterApplyImmediately() property.

Parameters:

immediately - immediately option

isApplyImmediately

boolean isApplyImmediately()

Returns:

true if filter should be applied immediately after every parameter's value changing

getControlsLayoutTemplate

java.lang.String getControlsLayoutTemplate()

Returns a template for filter controls layout. See ClientConfig.getGenericFilterControlsLayout()

setControlsLayoutTemplate

void setControlsLayoutTemplate(java.lang.String controlsLayoutTemplate)

Sets a template for filter controls layout. See ClientConfig.getGenericFilterControlsLayout()