Package io.jmix.flowui.component.filter

Interface SingleFilterComponent<V>

Type Parameters:
V - value type
All Superinterfaces:
FilterComponent, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasStyle, HasSubParts, Serializable
All Known Implementing Classes:
FullTextFilter, JpqlFilter, PropertyFilter, SingleFilterComponentBase
public interface SingleFilterComponent<V> extends FilterComponent, HasSubParts
Component which cannot contain other filter component but can be used for filtering entities returned by the DataLoader.
See Also:

  • Method Details

    • getParameterName

      String getParameterName()
      Returns:
      the name of the associated query parameter name

    • setParameterName

      void setParameterName(String parameterName)
      Sets the name of the associated query parameter name.
      Parameters:
      parameterName - a name of the associated query parameter name

    • getSubPart

      @Nullable default Object getSubPart(String name)
      Specified by:
      getSubPart in interface HasSubParts

    • getValueComponent

      com.vaadin.flow.component.HasValueAndElement<?,V> getValueComponent()
      Returns:
      a field for editing a property value

    • setValueComponent

      void setValueComponent(com.vaadin.flow.component.HasValueAndElement<?,V> valueComponent)
      Sets the field for editing a property value.
      Parameters:
      valueComponent - a field for editing a property value

    • getLabelWidth

      @Nullable String getLabelWidth()
      Returns:
      the width which has been set for the label

    • setLabelWidth

      void setLabelWidth(@Nullable String labelWidth)
      Sets the label width.

      The width should be in a format understood by the browser, e.g. "100px" or "2.5em".

      If the provided width value is null then width is removed.

      Parameters:
      labelWidth - the width to set, may be null

    • isLabelVisible

      boolean isLabelVisible()
      Returns:
      true if label is visible

    • setLabelVisible

      void setLabelVisible(boolean labelVisible)
      Sets label visibility. Default value is true.
      Parameters:
      labelVisible - whether to show label or not