Package org.eclipse.ui.navigator
Interface INavigatorSorterService
-
public interface INavigatorSorterService
Provides an interface to extensions declared in org.eclipse.ui.navigator.navigatorContent/commonSorter.Like other extensions to the Common Navigator framework, sorters defined by the above extension point must be bound to the associated
INavigatorContentService
through a org.eclipse.ui.navigator.viewer/viewerContentBinding extension.- Since:
- 3.2
- See Also:
INavigatorContentService.getSorterService()
,ViewerSorter
- Restriction:
- This interface is not intended to be implemented by clients.
- Restriction:
- This interface is not intended to be extended by clients.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Map
findAvailableSorters(INavigatorContentDescriptor theSource)
Find and return all viewer sorters associated with the given descriptor.ViewerSorter
findSorter(INavigatorContentDescriptor source, Object parent, Object lvalue, Object rvalue)
Return aViewerSorter
from an extension which is visible to the associatedINavigatorContentService
and whose parentExpression matches the given parent.ViewerSorter
findSorterForParent(Object aParent)
Return aViewerSorter
from an extension which is visible to the associatedINavigatorContentService
and whose parentExpression matches the given parent.
-
-
-
Method Detail
-
findSorterForParent
ViewerSorter findSorterForParent(Object aParent)
Return aViewerSorter
from an extension which is visible to the associatedINavigatorContentService
and whose parentExpression matches the given parent.- Parameters:
aParent
- An element from the tree- Returns:
- An applicable ViewerSorter or simple
ViewerSorter
if no sorter is found.
-
findSorter
ViewerSorter findSorter(INavigatorContentDescriptor source, Object parent, Object lvalue, Object rvalue)
Return aViewerSorter
from an extension which is visible to the associatedINavigatorContentService
and whose parentExpression matches the given parent.- Parameters:
source
- The source of the element.parent
- An element from the treelvalue
- An element from the treervalue
- An element from the tree- Returns:
- An applicable ViewerSorter or simple
ViewerSorter
if no sorter is found.
-
findAvailableSorters
Map findAvailableSorters(INavigatorContentDescriptor theSource)
Find and return all viewer sorters associated with the given descriptor.The commonSorter element is not required to have an id, so in some cases, an auto-generated id, using the content extension id as a base, is generated to ensure the map is properly filled with all available sorters. No guarantees are given as to the order or consistency of these generated ids between invocations.
- Parameters:
theSource
- A descriptor that identifies a particular content extension- Returns:
- A Map[String sorterDescriptorId, ViewerSorter instance] where the key is the id defined in the extension and the value is the instantiated sorter.
- Since:
- 3.3
- See Also:
INavigatorContentService.getContentDescriptorById(String)
,INavigatorContentService.getContentExtensionById(String)
,INavigatorContentExtension.getDescriptor()
-
-