Class RunTimeConfiguration
java.lang.Object
io.jmix.flowui.component.genericfilter.configuration.RunTimeConfiguration
- All Implemented Interfaces:
Configuration
,Comparable<Configuration>
-
Field Summary
Modifier and TypeFieldDescriptionprotected boolean
protected final String
protected Set<FilterComponent>
protected String
protected final GenericFilter
protected LogicalFilterComponent<?>
-
Constructor Summary
ConstructorDescriptionRunTimeConfiguration
(String id, LogicalFilterComponent<?> rootLogicalFilterComponent, GenericFilter owner) -
Method Summary
Modifier and TypeMethodDescriptionint
compareTo
(Configuration other) boolean
getFilterComponentDefaultValue
(String parameterName) Returns a default value ofFilterComponent
by parameter name.getId()
getName()
getOwner()
int
hashCode()
boolean
Returns whether the configuration is available for all usersprotected boolean
isFilterComponentExist
(String parameterName) boolean
isFilterComponentModified
(FilterComponent filterComponent) Returns whether theFilterComponent
of configuration is modified.boolean
void
Sets null as the default value for all configuration filter components.void
resetFilterComponentDefaultValue
(String parameterName) Resets a default value ofFilterComponent
.void
setAvailableForAllUsers
(boolean availableForAllUsers) Sets whether the configuration is available for all users or notvoid
setFilterComponentDefaultValue
(String parameterName, Object defaultValue) Sets a default value ofFilterComponent
for the configuration by the parameter name.void
setFilterComponentModified
(FilterComponent filterComponent, boolean modified) Sets whether theFilterComponent
of configuration is modified.void
setModified
(boolean modified) Sets whether configuration is modified.void
Sets the name of configuration.void
setRootLogicalFilterComponent
(LogicalFilterComponent<?> rootLogicalFilterComponent) Sets the root element of configuration.
-
Field Details
-
id
-
owner
-
name
-
availableForAllUsers
protected boolean availableForAllUsers -
rootLogicalFilterComponent
-
modifiedFilterComponents
-
defaultValuesMap
-
-
Constructor Details
-
RunTimeConfiguration
public RunTimeConfiguration(String id, LogicalFilterComponent<?> rootLogicalFilterComponent, GenericFilter owner)
-
-
Method Details
-
getOwner
- Specified by:
getOwner
in interfaceConfiguration
- Returns:
- a
GenericFilter
owning the configuration
-
getId
- Specified by:
getId
in interfaceConfiguration
- Returns:
- a configuration id
-
getName
- Specified by:
getName
in interfaceConfiguration
- Returns:
- a configuration name
-
setName
Description copied from interface:Configuration
Sets the name of configuration. This method is only available for theRunTimeConfiguration
.- Specified by:
setName
in interfaceConfiguration
- Parameters:
name
- a configuration name- See Also:
-
getRootLogicalFilterComponent
- Specified by:
getRootLogicalFilterComponent
in interfaceConfiguration
- Returns:
- a root element of configuration
- See Also:
-
setRootLogicalFilterComponent
Description copied from interface:Configuration
Sets the root element of configuration. This method is only available for theRunTimeConfiguration
.- Specified by:
setRootLogicalFilterComponent
in interfaceConfiguration
- Parameters:
rootLogicalFilterComponent
- a root element of configuration- See Also:
-
getQueryCondition
- Specified by:
getQueryCondition
in interfaceConfiguration
- Returns:
- a
LogicalCondition
related to the configuration
-
isModified
public boolean isModified()- Specified by:
isModified
in interfaceConfiguration
- Returns:
- true if the configuration is modified
-
setModified
public void setModified(boolean modified) Description copied from interface:Configuration
Sets whether configuration is modified. If a filter component is modified, then a remove button appears next to it.- Specified by:
setModified
in interfaceConfiguration
- Parameters:
modified
- whether configuration is modified.
-
isFilterComponentModified
Description copied from interface:Configuration
Returns whether theFilterComponent
of configuration is modified. If a filter component is modified, then a remove button appears next to it.- Specified by:
isFilterComponentModified
in interfaceConfiguration
- Parameters:
filterComponent
- the filter component to check- Returns:
- whether the filter component of configuration is modified
-
setFilterComponentModified
Description copied from interface:Configuration
Sets whether theFilterComponent
of configuration is modified. If a filter component is modified, then a remove button appears next to it.- Specified by:
setFilterComponentModified
in interfaceConfiguration
- Parameters:
filterComponent
- a filter componentmodified
- whether the filter component of configuration is modified
-
setFilterComponentDefaultValue
Description copied from interface:Configuration
Sets a default value ofFilterComponent
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 interfaceConfiguration
- Parameters:
parameterName
- a parameter name of filter componentdefaultValue
- a default value
-
resetFilterComponentDefaultValue
Description copied from interface:Configuration
Resets a default value ofFilterComponent
. The default value for the filter component becomes null.- Specified by:
resetFilterComponentDefaultValue
in interfaceConfiguration
- Parameters:
parameterName
- a parameter name of filter component
-
getFilterComponentDefaultValue
Description copied from interface:Configuration
Returns a default value ofFilterComponent
by parameter name.- Specified by:
getFilterComponentDefaultValue
in interfaceConfiguration
- 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:Configuration
Sets null as the default value for all configuration filter components.- Specified by:
resetAllDefaultValues
in interfaceConfiguration
-
isFilterComponentExist
-
isAvailableForAllUsers
public boolean isAvailableForAllUsers()Description copied from interface:Configuration
Returns whether the configuration is available for all users- Specified by:
isAvailableForAllUsers
in interfaceConfiguration
- Returns:
- true if the configuration is available for all users, otherwise false.
-
setAvailableForAllUsers
public void setAvailableForAllUsers(boolean availableForAllUsers) Description copied from interface:Configuration
Sets whether the configuration is available for all users or not- Specified by:
setAvailableForAllUsers
in interfaceConfiguration
-
compareTo
- Specified by:
compareTo
in interfaceComparable<Configuration>
-
equals
-
hashCode
public int hashCode()
-