Package org.eclipse.jface.text
Class TextViewerUndoManager
java.lang.Object
org.eclipse.jface.text.TextViewerUndoManager
- All Implemented Interfaces:
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:
- Restriction:
- This class is not intended to be subclassed by clients.
-
Constructor Summary
ConstructorDescriptionTextViewerUndoManager
(int undoLevel) Creates a new undo manager who remembers the specified number of edit commands. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Signals the undo manager that all subsequent changes untilendCompoundChange
is called are to be undone in one piece.void
connect
(ITextViewer textViewer) Connects this undo manager to the given text viewer.void
Disconnects this undo manager from its text viewer.void
Signals the undo manager that the sequence of changes which started withbeginCompoundChange
has been finished.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.
-
Constructor Details
-
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 Details
-
beginCompoundChange
public void beginCompoundChange()Description copied from interface:IUndoManager
Signals the undo manager that all subsequent changes untilendCompoundChange
is called are to be undone in one piece.- Specified by:
beginCompoundChange
in interfaceIUndoManager
-
endCompoundChange
public void endCompoundChange()Description copied from interface:IUndoManager
Signals the undo manager that the sequence of changes which started withbeginCompoundChange
has been finished. All subsequent changes are considered to be individually undo-able.- Specified by:
endCompoundChange
in interfaceIUndoManager
-
setMaximalUndoLevel
public void setMaximalUndoLevel(int undoLevel) Description copied from interface:IUndoManager
The given parameter determines the maximal length of the history remembered by the undo manager.- Specified by:
setMaximalUndoLevel
in interfaceIUndoManager
- Parameters:
undoLevel
- the length of this undo manager's history
-
connect
Description copied from interface:IUndoManager
Connects this undo manager to the given text viewer.- Specified by:
connect
in interfaceIUndoManager
- Parameters:
textViewer
- the viewer the undo manager is connected to
-
disconnect
public void disconnect()Description copied from interface:IUndoManager
Disconnects this undo manager from its text viewer. If this undo manager hasn't been connected before this operation has no effect.- Specified by:
disconnect
in interfaceIUndoManager
-
reset
public void reset()Description copied from interface:IUndoManager
Resets the history of the undo manager. After that call, there aren't any undo-able or redo-able text changes.- Specified by:
reset
in interfaceIUndoManager
-
redoable
public boolean redoable()Description copied from interface:IUndoManager
Returns whether at least one text change can be repeated. A text change can be repeated only if it was executed and rolled back.- Specified by:
redoable
in interfaceIUndoManager
- Returns:
true
if at least on text change can be repeated
-
undoable
public boolean undoable()Description copied from interface:IUndoManager
Returns whether at least one text change can be rolled back.- Specified by:
undoable
in interfaceIUndoManager
- Returns:
true
if at least one text change can be rolled back
-
redo
public void redo()Description copied from interface:IUndoManager
Repeats the most recently rolled back text change.- Specified by:
redo
in interfaceIUndoManager
-
undo
public void undo()Description copied from interface:IUndoManager
Rolls back the most recently executed text change.- Specified by:
undo
in interfaceIUndoManager
-
getUndoContext
Description copied from interface:IUndoManagerExtension
Returns this undo manager's undo context.- Specified by:
getUndoContext
in interfaceIUndoManagerExtension
- Returns:
- the undo context or
null
if the undo manager is not connected - See Also:
-