io.jmix.ui.component

Interface Filter.Configuration

All Superinterfaces:

java.lang.Comparable<Filter.Configuration>

All Known Implementing Classes:

DesignTimeConfiguration, RunTimeConfiguration

Enclosing interface:

Filter

public static interface Filter.Configuration
extends java.lang.Comparable<Filter.Configuration>

A configuration is a set of filter components.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getFilterComponentDefaultValue(java.lang.String parameterName) Returns a default value of FilterComponent by parameter name.
java.lang.String	getId()
java.lang.String	getName()
Filter	getOwner()
io.jmix.core.querycondition.LogicalCondition	getQueryCondition()
LogicalFilterComponent	getRootLogicalFilterComponent()
boolean	isFilterComponentModified(FilterComponent filterComponent) Returns whether the FilterComponent of configuration is modified.
boolean	isModified()
void	resetAllDefaultValues() Sets null as the default value for all configuration filter components.
void	resetFilterComponentDefaultValue(java.lang.String parameterName) Resets a default value of FilterComponent.
void	setFilterComponentDefaultValue(java.lang.String parameterName, java.lang.Object defaultValue) Sets a default value of FilterComponent for the configuration by the parameter name.
void	setFilterComponentModified(FilterComponent filterComponent, boolean modified) Sets whether the FilterComponent of configuration is modified.
void	setModified(boolean modified) Sets whether configuration is modified.
void	setName(java.lang.String name) Sets the name of configuration.
void	setRootLogicalFilterComponent(LogicalFilterComponent rootLogicalFilterComponent) Sets the root element of configuration.

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getOwner

Filter getOwner()

Returns:

a Filter owning the configuration

getId

java.lang.String getId()

Returns:

a configuration id

getName

@Nullable
java.lang.String getName()

Returns:

a configuration name

setName

void setName(@Nullable
             java.lang.String name)

Sets the name of configuration. This method is only available for the RunTimeConfiguration.

Parameters:

name - a configuration name

See Also:

RunTimeConfiguration

getRootLogicalFilterComponent

LogicalFilterComponent getRootLogicalFilterComponent()

Returns:

a root element of configuration

See Also:

LogicalFilterComponent

setRootLogicalFilterComponent

void setRootLogicalFilterComponent(LogicalFilterComponent rootLogicalFilterComponent)

Sets the root element of configuration. This method is only available for the RunTimeConfiguration.

Parameters:

rootLogicalFilterComponent - a root element of configuration

See Also:

LogicalFilterComponent, RunTimeConfiguration

getQueryCondition

io.jmix.core.querycondition.LogicalCondition getQueryCondition()

Returns:

a LogicalCondition related to the configuration

isModified

boolean isModified()

Returns:

true if the configuration is modified

setModified

void setModified(boolean modified)

Sets whether configuration is modified. If a filter component is modified, then a remove button appears next to it.

Parameters:

modified - whether configuration is modified.

isFilterComponentModified

boolean isFilterComponentModified(FilterComponent filterComponent)

Returns whether the FilterComponent of configuration is modified. If a filter component is modified, then a remove button appears next to it.

Parameters:

filterComponent - the filter component to check

Returns:

whether the filter component of configuration is modified

setFilterComponentModified

void setFilterComponentModified(FilterComponent filterComponent,
                                boolean modified)

Sets whether the FilterComponent of configuration is modified. If a filter component is modified, then a remove button appears next to it.

Parameters:

filterComponent - a filter component

modified - whether the filter component of configuration is modified

setFilterComponentDefaultValue

void setFilterComponentDefaultValue(java.lang.String parameterName,
                                    @Nullable
                                    java.lang.Object defaultValue)

Sets a default value of FilterComponent for the configuration by the parameter name. This allows the default values to be saved and displayed in the configuration editor.

Parameters:

parameterName - a parameter name of filter component

defaultValue - a default value

resetFilterComponentDefaultValue

void resetFilterComponentDefaultValue(java.lang.String parameterName)

Resets a default value of FilterComponent. The default value for the filter component becomes null.

Parameters:

parameterName - a parameter name of filter component

getFilterComponentDefaultValue

@Nullable
java.lang.Object getFilterComponentDefaultValue(java.lang.String parameterName)

Returns a default value of FilterComponent by parameter name.

Parameters:

parameterName - a parameter name of filter component

Returns:

a default value of filter component by parameter name

resetAllDefaultValues

void resetAllDefaultValues()

Sets null as the default value for all configuration filter components.