Interface SortCustomizer

  • All Known Implementing Classes:
    ECSortCustomizerDialog, SASortCustomizerDialog

    @API(type=INTERNAL,
         src=PUBLIC)
    public interface SortCustomizer
    Used for customizing the sorting information, typically through user interaction.
    • Method Detail

      • getSortInformation

        SortCriteriaInformation getSortInformation​(java.util.List<CriterionInformation> criteriaInformation,
                                                   boolean hasSelectedSortableElements,
                                                   boolean cannotSortAllElements)
        Obtain the sort information given some initial sort criteria.
        Parameters:
        criteriaInformation - The information about the available sorting criteria.
        hasSelectedSortableElements - true when elements selected in the document can be sorted.
        cannotSortAllElements - true when all the elements from the parent of the sort operation cannot be sorted. for example when the selected rows from a table can be sorted but the whole table cannot because it contains, outside the selected rows, some rows with multiple rowspan cells.
        Returns:
        The sort information, about criteria and the sort scope.