|
Eclipse Platform Release 3.3 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.jface.viewers.ViewerComparator
org.eclipse.jface.viewers.ViewerSorter
org.eclipse.jface.viewers.TreePathViewerSorter
A viewer sorter that is provided extra context in the form of the path of the parent element of the elements being sorted.
Field Summary |
---|
Fields inherited from class org.eclipse.jface.viewers.ViewerSorter |
---|
collator |
Constructor Summary | |
---|---|
TreePathViewerSorter()
|
Method Summary | |
---|---|
int |
category(TreePath parentPath,
Object element)
Provide a category for the given element that will have the given parent path when it is added to the viewer. |
int |
compare(Viewer viewer,
TreePath parentPath,
Object e1,
Object e2)
Compare the given elements that will have the given parent path when they are added to the viewer. |
boolean |
isSorterProperty(TreePath parentPath,
Object element,
String property)
Returns whether this viewer sorter would be affected by a change to the given property of the given element. |
void |
sort(Viewer viewer,
TreePath parentPath,
Object[] elements)
Sorts the given elements in-place, modifying the given array. |
Methods inherited from class org.eclipse.jface.viewers.ViewerSorter |
---|
getCollator |
Methods inherited from class org.eclipse.jface.viewers.ViewerComparator |
---|
category, compare, getComparator, isSorterProperty, sort |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public TreePathViewerSorter()
Method Detail |
public int category(TreePath parentPath, Object element)
null
when the elements are root elements.
By default, the this method calls
ViewerComparator.category(Object)
. Subclasses may override.
parentPath
- the parent path for the elementelement
- the element
public int compare(Viewer viewer, TreePath parentPath, Object e1, Object e2)
null
when the elements are root elements.
By default, the this method calls
ViewerComparator.sort(Viewer, Object[])
. Subclasses may override.
viewer
- the viewerparentPath
- the parent path for the two elementse1
- the first elemente2
- the second element
0
if the first element is
equal to the second element; and a positivepublic boolean isSorterProperty(TreePath parentPath, Object element, String property)
null
when the elements are root elements.
The default implementation of this method calls
ViewerComparator.isSorterProperty(Object, String)
.
Subclasses may reimplement.
parentPath
- the parent path of the elementelement
- the elementproperty
- the property
true
if the sorting would be affected,
and false
if it would be unaffectedpublic void sort(Viewer viewer, TreePath parentPath, Object[] elements)
null
when the elements are root elements.
The default implementation of this method uses the
java.util.Arrays#sort algorithm on the given array,
calling compare(Viewer, TreePath, Object, Object)
to compare elements.
Subclasses may reimplement this method to provide a more optimized implementation.
viewer
- the viewerparentPath
- the parent path of the given elementselements
- the elements to sort
|
Eclipse Platform Release 3.3 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2007. All rights reserved.