Package io.jmix.ui.component.data

Interface GroupTableItems<I>

All Superinterfaces:
DataUnit, TableItems<I>, TableItems.Ordered<I>, TableItems.Sortable<I>
All Known Implementing Classes:
ContainerGroupTableItems, EmptyGroupTableItems
public interface GroupTableItems<I> extends TableItems.Sortable<I>

  • Method Details

    • groupBy

      void groupBy(@Nullable Object[] properties)
      Perform grouping by the list of properties

    • rootGroups

      List<GroupInfo> rootGroups()
      Returns:
      the list of root groups

    • hasChildren

      boolean hasChildren(GroupInfo groupId)
      Indicates that group has nested groups

    • getChildren

      List<GroupInfo> getChildren(GroupInfo groupId)
      Returns:
      the list of nested groups

    • getOwnChildItems

      List<I> getOwnChildItems(GroupInfo groupId)
      Returns:
      the list of nested items

    • getChildItems

      List<I> getChildItems(GroupInfo groupId)
      Returns:
      the list of items from all nested group levels

    • getParentGroup

      @Nullable GroupInfo getParentGroup(I item)
      Returns:
      the parent group of passed item

    • getGroupPath

      List<GroupInfo> getGroupPath(I item)
      Returns:
      the path through all parent groups

    • getGroupProperty

      @Nullable Object getGroupProperty(GroupInfo groupId)
      Returns:
      a group property

    • getGroupPropertyValue

      @Nullable Object getGroupPropertyValue(GroupInfo groupId)
      Returns:
      a group property value

    • getGroupItemIds

      Collection<?> getGroupItemIds(GroupInfo groupId)
      Returns:
      item ids that are contained in the selected group

    • getGroupItemsCount

      int getGroupItemsCount(GroupInfo groupId)
      Returns:
      a count of items that are contained in the selected group

    • hasGroups

      boolean hasGroups()
      Indicated that a datasource has groups

    • getGroupProperties

      Collection<?> getGroupProperties()
      Returns:
      group properties

    • containsGroup

      boolean containsGroup(GroupInfo groupId)
      Indicates that a group is contained in the groups tree