| |
org.eclipse.ui.operations
Class OperationHistoryActionHandler
java.lang.Object
org.eclipse.core.commands.common.EventManager
org.eclipse.jface.action.AbstractAction
org.eclipse.jface.action.Action
org.eclipse.ui.operations.OperationHistoryActionHandler
-
All Implemented Interfaces:
-
IAdaptable,
IAction,
ActionFactory.IWorkbenchAction
-
Direct Known Subclasses:
-
RedoActionHandler,
UndoActionHandler
-
public abstract class OperationHistoryActionHandler
- extends
Action
- implements
ActionFactory.IWorkbenchAction,
IAdaptable
OperationHistoryActionHandler implements common behavior for the undo and
redo actions. It supports filtering of undo or redo on a particular undo
context. If an undo context is not specified, or there has been no history
available for the specified undo context, then the workbench undo context
will be used.
OperationHistoryActionHandler provides an adapter in the info parameter of
the IOperationHistory undo and redo methods that is used to get UI info for
prompting the user during operations or operation approval. Adapters are
provided for org.eclipse.ui.IWorkbenchWindow, org.eclipse.swt.widgets.Shell,
org.eclipse.ui.IWorkbenchPart, org.eclipse.core.commands.IUndoContext, and
org.eclipse.runtime.IProgressMonitor.
OperationHistoryActionHandler assumes a linear undo/redo model. When the
handler is run, the operation history is asked to perform the most recent
undo/redo for the handler's undo context. The handler can be configured
(using #setPruneHistory(true)) to flush the operation undo or redo history
for the handler's undo context when there is no valid operation on top of the
history. This avoids keeping a stale history of invalid operations. By
default, pruning does not occur and it is assumed that clients of the
particular undo context are pruning the history when necessary.
-
Since:
- 3.1
|
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
|
|
Method Summary
|
void
|
dispose
()
Disposes of this action. |
Object
|
getAdapter
(
Class adapter)
Returns an object which is an instance of the given class
associated with this object. |
void
|
run
()
The default implementation of this IAction method does
nothing. |
void
|
setContext
(
IUndoContext context)
Set the context shown by the handler. |
void
|
setPruneHistory
(boolean prune)
Specify whether the action handler should actively prune the operation
history when invalid operations are encountered. |
void
|
update
()
Update enabling and labels according to the current status of the
operation history. |
|
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,
runWithEvent,
setAccelerator,
setActionDefinitionId,
setChecked,
setDescription,
setDisabledImageDescriptor,
setEnabled,
setHelpListener,
setHoverImageDescriptor,
setId,
setImageDescriptor,
setMenuCreator,
setText,
setToolTipText
|
|
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,
runWithEvent,
setAccelerator,
setActionDefinitionId,
setChecked,
setDescription,
setDisabledImageDescriptor,
setEnabled,
setHelpListener,
setHoverImageDescriptor,
setId,
setImageDescriptor,
setMenuCreator,
setText,
setToolTipText
|
dispose
public void dispose()
-
Description copied from interface:
ActionFactory.IWorkbenchAction
- Disposes of this action. Once disposed, this action cannot be used.
This operation has no effect if the action has already been
disposed.
-
-
Specified by:
-
dispose
in interface
ActionFactory.IWorkbenchAction
-
run
public final void run()
-
Description copied from class:
Action
- The default implementation of this
IAction method does
nothing. Subclasses should override this method if they do not need
information from the triggering event, or override
runWithEvent(Event) if they do.
-
-
Specified by:
-
run
in interface
IAction
-
Overrides:
-
run
in class
Action
-
getAdapter
public
Object getAdapter(
Class adapter)
-
Description copied from interface:
IAdaptable
- Returns an object which is an instance of the given class
associated with this object. Returns
null if
no such object can be found.
-
-
Specified by:
-
getAdapter
in interface
IAdaptable
-
-
Parameters:
-
adapter - the adapter class to look up
-
Returns:
- a object castable to the given class,
or
null if this object does not
have an adapter for the given class
setContext
public void setContext(
IUndoContext context)
- Set the context shown by the handler. Normally the context is set up when
the action handler is created, but the context can also be changed
dynamically.
-
-
-
Parameters:
-
context - the context to be used for the undo history
setPruneHistory
public void setPruneHistory(boolean prune)
- Specify whether the action handler should actively prune the operation
history when invalid operations are encountered. The default value is
false.
-
-
-
Parameters:
-
prune - true if the history should be pruned by the
handler, and false if it should not.
update
public void update()
- Update enabling and labels according to the current status of the
operation history.
-
-
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.
|
|
