org.eclipse.sphinx.emf.compare.ui.actions

Class BasicCompareAction

java.lang.Object

org.eclipse.core.commands.common.EventManager

org.eclipse.jface.action.AbstractAction

org.eclipse.jface.action.Action

org.eclipse.ui.actions.BaseSelectionListenerAction

org.eclipse.sphinx.emf.compare.ui.actions.BasicCompareAction

All Implemented Interfaces:

org.eclipse.jface.action.IAction, org.eclipse.jface.viewers.ISelectionChangedListener

public class BasicCompareAction
extends org.eclipse.ui.actions.BaseSelectionListenerAction
implements org.eclipse.jface.viewers.ISelectionChangedListener

The basic compare action.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<java.lang.ref.WeakReference<org.eclipse.emf.ecore.EObject>>	selectedEObjects The selected objects that must be compared.
protected java.util.List<java.lang.ref.WeakReference<org.eclipse.core.resources.IFile>>	selectedFiles The selected files that must be compared.

Fields inherited from interface org.eclipse.jface.action.IAction

AS_CHECK_BOX, AS_DROP_DOWN_MENU, AS_PUSH_BUTTON, AS_RADIO_BUTTON, AS_UNSPECIFIED, CHECKED, DESCRIPTION, ENABLED, HANDLED, IMAGE, RESULT, TEXT, TOOL_TIP_TEXT

Constructor Summary

Constructors

Constructor and Description
BasicCompareAction() Constructor.

Method Summary

Modifier and Type	Method and Description
protected org.eclipse.compare.CompareEditorInput	createCompareEditorInput(org.eclipse.emf.common.notify.AdapterFactory adapterFactory, java.lang.Object left, java.lang.Object right, org.eclipse.emf.common.notify.Notifier origin)
protected org.eclipse.compare.CompareEditorInput	createCompareEditorInput(org.eclipse.emf.common.notify.AdapterFactory adapterFactory, java.lang.Object left, java.lang.Object right, org.eclipse.emf.common.notify.Notifier origin, org.eclipse.core.runtime.preferences.IEclipsePreferences enginePreferences)
protected org.eclipse.emf.common.notify.AdapterFactory	getAdapterFactory()
protected java.lang.String	getCompareEditorId(org.eclipse.compare.CompareEditorInput input) Returns the identifier of the compare editor to open.
protected org.eclipse.compare.CompareEditorInput	getCompareEditorInput(java.lang.Object leftObject, java.lang.Object rightObject)
protected org.eclipse.emf.compare.scope.IComparisonScope	getComparisonScope(java.lang.Object left, java.lang.Object right, java.lang.Object origin)
protected org.eclipse.emf.compare.ide.ui.internal.configuration.EMFCompareConfiguration	getEMFCompareConfiguration()
protected org.eclipse.emf.compare.match.IMatchEngine.Factory.Registry	getMatchEngineFactoryRegistry()
protected org.eclipse.emf.compare.postprocessor.IPostProcessor.Descriptor.Registry<?>	getPostProcessorRegistry()
protected org.eclipse.ui.IReusableEditor	getReusableEditor()
boolean	isEnabled()
protected void	openCompareEditor(org.eclipse.compare.CompareEditorInput input, org.eclipse.ui.IWorkbenchPage page, org.eclipse.ui.IReusableEditor editor) Performs the comparison described by the given input and opens a compare editor on the result.
void	run()
boolean	updateSelection(org.eclipse.jface.viewers.IStructuredSelection selection)

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

clearCache, getStructuredSelection, runWithEvent, selectionChanged, selectionChanged

Methods inherited from class org.eclipse.jface.action.Action

convertAccelerator, convertAccelerator, findKeyCode, findKeyString, findModifier, findModifierString, getAccelerator, getActionDefinitionId, getDescription, getDisabledImageDescriptor, getHelpListener, getHoverImageDescriptor, getId, getImageDescriptor, getMenuCreator, getStyle, getText, getToolTipText, isChecked, isHandled, notifyResult, removeAcceleratorText, removeMnemonics, setAccelerator, setActionDefinitionId, setChecked, setDescription, setDisabledImageDescriptor, setEnabled, setHelpListener, setHoverImageDescriptor, setId, setImageDescriptor, setMenuCreator, setText, setToolTipText

