Start of Tutorial > Start of Trail > Start of Lesson | Search |
Undoable edit events occur when an operation that can be undone occurs on a component. Currently, only text components fire undoable edit events, and then only indirectly. The text component's document fires the events. For text components, undoable operations include inserting characters, deleting characters, and modifying the style of text. Programs typically listen to undoable edit events to assist in the implementation of undo and redo commands.Here is the undoable edit event handling code from an application called
TextComponentDemo
.You can find the full source code for the program and instructions for compiling and running it in General Rules for Using Text Components. For a discussion about the undoable edit listener aspect of the program see Implementing Undo and Redo... //where initialization occurs document.addUndoableEditListener(new MyUndoableEditListener()); ... protected class MyUndoableEditListener implements UndoableEditListener { public void undoableEditHappened(UndoableEditEvent e) { //Remember the edit and update the menus undo.addEdit(e.getEdit()); undoAction.updateUndoState(); redoAction.updateRedoState(); } }
TheUndoableEditListener
interface has just one method, so it has no corresponding adapter class. Here's the method:The
void undoableEditHappened(UndoableEditEvent)
- Called when an undoable event occurs on the listened-to component.
undoableEditHappened
method has a single parameter: aUndoableEditEvent
object. To get the document that fired the event, use thegetSource
method whichUndoableEditEvent
inherits fromEventObject
.The
UndoableEditEvent
class defines one method which returns an object that contains detailed information about the edit that occurred.
UndoableEdit getEdit()
- Returns an
UndoableEdit
object that represents the edit that occurred and contains information about and commands for undoing or redoing the edit.
The following table lists the examples that use undoable edit listeners.
Example Where Described Notes TextComponentDemo
Implementing Undo and Redo Implements undo and redo on a text pane with help from an undoable edit listener.
Start of Tutorial > Start of Trail > Start of Lesson | Search |