org.eclipse.team.ui.mapping
Class SynchronizationActionProvider

java.lang.Object
  org.eclipse.ui.actions.ActionGroup
      org.eclipse.ui.navigator.CommonActionProvider
          org.eclipse.team.ui.mapping.SynchronizationActionProvider

All Implemented Interfaces:

IMementoAware

public class SynchronizationActionProvider

extends CommonActionProvider

An action group that can be used by models to contribute actions to a team synchronization viewer. Subclases should override the initialize() method in order to register handlers for the following merge actions if they want cutom merge behavior:

• MERGE_ACTION_ID
• OVERWRITE_ACTION_ID
• OVERWRITE_ACTION_ID

They may also add other actions to the context menu or register action handlers in the fillActionBars(IActionBars) method.

This class may be subclasses by clients

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/Team team.

Since:

3.2

See Also:

MergeActionHandler

Field Summary

static String	MARK_AS_MERGE_ACTION_ID Action id constant for the mark-as-merge action.
static String	MERGE_ACTION_ID Action id constant for the merge action.
static String	OVERWRITE_ACTION_ID Action id constant for the merge action.

Constructor Summary

SynchronizationActionProvider()

Method Summary

void	dispose() This method is called by the user of an action group to signal that the group is no longer needed.
void	fillActionBars(IActionBars actionBars) Adds the applicable actions to a part's action bars, including setting any global action handlers.
void	fillContextMenu(IMenuManager menu) Adds the applicable actions to a context menu, based on the state of the ActionContext.
CommonActionProviderConfig	getCommonConfiguration() Return the configuration for the common viewer.
protected IExtensionStateModel	getExtensionStateModel() Return the extension state model for the content provider associated with action provider.
protected ISynchronizationContext	getSynchronizationContext() Return the synchronization context to which the actions of this provider apply.
protected ISynchronizePageConfiguration	getSynchronizePageConfiguration() Return the configuration from the synchronize page that contains the common viewer.
void	init(CommonActionProviderConfig aConfig) Initialize the current ICommonActionProvider with the supplied information.
protected void	initialize() Method called during action provider initialization.
protected void	registerHandler(String actionId, IHandler handler) Register the handler as the handler for the given action id when a merge action is performed on elements that match this groups enablement.

Methods inherited from class org.eclipse.ui.navigator.CommonActionProvider

restoreState, saveState

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

getContext, setContext, updateActionBars

Methods inherited from class java.lang.Object

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

Field Detail

MERGE_ACTION_ID

public static final String MERGE_ACTION_ID

Action id constant for the merge action.

See Also:

registerHandler(String, IHandler), Constant Field Values

OVERWRITE_ACTION_ID

public static final String OVERWRITE_ACTION_ID

Action id constant for the merge action.

See Also:

registerHandler(String, IHandler), Constant Field Values

MARK_AS_MERGE_ACTION_ID

public static final String MARK_AS_MERGE_ACTION_ID

Action id constant for the mark-as-merge action.

See Also:

registerHandler(String, IHandler), Constant Field Values

Constructor Detail

SynchronizationActionProvider

public SynchronizationActionProvider()

Method Detail

init

public final void init(CommonActionProviderConfig aConfig)

Description copied from class: CommonActionProvider

Initialize the current ICommonActionProvider with the supplied information.

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

Specified by:

init in class CommonActionProvider

Parameters:

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

initialize

protected void initialize()

Method called during action provider initialization. It is invoked from the init(CommonActionProviderConfig) after after the configuration has been recorded. Subclasses may override. Subclasses that want to provide there own merge actions handlers can register them in this method.

See Also:

registerHandler(String, IHandler), MergeActionHandler

getCommonConfiguration

public final CommonActionProviderConfig getCommonConfiguration()

Return the configuration for the common viewer.

Returns:

the configuration from the common viewer

getSynchronizePageConfiguration

protected final ISynchronizePageConfiguration getSynchronizePageConfiguration()

Return the configuration from the synchronize page that contains the common viewer.

Returns:

the configuration from the synchronize page that contains the common viewer

getExtensionStateModel

protected final IExtensionStateModel getExtensionStateModel()

Return the extension state model for the content provider associated with action provider.

Returns:

the extension state model for the content provider associated with action provider

getSynchronizationContext

protected final ISynchronizationContext getSynchronizationContext()

Return the synchronization context to which the actions of this provider apply.

Returns:

the synchronization context to which the actions of this provider apply

registerHandler

protected void registerHandler(String actionId,
                               IHandler handler)

Register the handler as the handler for the given action id when a merge action is performed on elements that match this groups enablement.

Parameters:

actionId - the id of the merge action

handler - the handler for elements of the model that provided this group

fillContextMenu

public void fillContextMenu(IMenuManager menu)

Description copied from class: ActionGroup

Adds the applicable actions to a context menu, based on the state of the ActionContext.

The default implementation does nothing. Subclasses may override or extend this method.

Overrides:

fillContextMenu in class ActionGroup

Parameters:

menu - the context menu manager

fillActionBars

public void fillActionBars(IActionBars actionBars)

Description copied from class: ActionGroup

Adds the applicable actions to a part's action bars, including setting any global action handlers.

The default implementation does nothing. Subclasses may override or extend this method.

Overrides:

fillActionBars in class ActionGroup

Parameters:

actionBars - the part's action bars

dispose

public void dispose()

Description copied from class: ActionGroup

This method is called by the user of an action group to signal that the group is no longer needed. Subclasses typically implement this method to deregister any listeners or to free other resources.

The default implementation calls setContext(null). Subclasses may extend this method.

Overrides:

dispose in class ActionGroup