Methods inherited from class org.eclipse.jface.action.AbstractAction

addPropertyChangeListener, firePropertyChange, firePropertyChange, removePropertyChangeListener

Methods inherited from class org.eclipse.core.commands.common.EventManager

addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.jface.viewers.ISelectionChangedListener

selectionChanged

Field Detail

selectedEObjects

protected java.util.List<java.lang.ref.WeakReference<org.eclipse.emf.ecore.EObject>> selectedEObjects

The selected objects that must be compared.

selectedFiles

protected java.util.List<java.lang.ref.WeakReference<org.eclipse.core.resources.IFile>> selectedFiles

The selected files that must be compared.

Constructor Detail

BasicCompareAction

public BasicCompareAction()

Constructor.

Method Detail

updateSelection

public boolean updateSelection(org.eclipse.jface.viewers.IStructuredSelection selection)

Overrides:

updateSelection in class org.eclipse.ui.actions.BaseSelectionListenerAction

Parameters:

selection - The selection in the viewer onto which this action should perform an operation.

Returns:

• true if compare action is available (i.e. if selection matches enablement criteria);
• false otherwise.

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface org.eclipse.jface.action.IAction

Overrides:

isEnabled in class org.eclipse.jface.action.Action

run

public void run()

Specified by:

run in interface org.eclipse.jface.action.IAction

Overrides:

run in class org.eclipse.jface.action.Action

getAdapterFactory

protected org.eclipse.emf.common.notify.AdapterFactory getAdapterFactory()

getMatchEngineFactoryRegistry

protected org.eclipse.emf.compare.match.IMatchEngine.Factory.Registry getMatchEngineFactoryRegistry()

getPostProcessorRegistry

protected org.eclipse.emf.compare.postprocessor.IPostProcessor.Descriptor.Registry<?> getPostProcessorRegistry()

getCompareEditorInput

protected org.eclipse.compare.CompareEditorInput getCompareEditorInput(java.lang.Object leftObject,
                                                                       java.lang.Object rightObject)

createCompareEditorInput

protected org.eclipse.compare.CompareEditorInput createCompareEditorInput(org.eclipse.emf.common.notify.AdapterFactory adapterFactory,
                                                                          java.lang.Object left,
                                                                          java.lang.Object right,
                                                                          org.eclipse.emf.common.notify.Notifier origin)

createCompareEditorInput

protected org.eclipse.compare.CompareEditorInput createCompareEditorInput(org.eclipse.emf.common.notify.AdapterFactory adapterFactory,
                                                                          java.lang.Object left,
                                                                          java.lang.Object right,
                                                                          org.eclipse.emf.common.notify.Notifier origin,
                                                                          org.eclipse.core.runtime.preferences.IEclipsePreferences enginePreferences)

getEMFCompareConfiguration

protected org.eclipse.emf.compare.ide.ui.internal.configuration.EMFCompareConfiguration getEMFCompareConfiguration()

getComparisonScope

protected org.eclipse.emf.compare.scope.IComparisonScope getComparisonScope(java.lang.Object left,
                                                                            java.lang.Object right,
                                                                            java.lang.Object origin)

getReusableEditor

protected org.eclipse.ui.IReusableEditor getReusableEditor()

openCompareEditor

protected void openCompareEditor(org.eclipse.compare.CompareEditorInput input,
                                 org.eclipse.ui.IWorkbenchPage page,
                                 org.eclipse.ui.IReusableEditor editor)

Performs the comparison described by the given input and opens a compare editor on the result.

Parameters:

input - the input on which to open the compare editor

page - the workbench page on which to create a new compare editor

editor - if not null the input is opened in this editor

See Also:

CompareEditorInput

getCompareEditorId

protected java.lang.String getCompareEditorId(org.eclipse.compare.CompareEditorInput input)

Returns the identifier of the compare editor to open.

Inheriting clients may override this method in order to specify the identifier of another compare editor (e.g. according to the type of the specified input).

Parameters:

input - The editor input for which a compare editor is supposed to be opened.

Returns:

The identifier of the compare editor to open.