Package io.jmix.flowui.component.groupgrid

Interface GroupColumn<E>

Type Parameters:
E - item type
All Known Implementing Classes:
GroupDataGridColumn
public interface GroupColumn<E>
Interface to be implemented by group columns. The group column is a special column used to display a hierarchy of grouped items, manage the grouping and expand/collapse group rows.

  • Method Details

    • isAutoHidden

      boolean isAutoHidden()
      Returns:
      true if the column is automatically hidden when there are no grouping columns

    • setAutoHidden

      void setAutoHidden(boolean autoHidden)
      Sets whether the column is automatically hidden when there are no grouping columns.

      The default value is false.

      Parameters:
      autoHidden - autoHidden option

    • isDisplayItemsCount

      boolean isDisplayItemsCount()
      Returns:
      true if the column displays the number of items in each group

    • setDisplayItemsCount

      void setDisplayItemsCount(boolean displayItemsCount)
      Sets whether the column displays the number of items in each group.

      The default value is true.

      Parameters:
      displayItemsCount - displayItemsCount option

    • isDisplayColumnsGrouperOnIconClick

      boolean isDisplayColumnsGrouperOnIconClick()
      Returns:
      true if the column displays a button that opens a popup that manages columns grouping

    • setDisplayColumnsGrouperOnIconClick

      void setDisplayColumnsGrouperOnIconClick(boolean displayColumnsGrouper)
      Sets whether the column displays a button that opens a popup that manages columns grouping.

      The default value is true.

      Parameters:
      displayColumnsGrouper - displayColumnsGrouper option

    • getGroupIcon

      @Deprecated(since="2.8", forRemoval=true) @Nullable com.vaadin.flow.component.icon.Icon getGroupIcon()
      Deprecated, for removal: This API element is subject to removal in a future version.
      use getGroupIconComponent() instead
      Returns:
      the icon for the Columns Grouper button or null if the default icon is used

    • setGroupIcon

      @Deprecated(since="2.8", forRemoval=true) void setGroupIcon(@Nullable com.vaadin.flow.component.icon.Icon icon)
      Deprecated, for removal: This API element is subject to removal in a future version.
      use setGroupIconComponent(Component) instead
      Sets the icon for the Columns Grouper button.
      Parameters:
      icon - the icon to set, or null to set the default icon

    • getGroupIconComponent

      @Nullable com.vaadin.flow.component.Component getGroupIconComponent()
      Returns:
      the icon for the Columns Grouper button or null if the default icon is used

    • setGroupIconComponent

      void setGroupIconComponent(@Nullable com.vaadin.flow.component.Component icon)
      Sets the icon for the Columns Grouper button.
      Parameters:
      icon - the icon to set, or null to set the default icon

    • isGroupIconVisible

      boolean isGroupIconVisible()
      Returns:
      true if the icon for the Columns Grouper button is visible

    • setGroupIconVisible

      void setGroupIconVisible(boolean visible)
      Sets whether the icon for the Columns Grouper button is visible.

      The default value is true.

      Parameters:
      visible - visible option

    • getGroupCellValueFormatter

      @Nullable GroupCellValueFormatter<E> getGroupCellValueFormatter()
      Returns:
      a formatter for group cell values or null if no formatter is set.

    • setGroupCellValueFormatter

      void setGroupCellValueFormatter(@Nullable GroupCellValueFormatter<E> groupCellValueFormatter)
      Sets a formatter for group cell values.
      Parameters:
      groupCellValueFormatter - a formatter to set, or null to remove the formatter