|
Eclipse Platform Release 3.2 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.eclipse.core.commands.common.EventManager
org.eclipse.jface.action.AbstractAction
org.eclipse.jface.action.Action
org.eclipse.ui.operations.OperationHistoryActionHandler
public abstract class OperationHistoryActionHandler
OperationHistoryActionHandler implements common behavior for the undo and redo actions. It supports filtering of undo or redo on a particular undo context. (A null undo context will cause undo and redo to be disabled.)
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.
| Field Summary |
|---|
| 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.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, runWithEvent, setAccelerator, setActionDefinitionId, setChecked, setDescription, setDisabledImageDescriptor, setEnabled, setHelpListener, setHoverImageDescriptor, setId, setImageDescriptor, setMenuCreator, setText, setToolTipText |
| Method Detail |
|---|
public void dispose()
ActionFactory.IWorkbenchAction
dispose in interface ActionFactory.IWorkbenchActionpublic final void run()
ActionIAction 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.
run in interface IActionrun in class Actionpublic Object getAdapter(Class adapter)
IAdaptablenull if
no such object can be found.
getAdapter in interface IAdaptableadapter - the adapter class to look up
null if this object does not
have an adapter for the given classpublic void setContext(IUndoContext context)
context - the context to be used for the undo historypublic void setPruneHistory(boolean prune)
false.
prune - true if the history should be pruned by the
handler, and false if it should not.public void update()
|
Eclipse Platform Release 3.2 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2006. All rights reserved.