blob: 031bc146e18e62d5f5dc27629310170e2acd3bdd [file] [log] [blame]
/*******************************************************************************
* Copyright (c) 2005, 2006 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.ui.operations;
import org.eclipse.core.commands.ExecutionException;
import org.eclipse.core.commands.operations.IUndoContext;
import org.eclipse.core.commands.operations.IUndoableOperation;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.ui.ISharedImages;
import org.eclipse.ui.IWorkbenchPartSite;
import org.eclipse.ui.PlatformUI;
import org.eclipse.ui.internal.WorkbenchMessages;
/**
* <p>
* UndoActionHandler provides common behavior for performing an undo, as
* well as labelling and enabling the undo menu item. This class may be
* instantiated by clients.
* </p>
*
* @since 1.1
*/
public final class UndoActionHandler extends OperationHistoryActionHandler {
/**
* Construct an action handler that handles the labelling and enabling of
* the undo action for the specified undo context.
*
* @param site
* the workbench part site that created the action.
* @param context
* the undo context to be used for the undo
*/
public UndoActionHandler(IWorkbenchPartSite site, IUndoContext context) {
super(site, context);
setImageDescriptor(PlatformUI.getWorkbench().getSharedImages()
.getImageDescriptor(ISharedImages.IMG_TOOL_UNDO));
setDisabledImageDescriptor(PlatformUI.getWorkbench().getSharedImages()
.getImageDescriptor(ISharedImages.IMG_TOOL_UNDO_DISABLED));
}
void flush() {
getHistory().dispose(getUndoContext(), true, false, false);
}
String getCommandString() {
return WorkbenchMessages.get().Operations_undoCommand;
}
String getTooltipString() {
return WorkbenchMessages.get().Operations_undoTooltipCommand;
}
String getSimpleCommandString() {
return WorkbenchMessages.get().Workbench_undo;
}
String getSimpleTooltipString() {
return WorkbenchMessages.get().Workbench_undoToolTip;
}
IUndoableOperation getOperation() {
return getHistory().getUndoOperation(getUndoContext());
}
IStatus runCommand(IProgressMonitor pm) throws ExecutionException {
return getHistory().undo(getUndoContext(), pm, this);
}
boolean shouldBeEnabled() {
return getHistory().canUndo(getUndoContext());
}
}