Package io.jmix.ui.component

Interface Filter.Configuration

All Superinterfaces:
Comparable<Filter.Configuration>
All Known Implementing Classes:
DesignTimeConfiguration, RunTimeConfiguration
Enclosing interface:
Filter
public static interface Filter.Configuration extends Comparable<Filter.Configuration>
A configuration is a set of filter components.

  • Method Details

    • getOwner

      Filter getOwner()
      Returns:
      a Filter owning the configuration

    • getId

      String getId()
      Returns:
      a configuration id

    • getName

      @Nullable String getName()
      Returns:
      a configuration name

    • setName

      void setName(@Nullable String name)
      Sets the name of configuration. This method is only available for the RunTimeConfiguration.
      Parameters:
      name - a configuration name
      See Also:

    • getRootLogicalFilterComponent

      LogicalFilterComponent getRootLogicalFilterComponent()
      Returns:
      a root element of configuration
      See Also:

    • 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:

    • getQueryCondition

      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(String parameterName, @Nullable 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(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 Object getFilterComponentDefaultValue(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.

    • isAvailableForAllUsers

      default boolean isAvailableForAllUsers()
      Returns whether the configuration is available for all users
      Returns:
      true if the configuration is available for all users, otherwise false.

    • setAvailableForAllUsers

      default void setAvailableForAllUsers(boolean availableForAllUsers)
      Sets whether the configuration is available for all users or not