IUndoManager

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> eclipse >> ltk >> core >> [ refactoring overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of org.eclipse.ltk.core.refactoring.IUndoManager

SOURCE |

Download org.eclipse.ltk.core.refactoring.IUndoManager

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.ltk.core.refactoring
Interface IUndoManager

public interface IUndoManager

An undo manager keeps track of performed changes. Use the method addUndo to add change objects to the undo stack and performUndo and performRedo to undo or redo changes.

This interface is not intended to be implemented by clients. Clients should use the method RefactoringCore.getUndoManager() 55 to access the refactoring undo manager.

Since:: 3.0

Method Summary

void aboutToPerformChange(Change change)
          The infrastructure is going to perform the given change.

void addListener(IUndoManagerListener listener)
          Adds a listener to the undo manager.

void addUndo(java.lang.String name, Change change)
          Adds a new undo change to this undo manager.

boolean anythingToRedo()
          Returns true if there is anything to redo, otherwise false.

boolean anythingToUndo()
          Returns true if there is anything to undo, otherwise false.

void changePerformed(Change change)
          The infrastructure has performed the given change.

void flush()
          Flushes the undo manager's undo and redo stacks.

java.lang.String peekRedoName()
          Returns the name of the top most redo.

java.lang.String peekUndoName()
          Returns the name of the top most undo.

void performRedo(IValidationCheckResultQuery query, org.eclipse.core.runtime.IProgressMonitor pm)
          Redo the top most redo change.

void performUndo(IValidationCheckResultQuery query, org.eclipse.core.runtime.IProgressMonitor pm)
          Undo the top most undo change.

void removeListener(IUndoManagerListener listener)
          Removes the given listener from this undo manager.

void shutdown()
          Shut down the undo manager.

Method Detail

addListener

public void addListener(IUndoManagerListener listener)

Adds a listener to the undo manager. Does nothing if the listener is already present.

removeListener

public void removeListener(IUndoManagerListener listener)

Removes the given listener from this undo manager. Does nothing if the listener isn't registered with this undo manager

aboutToPerformChange

public void aboutToPerformChange(Change change)

The infrastructure is going to perform the given change.

changePerformed

public void changePerformed(Change change)

The infrastructure has performed the given change.

addUndo

public void addUndo(java.lang.String name,
                    Change change)

Adds a new undo change to this undo manager.

anythingToUndo

public boolean anythingToUndo()

Returns true if there is anything to undo, otherwise false.

peekUndoName

public java.lang.String peekUndoName()

Returns the name of the top most undo.

performUndo

public void performUndo(IValidationCheckResultQuery query,
                        org.eclipse.core.runtime.IProgressMonitor pm)
                 throws org.eclipse.core.runtime.CoreException

Undo the top most undo change.

anythingToRedo

public boolean anythingToRedo()

Returns true if there is anything to redo, otherwise false.

peekRedoName

public java.lang.String peekRedoName()

Returns the name of the top most redo.

performRedo

public void performRedo(IValidationCheckResultQuery query,
                        org.eclipse.core.runtime.IProgressMonitor pm)
                 throws org.eclipse.core.runtime.CoreException

Redo the top most redo change.

flush

public void flush()

Flushes the undo manager's undo and redo stacks.

shutdown

public void shutdown()

Shut down the undo manager.