Class ViewerComparator

  • All Implemented Interfaces:
    IViewerComparator

    public class ViewerComparator
    extends org.eclipse.jface.viewers.ViewerSorter
    implements IViewerComparator
    Class to sort nodes in a CommonViewerEx.
    Author:
    Christopher Mindus
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int category​(java.lang.Object element)
      Returns the category of the given element.
      int compare​(org.eclipse.jface.viewers.Viewer viewer, java.lang.Object e1, java.lang.Object e2)
      Returns a negative, zero, or positive number depending on whether the first element is less than, equal to, or greater than the second element.
      boolean getReverseSortOrdering()
      Get reverse ordering flag.
      boolean getSortByCategory()
      Gets sorting by category.
      void setReverseSortOrdering​(boolean on)
      Sets reverse ordering.
      void setSortByCategory​(boolean on)
      Sets sorting by category.
      • Methods inherited from class org.eclipse.jface.viewers.ViewerSorter

        getCollator
      • Methods inherited from class org.eclipse.jface.viewers.ViewerComparator

        getComparator, isSorterProperty, sort
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • ViewerComparator

        public ViewerComparator()
        Creates a new ViewerComparator, which uses the default comparator to sort strings.
    • Method Detail

      • setSortByCategory

        public void setSortByCategory​(boolean on)
        Sets sorting by category.
      • getSortByCategory

        public boolean getSortByCategory()
        Gets sorting by category.
      • setReverseSortOrdering

        public void setReverseSortOrdering​(boolean on)
        Sets reverse ordering.
      • getReverseSortOrdering

        public boolean getReverseSortOrdering()
        Get reverse ordering flag.
      • category

        public int category​(java.lang.Object element)
        Returns the category of the given element. The category is a number used to allocate elements to bins; the bins are arranged in ascending numeric order. The elements within a bin are arranged via a second level sort criterion.
        Overrides:
        category in class org.eclipse.jface.viewers.ViewerComparator
        Parameters:
        element - the element.
        Returns:
        the category.
      • compare

        public int compare​(org.eclipse.jface.viewers.Viewer viewer,
                           java.lang.Object e1,
                           java.lang.Object e2)
        Returns a negative, zero, or positive number depending on whether the first element is less than, equal to, or greater than the second element.
        Specified by:
        compare in interface IViewerComparator
        Overrides:
        compare in class org.eclipse.jface.viewers.ViewerComparator
        Parameters:
        viewer - The viewer.
        e1 - The first element
        e2 - The second element.
        Returns:
        a negative number if the first element is less than the second element; the value 0 if the first element is equal to the second element; and a positive number if the first element is greater than the second element.