Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 


Eclipse Platform
Release 3.5

org.eclipse.team.ui.mapping
Class SynchronizationActionProvider

java.lang.Object
  extended by 

org.eclipse.ui.actions.ActionGroup
      extended by 

org.eclipse.ui.navigator.CommonActionProvider
          extended by 
org.eclipse.team.ui.mapping.SynchronizationActionProvider
All Implemented Interfaces:
IMementoAware
Direct Known Subclasses:
RefactoringSynchronizationActionProvider

public class SynchronizationActionProvider
extends CommonActionProvider

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

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.

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.
  ICommonActionExtensionSite getExtensionSite ()
          Return the extension site for this action provider.
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 ( ICommonActionExtensionSite site)
           Initialize the current ICommonActionProvider with the supplied information.
protected  void initialize ()
          Method called during action provider initialization.
protected  void initializeOpenActions ()
          Method called from initialize() to initialize the Open/Open With actions.
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.
 void setContext ( ActionContext context)
          Sets the context used to determine which actions are added, and what their enabled state should be.
 void updateActionBars ()
          Updates the state of the actions added to the action bars, including any global action handlers, based on the state of the ActionContext.
 
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
 

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 void init(
ICommonActionExtensionSite site)
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.

Overrides:
init in class CommonActionProvider
Parameters:
site - 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(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.

See Also:
registerHandler(String, IHandler), MergeActionHandler

initializeOpenActions

protected void initializeOpenActions()
Method called from 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.


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

updateActionBars

public void updateActionBars()
Description copied from class: ActionGroup
Updates the state of the actions added to the action bars, including any global action handlers, based on the state of the ActionContext.

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

Overrides:
updateActionBars in class ActionGroup

setContext

public void setContext(
ActionContext context)
Description copied from class: ActionGroup
Sets the context used to determine which actions are added, and what their enabled state should be.

Overrides:
setContext in class ActionGroup
Parameters:
context - the context to use

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

getExtensionSite

public 
ICommonActionExtensionSite getExtensionSite()
Return the extension site for this action provider. This method just calls CommonActionProvider.getActionSite().

Returns:
the extension site for this action provider

Eclipse Platform
Release 3.5

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.


 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire