Eclipse Plug-in Developer Guide (Galileo) - NavigatorContentServiceFactory (Eclipse Platform API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.ui.navigator
Class NavigatorContentServiceFactory


java.lang.Object
  
org.eclipse.ui.navigator.NavigatorContentServiceFactory

public final class NavigatorContentServiceFactory
extends Object
extends Object

Provides a factory pattern for creating INavigatorContentServices for given viewer ids.

Clients may supply the viewer in createContentService(String, StructuredViewer) or wait until the content provider is created by the service and set on the viewer. When the content provider is set, the viewer will call inputChanged(), and the content service will update its managed viewer accordingly. Therefore, each content service should be attached to at most one viewer.

Since:: 3.2

Field Summary

static NavigatorContentServiceFactory INSTANCE
          The singleton instance for creating NavigatorContentServices.

Constructor Summary

NavigatorContentServiceFactory ()


Method Summary

INavigatorContentService createContentService ( String aViewerId)
          Returns an instance of INavigatorContentService configured for the given id.

INavigatorContentService createContentService ( String aViewerId, StructuredViewer aViewer)
          Returns an instance of INavigatorContentService configured for the given id.

Methods inherited from class java.lang. Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INSTANCE

public static final 
NavigatorContentServiceFactory INSTANCE

The singleton instance for creating NavigatorContentServices.

Constructor Detail

NavigatorContentServiceFactory

public NavigatorContentServiceFactory()

Method Detail

createContentService

public 
INavigatorContentService createContentService(
String aViewerId)

Returns an instance of INavigatorContentService configured for the given id. Instances are not shared for the same viewerId.

Parameters:: aViewerId - The viewer id of interest
Returns:: An instance of INavigatorContentService configured for the given id.

createContentService

public 
INavigatorContentService createContentService(
String aViewerId,
                                                     
StructuredViewer aViewer)

Returns an instance of INavigatorContentService configured for the given id. Instances are not shared for the same viewerId.

Parameters:: aViewerId - The viewer id of interest; aViewer - The content service can use the given viewer to initialize content providers
Returns:: An instance of INavigatorContentService configured for the given id.
See Also:: IContentProvider.inputChanged(org.eclipse.jface.viewers.Viewer, Object, Object)