Package org.eclipse.nebula.widgets.nattable.sort

Interface ISortModel

All Known Implementing Classes:
GlazedListsSortModel, HierarchicalWrapperSortModel, SortModelFixture
public interface ISortModel
Interface providing sorting functionality.

  • Method Details

    • getSortedColumnIndexes

      List<Integer> getSortedColumnIndexes()
      Returns:
      List of column indexes that are sorted.

    • isColumnIndexSorted

      boolean isColumnIndexSorted(int columnIndex)
      Parameters:
      columnIndex - The column index to check.
      Returns:
      true if the column with the given index is sorted at the moment.

    • getSortDirection

      SortDirectionEnum getSortDirection(int columnIndex)
      Parameters:
      columnIndex - The column index for which the sort direction is requested.
      Returns:
      the direction in which the column with the given index is currently sorted

    • getSortOrder

      int getSortOrder(int columnIndex)
      Parameters:
      columnIndex - The column index for which the sort order is requested.
      Returns:
      when multiple columns are sorted, this returns the order of the column index in the sort

      Example: If column indexes 3, 6, 9 are sorted (in that order) the sort order for index 6 is 1.

    • getComparatorsForColumnIndex

      List<Comparator> getComparatorsForColumnIndex(int columnIndex)
      Parameters:
      columnIndex - The index of the column for which the row objects should be sorted.
      Returns:
      The collection of Comparators used to sort row objects by column values.

    • getColumnComparator

      Comparator<?> getColumnComparator(int columnIndex)
      Parameters:
      columnIndex - The index of the column for which the Comparator is requested.
      Returns:
      The Comparator that is used for sorting the values of a specified column. Needed in case of data model wrapping, e.g. GroupBy

    • sort

      void sort(int columnIndex, SortDirectionEnum sortDirection, boolean accumulate)
      This method is called by the SortCommandHandler in response to a sort command. It is responsible for sorting the requested column.
      Parameters:
      columnIndex - The column index to sort.
      sortDirection - The sort direction to apply.
      accumulate - flag indicating if the column should added to a previous sort.

    • clear

      void clear()
      Remove all sorting