org.eclipse.hyades.ui.internal.navigator
Class NavigatorViewerSorter

java.lang.Object
  org.eclipse.jface.viewers.ViewerComparator
      org.eclipse.jface.viewers.ViewerSorter
          org.eclipse.hyades.ui.internal.util.HyadesViewerSorter
              org.eclipse.hyades.ui.internal.navigator.NavigatorViewerSorter

All Implemented Interfaces:

org.eclipse.hyades.ui.util.IDisposable

public class NavigatorViewerSorter
extends HyadesViewerSorter
implements org.eclipse.hyades.ui.util.IDisposable

Sorter for viewers that display items of type IResource, INamedElement, LogicalFolder and IAdaptable that have IResource as a valid adapter.

The sorter supports two sort criteria:

NAME: Folders are given order precedence, followed by files. Within these two groups resources are ordered by name. All name comparisons are case-insensitive.

TYPE: Folders are given order precedence, followed by files. Within these two groups resources are ordered by extension.

All extension comparisons are case-insensitive.

This implementation is based on the org.eclipse.ui.views.navigator.ResourceSorter class.

Field Summary

static int	NAME Constructor argument value that indicates to sort items by name.
static int	SORTER_TYPE Change type to be passed to the navigator's handleChange(int) method.
static int	TYPE Constructor argument value that indicates to sort items by extension.

Fields inherited from class org.eclipse.jface.viewers.ViewerSorter

collator

Constructor Summary

NavigatorViewerSorter(INavigator navigator, int criteria)
Constructor for NavigatorViewerSorter

Method Summary

int	category(java.lang.Object element)
void	dispose()
protected java.lang.String	getAdaptableValue(org.eclipse.jface.viewers.Viewer viewer, org.eclipse.core.runtime.IAdaptable adaptable) Returns the value for an adaptable or null if no value can be assigned.
int	getCriteria() Returns the sort criteria of this this sorter.
protected java.lang.String	getLogicalFolderValue(org.eclipse.jface.viewers.Viewer viewer, LogicalFolder logicalFolder) Returns the value for a LogicFolder or null if no value can be assigned.
protected java.lang.String	getNamedElementValue(org.eclipse.jface.viewers.Viewer viewer, org.eclipse.hyades.ui.util.INamedElement namedElement) Returns the value for an namedElement or null if no value can be assigned.
INavigator	getNavigator() Returns this sorter's navigator
protected java.lang.String	getResourceValue(org.eclipse.jface.viewers.Viewer viewer, org.eclipse.core.resources.IResource resource) Returns the value for a IResource or null if no value can be assigned.
protected java.lang.String	getValue(org.eclipse.jface.viewers.Viewer viewer, java.lang.Object e) Returns the comparison value for the specified object
void	setCriteria(int newCriteria) Sets the sort criteria of this this sorter.

Methods inherited from class org.eclipse.hyades.ui.internal.util.HyadesViewerSorter

compare, compareCategories, compareValues

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

Field Detail

SORTER_TYPE

public static final int SORTER_TYPE

Change type to be passed to the navigator's handleChange(int) method.

NAME

public static final int NAME

Constructor argument value that indicates to sort items by name.

See Also:

Constant Field Values

TYPE

public static final int TYPE

Constructor argument value that indicates to sort items by extension.

See Also:

Constant Field Values

Constructor Detail

NavigatorViewerSorter

public NavigatorViewerSorter(INavigator navigator,
                             int criteria)

Constructor for NavigatorViewerSorter

Method Detail

dispose

public void dispose()

Specified by:

dispose in interface org.eclipse.hyades.ui.util.IDisposable

See Also:

IDisposable.dispose()

getNavigator

public INavigator getNavigator()

Returns this sorter's navigator

Returns:

INavigator

setCriteria

public void setCriteria(int newCriteria)

Sets the sort criteria of this this sorter.

Parameters:

the - sort criterion: one of NAME or TYPE. Any other value is not considered.

getCriteria

public int getCriteria()

Returns the sort criteria of this this sorter.

Returns:

the sort criterion: one of NAME or TYPE

category

public int category(java.lang.Object element)

Overrides:

category in class org.eclipse.jface.viewers.ViewerComparator

See Also:

ViewerComparator.category(java.lang.Object)

getValue

protected java.lang.String getValue(org.eclipse.jface.viewers.Viewer viewer,
                                    java.lang.Object e)

Description copied from class: HyadesViewerSorter

Returns the comparison value for the specified object

Overrides:

getValue in class HyadesViewerSorter

Returns:

String

See Also:

HyadesViewerSorter.getValue(org.eclipse.jface.viewers.Viewer, java.lang.Object)

getLogicalFolderValue

protected java.lang.String getLogicalFolderValue(org.eclipse.jface.viewers.Viewer viewer,
                                                 LogicalFolder logicalFolder)

Returns the value for a LogicFolder or null if no value can be assigned. This implementation returns always the same value so the initial order should be preserved.

Parameters:

viewer -

logicalFolder -

Returns:

String

getResourceValue

protected java.lang.String getResourceValue(org.eclipse.jface.viewers.Viewer viewer,
                                            org.eclipse.core.resources.IResource resource)

Returns the value for a IResource or null if no value can be assigned.

Parameters:

viewer -

resource -

Returns:

String

getAdaptableValue

protected java.lang.String getAdaptableValue(org.eclipse.jface.viewers.Viewer viewer,
                                             org.eclipse.core.runtime.IAdaptable adaptable)

Returns the value for an adaptable or null if no value can be assigned.

Parameters:

viewer -

adaptable -

Returns:

String

getNamedElementValue

protected java.lang.String getNamedElementValue(org.eclipse.jface.viewers.Viewer viewer,
                                                org.eclipse.hyades.ui.util.INamedElement namedElement)

Returns the value for an namedElement or null if no value can be assigned.

Parameters:

viewer -

namedElement -

Returns:

String