Package io.jmix.ui.component.filter.configuration

Class DesignTimeConfiguration

java.lang.Object

io.jmix.ui.component.filter.configuration.DesignTimeConfiguration

All Implemented Interfaces:

Filter.Configuration, Comparable<Filter.Configuration>

public class DesignTimeConfiguration
extends Object
implements Filter.Configuration

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,Object>	defaultValuesMap
protected final String	id
protected final String	name
protected final Filter	owner
protected final LogicalFilterComponent	rootLogicalFilterComponent

Constructor Summary

Constructors

Constructor	Description
DesignTimeConfiguration(String id, String name, LogicalFilterComponent rootLogicalFilterComponent, Filter owner)

Method Summary

Modifier and Type	Method	Description
int	compareTo(Filter.Configuration other)
boolean	equals(Object obj)
Object	getFilterComponentDefaultValue(String parameterName)	Returns a default value of FilterComponent by parameter name.
String	getId()
String	getName()
Filter	getOwner()
LogicalCondition	getQueryCondition()
LogicalFilterComponent	getRootLogicalFilterComponent()
int	hashCode()
protected boolean	isFilterComponentExist(String parameterName)
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(String parameterName)	Resets a default value of FilterComponent.
void	setFilterComponentDefaultValue(String parameterName, 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(String name)	Sets the name of configuration.
void	setRootLogicalFilterComponent(LogicalFilterComponent rootLogicalFilterComponent)	Sets the root element of configuration.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

id

protected final String id

name

protected final String name

rootLogicalFilterComponent

protected final LogicalFilterComponent rootLogicalFilterComponent

owner

protected final Filter owner

defaultValuesMap

protected Map<String,Object> defaultValuesMap

Constructor Details

DesignTimeConfiguration

public DesignTimeConfiguration(String id,
 @Nullable
 String name,
 LogicalFilterComponent rootLogicalFilterComponent,
 Filter owner)

Method Details

getOwner

public Filter getOwner()

Specified by:

getOwner in interface Filter.Configuration

Returns:

a Filter owning the configuration

getId

@StudioProperty(name="id",
                type=STRING,
                required=true)
public String getId()

Specified by:

getId in interface Filter.Configuration

Returns:

a configuration id

getName

@Nullable
public String getName()

Specified by:

getName in interface Filter.Configuration

Returns:

a configuration name

setName

@StudioProperty(name="name",
                type=LOCALIZED_STRING)
public void setName(@Nullable
 String name)

Description copied from interface: Filter.Configuration

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

Specified by:

setName in interface Filter.Configuration

Parameters:

name - a configuration name

See Also:

• RunTimeConfiguration

getRootLogicalFilterComponent

public LogicalFilterComponent getRootLogicalFilterComponent()

Specified by:

getRootLogicalFilterComponent in interface Filter.Configuration

Returns:

a root element of configuration

See Also:

• LogicalFilterComponent

setRootLogicalFilterComponent

public void setRootLogicalFilterComponent(LogicalFilterComponent rootLogicalFilterComponent)

Description copied from interface: Filter.Configuration

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

Specified by:

setRootLogicalFilterComponent in interface Filter.Configuration

Parameters:

rootLogicalFilterComponent - a root element of configuration

See Also:

• LogicalFilterComponent
• RunTimeConfiguration

getQueryCondition

public LogicalCondition getQueryCondition()

Specified by:

getQueryCondition in interface Filter.Configuration

Returns:

a LogicalCondition related to the configuration

isModified

public boolean isModified()

Specified by:

isModified in interface Filter.Configuration

Returns:

true if the configuration is modified

setModified

public void setModified(boolean modified)

Description copied from interface: Filter.Configuration

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

Specified by:

setModified in interface Filter.Configuration

Parameters:

modified - whether configuration is modified.

isFilterComponentModified

public boolean isFilterComponentModified(FilterComponent filterComponent)

Description copied from interface: Filter.Configuration

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

Specified by:

isFilterComponentModified in interface Filter.Configuration

Parameters:

filterComponent - the filter component to check

Returns:

whether the filter component of configuration is modified

setFilterComponentModified

public void setFilterComponentModified(FilterComponent filterComponent,
 boolean modified)

Description copied from interface: Filter.Configuration

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

Specified by:

setFilterComponentModified in interface Filter.Configuration

Parameters:

filterComponent - a filter component

modified - whether the filter component of configuration is modified

setFilterComponentDefaultValue

public void setFilterComponentDefaultValue(String parameterName,
 @Nullable
 Object defaultValue)

Description copied from interface: Filter.Configuration

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.

Specified by:

setFilterComponentDefaultValue in interface Filter.Configuration

Parameters:

parameterName - a parameter name of filter component

defaultValue - a default value

resetFilterComponentDefaultValue

public void resetFilterComponentDefaultValue(String parameterName)

Description copied from interface: Filter.Configuration

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

Specified by:

resetFilterComponentDefaultValue in interface Filter.Configuration

Parameters:

parameterName - a parameter name of filter component

getFilterComponentDefaultValue

@Nullable
public Object getFilterComponentDefaultValue(String parameterName)

Description copied from interface: Filter.Configuration

Returns a default value of FilterComponent by parameter name.

Specified by:

getFilterComponentDefaultValue in interface Filter.Configuration

Parameters:

parameterName - a parameter name of filter component

Returns:

a default value of filter component by parameter name

resetAllDefaultValues

public void resetAllDefaultValues()

Description copied from interface: Filter.Configuration

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

Specified by:

resetAllDefaultValues in interface Filter.Configuration

isFilterComponentExist

protected boolean isFilterComponentExist(String parameterName)

compareTo

public int compareTo(Filter.Configuration other)

Specified by:

compareTo in interface Comparable<Filter.Configuration>

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object