com.ibm.xtools.comparemerge.ui.actions

Class ContentPaneAction

java.lang.Object

org.eclipse.core.commands.common.EventManager

org.eclipse.jface.action.AbstractAction

org.eclipse.jface.action.Action

com.ibm.xtools.comparemerge.ui.actions.AbstractCompareMergeAction

com.ibm.xtools.comparemerge.ui.actions.ContentPaneAction

All Implemented Interfaces:

ICommandManagerChangeListener, IDisposableAction, IRepeatableAction, INavigationListener, java.util.EventListener, org.eclipse.jface.action.IAction, org.eclipse.jface.util.IPropertyChangeListener, org.eclipse.jface.viewers.ISelectionChangedListener

public abstract class ContentPaneAction
extends AbstractCompareMergeAction

Abstract parent action for content viewer panes hosting different contributor versions

Nested Class Summary

Nested classes/interfaces inherited from interface com.ibm.xtools.comparemerge.ui.actions.IRepeatableAction

IRepeatableAction.WorkIndicatorType

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.concurrent.atomic.AtomicBoolean	autoConfirm If enabled, the action will not prompt for confirmation

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
ContentPaneAction(IContentViewerPane contentViewerPane) Constructs a ContentPaneAction
ContentPaneAction(IContentViewerPane contentViewerPane, int navigationEvents) Constructs a ContentPaneAction

Method Summary

Modifier and Type	Method and Description
void	commandManagerChanged(CommandManagerChangeEvent event) Handles an event indicating that a command manager has changed.
protected IContentViewerPane	getContentViewerPane() Returns the contentViewerPane
protected IContentViewerInput	getCurrentInput() Returns the currentInput.
protected int	getCurrentNavigationEventType() Returns the currentNavigationEventType
protected int	getNavigationEvents() Returns the navigation events
boolean	isAutoConfirm()
void	navigationOccured(int eventType, INavigationProvider provider) Sent when navigation occurs in the difference viewer
void	setAutoConfirm(boolean status)

Methods inherited from class com.ibm.xtools.comparemerge.ui.actions.AbstractCompareMergeAction

dispose, doRun, getActionManager, getActiveShell, getCommandManager, getCompareMergeController, getLabel, getSelection, getSelectionProvider, getStructuredSelection, getWorkIndicatorType, handle, init, isBrowseEnabled, isBrowseListener, isCommandStackListener, isDisposed, isNavigationListener, isRepeatable, isRunnable, isSelectionListener, isSetup, needsSetup, openErrorDialog, propertyChange, refresh, repeat, run, run, runWithEvent, selectionChanged, setSetup, setup

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, isEnabled, 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.action.IAction

addPropertyChangeListener, getAccelerator, getActionDefinitionId, getDescription, getDisabledImageDescriptor, getHelpListener, getHoverImageDescriptor, getId, getImageDescriptor, getMenuCreator, getStyle, getText, getToolTipText, isChecked, isEnabled, isHandled, removePropertyChangeListener, setAccelerator, setActionDefinitionId, setChecked, setDescription, setDisabledImageDescriptor, setEnabled, setHelpListener, setHoverImageDescriptor, setId, setImageDescriptor, setMenuCreator, setText, setToolTipText

Field Detail

autoConfirm

protected java.util.concurrent.atomic.AtomicBoolean autoConfirm

If enabled, the action will not prompt for confirmation

Constructor Detail

ContentPaneAction

public ContentPaneAction(IContentViewerPane contentViewerPane)

Constructs a ContentPaneAction

Parameters:

contentViewerPane - the content viewer pane

ContentPaneAction

public ContentPaneAction(IContentViewerPane contentViewerPane,
                         int navigationEvents)

Constructs a ContentPaneAction

Parameters:

contentViewerPane - the content viewer pane

navigationEvents - the navigation events that the action is interested in

Method Detail

getContentViewerPane

protected final IContentViewerPane getContentViewerPane()

Returns the contentViewerPane

Returns:

the contentViewerPane.

getNavigationEvents

protected final int getNavigationEvents()

Returns the navigation events

Returns:

the navigationEvents.

navigationOccured

public final void navigationOccured(int eventType,
                                    INavigationProvider provider)

Description copied from interface: INavigationListener

Sent when navigation occurs in the difference viewer

Specified by:

navigationOccured in interface INavigationListener

Overrides:

navigationOccured in class AbstractCompareMergeAction

Parameters:

eventType - the kind of event that happened. Event type is a bit flag. Event types are defined in the NavigationEventType.

provider - the provider of the navigation functionality

See Also:

INavigationListener.navigationOccured(int, com.ibm.xtools.comparemerge.ui.provider.INavigationProvider)

commandManagerChanged

public final void commandManagerChanged(CommandManagerChangeEvent event)

Description copied from class: AbstractCompareMergeAction

Handles an event indicating that a command manager has changed.

Specified by:

commandManagerChanged in interface ICommandManagerChangeListener

Overrides:

commandManagerChanged in class AbstractCompareMergeAction

Parameters:

event - The command manager change event to be handled.

See Also:

ICommandManagerChangeListener.commandManagerChanged(com.ibm.xtools.comparemerge.core.command.CommandManagerChangeEvent)

getCurrentInput

protected final IContentViewerInput getCurrentInput()

Returns the currentInput.

Returns:

the currentInput.

getCurrentNavigationEventType

protected final int getCurrentNavigationEventType()

Returns the currentNavigationEventType

Returns:

the currentNavigationEventType.

setAutoConfirm

public void setAutoConfirm(boolean status)

isAutoConfirm

public boolean isAutoConfirm()