Eclipse Plug-in Developer Guide (Galileo) - TextViewerUndoManager (Eclipse Platform API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.jface.text
Class TextViewerUndoManager


java.lang.Object
  
org.eclipse.jface.text.TextViewerUndoManager

All Implemented Interfaces:: IUndoManager, IUndoManagerExtension

public class TextViewerUndoManager
extends Object
implements IUndoManager, IUndoManagerExtension
extends Object
implements IUndoManager, IUndoManagerExtension

Implementation of IUndoManager using the shared document undo manager.

It registers with the connected text viewer as text input listener, and obtains its undo manager from the current document. It also monitors mouse and keyboard activities in order to partition the stream of text changes into undo-able edit commands.

This class is not intended to be subclassed.

Since:: 3.2
See Also:: ITextViewer, ITextInputListener, IDocumentUndoManager, MouseListener, KeyListener, DocumentUndoManager
Restriction:: This class is not intended to be subclassed by clients.

Constructor Summary

TextViewerUndoManager (int undoLevel)
          Creates a new undo manager who remembers the specified number of edit commands.

Method Summary

void beginCompoundChange ()
          Signals the undo manager that all subsequent changes until endCompoundChange is called are to be undone in one piece.

void connect ( ITextViewer textViewer)
          Connects this undo manager to the given text viewer.

void disconnect ()
          Disconnects this undo manager from its text viewer.

void endCompoundChange ()
          Signals the undo manager that the sequence of changes which started with beginCompoundChange has been finished.

IUndoContext getUndoContext ()
          Returns this undo manager's undo context.

void redo ()
          Repeats the most recently rolled back text change.

boolean redoable ()
          Returns whether at least one text change can be repeated.

void reset ()
          Resets the history of the undo manager.

void setMaximalUndoLevel (int undoLevel)
          The given parameter determines the maximal length of the history remembered by the undo manager.

void undo ()
          Rolls back the most recently executed text change.

boolean undoable ()
          Returns whether at least one text change can be rolled back.

Methods inherited from class java.lang. Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TextViewerUndoManager

public TextViewerUndoManager(int undoLevel)

Creates a new undo manager who remembers the specified number of edit commands.

Parameters:: undoLevel - the length of this manager's history

Method Detail