Package io.jmix.ui.component

Interface SingleFilterComponent<V>

Type Parameters:
V - value type
All Superinterfaces:
Component, Component.BelongToFrame, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, FilterComponent, HasContextHelp, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, HasValue<V>, Requirable, SupportsCaptionPosition, Validatable
All Known Subinterfaces:
FullTextFilter, JpqlFilter<V>, PropertyFilter<V>
All Known Implementing Classes:
AbstractSingleFilterComponent, FullTextFilterImpl, JpqlFilterImpl, PropertyFilterImpl
public interface SingleFilterComponent<V> extends FilterComponent, Component.BelongToFrame, HasValue<V>, Component.HasCaption, Component.HasIcon, Component.Focusable, Component.Editable, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, SupportsCaptionPosition, Requirable, Validatable, HasContextHelp
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

      @StudioProperty(type=STRING) void setParameterName(String parameterName)
      Sets the name of the associated query parameter name.
      Parameters:
      parameterName - a name of the associated query parameter name

    • getValueComponent

      HasValue<V> getValueComponent()
      Returns:
      a field for editing a property value

    • setValueComponent

      void setValueComponent(HasValue<V> valueComponent)
      Sets the field for editing a property value.
      Parameters:
      valueComponent - a field for editing a property value

    • getCaptionWidth

      float getCaptionWidth()
      Returns:
      a caption width value in Component.getWidthSizeUnit()

    • getCaptionWidthSizeUnit

      SizeUnit getCaptionWidthSizeUnit()
      Returns:
      units used in the caption width property

    • setCaptionWidth

      @StudioProperty(type=SIZE, defaultValue="100%") void setCaptionWidth(String captionWidth)
      Sets the caption width.
      Parameters:
      captionWidth - a string width representation

    • isCaptionVisible

      boolean isCaptionVisible()
      Returns:
      true if caption is visible

    • setCaptionVisible

      @StudioProperty(type=BOOLEAN, defaultValue="true") void setCaptionVisible(boolean captionVisible)
      Sets caption visibility. Default value is true.
      Parameters:
      captionVisible - whether to show caption or not