Eclipse Platform
Release 3.2

org.eclipse.ui.navigator
Interface ICommonExtensionSite


public interface ICommonExtensionSite

Provides configuration for a specific extension. Supplied in the init() methods of various interfaces allowed by the framework.

EXPERIMENTAL. This class or interface has been added as part of a work in progress. There is a guarantee neither that this API will work nor that it will remain the same. Please do not use this API without consulting with the Platform/UI team.

This interface is not intended to be implemented by clients.

Since:
3.2
See Also:
ICommonLabelProvider, ICommonContentProvider

Method Summary
 INavigatorContentExtension getExtension()
           
 IExtensionStateModel getExtensionStateModel()
          The extension state model allows an extension to isolate all of the dynamic state information that affects how it presents content or displays actions.
 IMemento getMemento()
          Advanced extensions may expose user-customizeable properties that affect the structure or behavior of the extension.
 

Method Detail

getExtensionStateModel

public IExtensionStateModel getExtensionStateModel()
The extension state model allows an extension to isolate all of the dynamic state information that affects how it presents content or displays actions. Clients may use this state model to drive values from actions that will cause label or content providers to change their behavior.

Returns:
The state model associated with this logical extension.

getMemento

public IMemento getMemento()
Advanced extensions may expose user-customizeable properties that affect the structure or behavior of the extension. Clients may use the given memento to restore or persist these settings between sessions.

Returns:
A memento which can be used to restore or persist settings between workbench sessions.

getExtension

public INavigatorContentExtension getExtension()
Returns:
The extension instance. Clients may use their extension instance to get access to other components defined by the logical extension.

Eclipse Platform
Release 3.2

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.