Eclipse Plug-in Developer Guide (Galileo) - RefactoringSynchronizationActionProvider (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.ltk.ui.refactoring.model
Class RefactoringSynchronizationActionProvider


java.lang.Object
  

org.eclipse.ui.actions.ActionGroup
      

org.eclipse.ui.navigator.CommonActionProvider
          

org.eclipse.team.ui.mapping.SynchronizationActionProvider
              
org.eclipse.ltk.ui.refactoring.model.RefactoringSynchronizationActionProvider

All Implemented Interfaces:: IMementoAware

public class RefactoringSynchronizationActionProvider
extends SynchronizationActionProvider
extends SynchronizationActionProvider

Refactoring-aware synchronization action provider which contributes an action to accept pending refactorings during team synchronization.

This action provider contributes an action for refactoring history objects. Additionally, existing command handlers for the Merge, Mark As Merged and Overwrite actions are wrapped and automatically disabled for refactoring history objects.

Note: this class is intended to be extended by clients who need refactoring support in a team synchronization viewer. It needs to be be registered with the org.eclipse.ui.navigator.navigatorContent or org.eclipse.ui.navigator.viewer extension points in order to participate in the team synchronization viewers.

Since:: 3.2
See Also:: SynchronizationActionProvider

Field Summary

Fields inherited from class org.eclipse.team.ui.mapping. SynchronizationActionProvider

MARK_AS_MERGE_ACTION_ID, MERGE_ACTION_ID, OVERWRITE_ACTION_ID

Constructor Summary

RefactoringSynchronizationActionProvider ()


Method Summary

void fillContextMenu ( IMenuManager menu)
          Adds the applicable actions to a context menu, based on the state of the ActionContext.

protected void initialize ()
          Method called during action provider initialization.

protected void initializeOpenActions ()
          Method called from SynchronizationActionProvider.initialize() to initialize the Open/Open With actions.

Methods inherited from class org.eclipse.team.ui.mapping. SynchronizationActionProvider

dispose, fillActionBars, getExtensionSite, getExtensionStateModel, getSynchronizationContext, getSynchronizePageConfiguration, init, registerHandler, setContext, updateActionBars

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

filterAction, getActionSite, restoreState, saveState

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

getContext

Methods inherited from class java.lang. Object

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

Constructor Detail

RefactoringSynchronizationActionProvider

public RefactoringSynchronizationActionProvider()

Method Detail

fillContextMenu

public void fillContextMenu(
IMenuManager menu)

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 SynchronizationActionProvider

Parameters:: menu - the context menu manager

initialize

protected void initialize()

Method called during action provider initialization. It is invoked from the SynchronizationActionProvider.init(ICommonActionExtensionSite) 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.

Overrides:: initialize in class SynchronizationActionProvider

See Also:: SynchronizationActionProvider.registerHandler(String, IHandler), MergeActionHandler

initializeOpenActions

protected void initializeOpenActions()

Method called from SynchronizationActionProvider.initialize() to initialize the Open/Open With actions. This method will add an Open item and Open With menu for single selections that adapt to IResource. Subclasses may override. They may still call this method, in which case they only need to handle providing open for non-files. Otherwise, if they do not call this method, they must provide all non-compare related open items.