Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 


Eclipse Platform
Release 3.5

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
  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 a ViewerSorter from an extension which is visible to the associated INavigatorContentService and whose parentExpression matches the given parent.
  ViewerSorter findSorterForParent ( Object aParent)
          Return a ViewerSorter from an extension which is visible to the associated INavigatorContentService and whose parentExpression matches the given parent.
 

Method Detail

findSorterForParent

ViewerSorter findSorterForParent(
Object aParent)
Return a ViewerSorter from an extension which is visible to the associated INavigatorContentService 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 a ViewerSorter from an extension which is visible to the associated INavigatorContentService and whose parentExpression matches the given parent.

Parameters:
source - The source of the element.
parent - An element from the tree
lvalue - An element from the tree
rvalue - 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()

Eclipse Platform
Release 3.5

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.


 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire