Eclipse Platform
Release 3.3

org.eclipse.ui.model
Class WorkbenchViewerComparator

java.lang.Object
  extended byorg.eclipse.jface.viewers.ViewerComparator
      extended byorg.eclipse.ui.model.WorkbenchViewerComparator

public class WorkbenchViewerComparator
extends ViewerComparator

A viewer comparator that sorts elements with registered workbench adapters by their text property. Note that capitalization differences are not considered by this sorter, so a > B > c

Since:
3.3
See Also:
IWorkbenchAdapter

Constructor Summary
WorkbenchViewerComparator()
          Creates a workbench viewer sorter using the default collator.
WorkbenchViewerComparator(Comparator comparator)
          Creates a workbench viewer sorter using the given collator.
 
Method Summary
 boolean isSorterProperty(Object element, String propertyId)
          Returns whether this viewer sorter would be affected by a change to the given property of the given element.
 
Methods inherited from class org.eclipse.jface.viewers.ViewerComparator
category, compare, getComparator, sort
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WorkbenchViewerComparator

public WorkbenchViewerComparator()
Creates a workbench viewer sorter using the default collator.


WorkbenchViewerComparator

public WorkbenchViewerComparator(Comparator comparator)
Creates a workbench viewer sorter using the given collator.

Parameters:
comparator - the comparator to use to sort strings
Method Detail

isSorterProperty

public boolean isSorterProperty(Object element,
                                String propertyId)
Description copied from class: ViewerComparator
Returns whether this viewer sorter would be affected by a change to the given property of the given element.

The default implementation of this method returns false. Subclasses may reimplement.

Overrides:
isSorterProperty in class ViewerComparator
Parameters:
element - the element
propertyId - the property
Returns:
true if the sorting would be affected, and false if it would be unaffected

Eclipse Platform
Release 3.3

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2007. All rights reserved.