com.haulmont.cuba.gui.components

Interface Filter

All Superinterfaces:

Component, Component.BelongToFrame, Component.Collapsable, Component.HasCaption, Component.HasIcon, Component.HasNamedComponents, Component.HasSettings, Component.HasXmlDescriptor, Component.Margin

public interface Filter
extends Component.Margin, Component.BelongToFrame, Component.HasNamedComponents, Component.HasXmlDescriptor, Component.HasSettings, Component.HasCaption, Component.HasIcon, Component.Collapsable

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Filter.AfterFilterAppliedHandler
static interface	Filter.BeforeFilterAppliedHandler
static interface	Filter.FilterEntityChangeListener

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

Component.Collapsable.CollapseListener, Component.Collapsable.ExpandListener

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

Component.ActionOwner, Component.ActionsHolder, Component.Alignment, Component.BelongToFrame, Component.Buffered, Component.ChildEditableController, Component.Collapsable, Component.Container, Component.ContextHelpIconClickEvent, Component.Disposable, Component.Editable, Component.EditableChangeEvent, Component.EditableChangeListener, Component.EditableChangeNotifier, Component.ExpandedStateChangeEvent, Component.ExpandedStateChangeListener, Component.Focusable, Component.HasBorder, Component.HasButtonsPanel, Component.HasCaption, Component.HasContextHelp, Component.HasFormatter, Component.HasIcon, Component.HasInputPrompt, Component.HasNamedComponents, Component.HasOptionsStyleProvider, Component.HasPresentations, Component.HasRowsCount, Component.HasSettings, Component.HasValue, Component.HasXmlDescriptor, Component.LayoutClickEvent, Component.LayoutClickListener, Component.LayoutClickNotifier, Component.Margin, Component.MouseEventDetails, Component.OptionsStyleProvider, Component.OrderedContainer, Component.OuterMargin, Component.SecuredActionsHolder, Component.ShortcutAction, Component.ShortcutNotifier, Component.ShortcutTriggeredEvent, Component.Spacing, Component.UiPermissionAware, Component.Validatable, Component.ValueChangeEvent, Component.ValueChangeListener, Component.Wrapper

Field Summary

Fields

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

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

AUTO_SIZE, AUTO_SIZE_PX, UNITS_PERCENTAGE, UNITS_PIXELS

Method Summary

Modifier and Type	Method and Description
void	addFilterEntityChangeListener(Filter.FilterEntityChangeListener listener)
boolean	apply(boolean isNewWindow)
Filter.AfterFilterAppliedHandler	getAfterFilterAppliedHandler()
Component	getApplyTo()
Filter.BeforeFilterAppliedHandler	getBeforeFilterAppliedHandler()
int	getColumnsCount()
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.
boolean	getTextMaxResults()
boolean	getUseMaxResults()
boolean	isBorderVisible() Determines whether or not border is visible.
boolean	isEditable()
boolean	isFolderActionsEnabled()
void	setAfterFilterAppliedHandler(Filter.AfterFilterAppliedHandler afterFilterAppliedHandler)
void	setApplyTo(Component component)
void	setBeforeFilterAppliedHandler(Filter.BeforeFilterAppliedHandler beforeFilterAppliedHandler)
void	setBorderVisible(boolean visible) Sets whether border is visible.
void	setColumnsCount(int columnsCount) Number of conditions to be displayed in one row
void	setDatasource(CollectionDatasource datasource)
void	setEditable(boolean editable)
void	setFilterEntity(FilterEntity filterEntity)
void	setFolderActionsEnabled(boolean enabled)
void	setManualApplyRequired(java.lang.Boolean manualApplyRequired)
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	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	switchFilterMode(FilterDelegate.FilterMode filterMode)

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

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.Component.HasNamedComponents

getComponent

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

getXmlDescriptor, setXmlDescriptor

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

applySettings, isSettingsEnabled, saveSettings, setSettingsEnabled

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

getCaption, getDescription, setCaption, setDescription

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

getIcon, setIcon, setIconFromSet

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

addExpandedStateChangeListener, addListener, addListener, isCollapsable, isExpanded, removeExpandedStateChangeListener, removeListener, removeListener, setCollapsable, setExpanded

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

addStyleName, getAlignment, getDebugId, getHeight, getHeightUnits, getId, getParent, getStyleName, getWidth, getWidthUnits, isEnabled, isEnabledItself, isResponsive, isVisible, isVisibleItself, removeStyleName, requestFocus, setAlignment, setDebugId, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition

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 parent frame to apply filter.

See Also:

Constant Field Values

SELECT_ACTION_ID

static final java.lang.String SELECT_ACTION_ID

Action registered with parent frame to open filter select menu.

See Also:

Constant Field Values

Method Detail

getBeforeFilterAppliedHandler

Filter.BeforeFilterAppliedHandler getBeforeFilterAppliedHandler()

setBeforeFilterAppliedHandler

void setBeforeFilterAppliedHandler(Filter.BeforeFilterAppliedHandler beforeFilterAppliedHandler)

getAfterFilterAppliedHandler

Filter.AfterFilterAppliedHandler getAfterFilterAppliedHandler()

setAfterFilterAppliedHandler

void setAfterFilterAppliedHandler(Filter.AfterFilterAppliedHandler afterFilterAppliedHandler)

getDatasource

CollectionDatasource getDatasource()

setDatasource

void setDatasource(CollectionDatasource datasource)

setFilterEntity

void setFilterEntity(FilterEntity filterEntity)

apply

boolean apply(boolean isNewWindow)

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)

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)

getApplyTo

Component getApplyTo()

setManualApplyRequired

void setManualApplyRequired(java.lang.Boolean manualApplyRequired)

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