Interface FilterComponent

All Superinterfaces:
com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasStyle, Serializable
All Known Subinterfaces:
LogicalFilterComponent<C>, SingleFilterComponent<V>
All Known Implementing Classes:
FullTextFilter, GroupFilter, JpqlFilter, PropertyFilter, SingleFilterComponentBase

public interface FilterComponent extends com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasStyle
Component that can be used for filtering entities returned by the DataLoader. The filter component is related to Condition which will be used together with query when loading entities into the DataLoader.
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    Applies the current filter component condition.
     
     
    boolean
     
    boolean
     
    void
    setAutoApply(boolean autoApply)
    Sets whether the filter component should be automatically applied to the DataLoader when the value component value is changed.
    void
    setConditionModificationDelegated(boolean conditionModificationDelegated)
    Sets whether the modification of DataLoader condition is delegated to the owner FilterComponent or GenericFilter.
    void
    Sets a DataLoader related to the current filter component.

    Methods inherited from interface com.vaadin.flow.component.HasElement

    getElement

    Methods inherited from interface com.vaadin.flow.component.HasEnabled

    isEnabled, setEnabled

    Methods inherited from interface com.vaadin.flow.component.HasStyle

    addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName
  • Method Details

    • getDataLoader

      DataLoader getDataLoader()
      Returns:
      a DataLoader related to the current filter component
    • setDataLoader

      void setDataLoader(DataLoader dataLoader)
      Sets a DataLoader related to the current filter component.
      Parameters:
      dataLoader - a DataLoader to set
    • isAutoApply

      boolean isAutoApply()
      Returns:
      true if the filter component should be automatically applied to the DataLoader when the value component value is changed
    • setAutoApply

      void setAutoApply(boolean autoApply)
      Sets whether the filter component should be automatically applied to the DataLoader when the value component value is changed.
      Parameters:
      autoApply - true if the filter component should be automatically applied to the DataLoader when the value component value is changed
    • isConditionModificationDelegated

      boolean isConditionModificationDelegated()
      Returns:
      true if the filter component is located inside the GenericFilter and the modification of DataLoader condition is delegated to the owner FilterComponent or GenericFilter, false otherwise
    • setConditionModificationDelegated

      void setConditionModificationDelegated(boolean conditionModificationDelegated)
      Sets whether the modification of DataLoader condition is delegated to the owner FilterComponent or GenericFilter.
      Parameters:
      conditionModificationDelegated - true if the filter component is located inside the GenericFilter and the modification of DataLoader condition is delegated to the owner FilterComponent or GenericFilter, false otherwise
    • getQueryCondition

      Condition getQueryCondition()
      Returns:
      a Condition related to the current filter component
    • apply

      void apply()
      Applies the current filter component condition.