org.eclipse.ui.navigator
Class CommonActionProvider

java.lang.Object
  org.eclipse.ui.actions.ActionGroup
      org.eclipse.ui.navigator.CommonActionProvider

All Implemented Interfaces:

IMementoAware

Direct Known Subclasses:

SynchronizationActionProvider

public abstract class CommonActionProvider

extends ActionGroup

implements IMementoAware

Provides actions from extensions for menu and IActionBars contributions.

This abstract class should be subclassed by clients of the org.eclipse.ui.navigator.navigatorContent extension point for top-level and nested <actionProvider > elements.

CommonActionProviders are declared via the org.eclipse.ui.navigator.navigatorContent extension point. CommonActionProviders may be declared as top-level elements in the extension point (e.g. an <actionProvider /> element at the root of the extension point). Alternatively, <actionProvider /> elements may be nested under a <navigatorContent /> element, in which case they are considered to be "associated" with that content extension. For more information, see the org.eclipse.ui.navigator.navigatorContent extension point.

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.

Clients may subclass this class.

Since:

3.2

Constructor Summary

CommonActionProvider()

Method Summary

abstract void	init(CommonActionProviderConfig aConfig) Initialize the current ICommonActionProvider with the supplied information.
void	restoreState(IMemento aMemento) Restore the previous state of any actions using the flags in aMemento.
void	saveState(IMemento aMemento) Save flags in aMemento to remember the state of any actions that persist from session to session.

Methods inherited from class org.eclipse.ui.actions.ActionGroup

dispose, fillActionBars, fillContextMenu, getContext, setContext, updateActionBars

Methods inherited from class java.lang.Object

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

Constructor Detail

CommonActionProvider

public CommonActionProvider()

Method Detail

init

public abstract void init(CommonActionProviderConfig aConfig)

Initialize the current ICommonActionProvider with the supplied information.

init() is guaranteed to be called before any other method of the ActionGroup super class.

Parameters:

aConfig - The configuration information for the instantiated Common Action Provider.

restoreState

public void restoreState(IMemento aMemento)

Restore the previous state of any actions using the flags in aMemento. This method allows the state of any actions that persist from session to session to be restored.

The default behavior is to do nothing.

Specified by:

restoreState in interface IMementoAware

Parameters:

aMemento - A memento that was given to the view part to restore its state.

saveState

public void saveState(IMemento aMemento)

Save flags in aMemento to remember the state of any actions that persist from session to session.

Extensions should qualify any keys stored in the memento with their plugin id

The default behavior is to do nothing.

Specified by:

saveState in interface IMementoAware

Parameters:

aMemento - A memento that was given to the view part to save its state.