Gute Benutzerschnittstellen zeichnen sich dadurch aus, dass dem Benutzer Fehler unterlaufen dürfen. Die Änderungen müssen jedoch wieder zurückgenommen werden können. Um dies in Java zu realisieren, gibt es Unterstützung durch ein Paket javax.swing.undo. Mit ihm lassen sich Undo- und Redo-Operationen mit relativ wenig Aufwand realisieren. Unser Beispiel soll ein Textfeld zeigen, dessen Änderungen auf Knopfdruck rückgängig gemacht werden. Zentrales Objekt ist dabei ein UndoManager. Dieser sammelt einzelne Aktionen, im Fall von Benutzereingaben jedes Zeichen. Die Anzahl der zu speichernden Aktionen ist beschränkt, lässt sich aber anpassen. Wir wollen in einem Beispiel ein JTextField mit einem Standardtext erzeugen. Anschließend wird ein UndoManager mit dem Document-Objekt des Textfeldes verbunden. Das Document informiert den UndoManager über Änderungen, der UndoManager speichert diese. Wenn eine Schaltfläche aktiviert ist, wird dem UndoManager befohlen, die Aktion rückgängig zu machen. Sichtbar wird dann wieder der Text, so wie er am Anfang in der Textbox stand:
package com.tutego.insel.ui.undo;
import java.awt.BorderLayout;
import java.awt.event.*;
import javax.swing.*;
import javax.swing.event.UndoableEditEvent;
import javax.swing.undo.*;
public class IComeUndone {
public static void main( String[] args ) {
JFrame f = new JFrame();
f.setDefaultCloseOperation( JFrame.EXIT_ON_CLOSE );
final JTextArea textarea = new JTextArea( 20, 40 );
textarea.setText( "Hier zurück" );
f.add( new JScrollPane(textarea) );
// final UndoManager undomanager = new MyUndoManager();
final UndoManager undomanager = new UndoManager();
textarea.getDocument().addUndoableEditListener( undomanager );
undomanager.setLimit( 1000 );
JButton undoB = new JButton( "Undo" );
undoB.addActionListener( new ActionListener() {
@Override public void actionPerformed( ActionEvent e ) {
undomanager.end();
if ( undomanager.canUndo() )
undomanager.undo();
textarea.requestFocus();
}
} );
f.add( undoB, BorderLayout.PAGE_END );
f.pack();
f.setVisible( true );
}
}
Um genauer zu sehen, was das UndoManager-Objekt rückgängig macht, schreiben wir eine Unterklasse von UndoManager und überschreiben die Methode undoableEditHappened(UndoableEdit-Event) (diese Methode implementiert UndoManager von der Schnittstelle UndoableEditListener). Geben wir in unserer Realisierung auf dem Bildschirm aus, was bei jeder Aktion in den UndoManager kommt:
class MyUndoManager extends UndoManager {
@Override
public void undoableEditHappened( UndoableEditEvent e ) {
UndoableEdit ue = e.getEdit();
System.out.println( ue );
addEdit( ue );
}
}
Die Methode undoableEditHappened(UndoableEditEvent) bekommt ein Ereignisobjekt, in dem der Verweis auf eine zurücknehmbare Operation abgelegt ist. An diese kommen wir mit get-Edit(). Die Rückgabe ist ein UndoableEdit-Objekt, also genau eine Operation, die zu einem Undo und Redo fähig ist. Der UndoManager speichert diese mit dem Aufruf von addEdit() in einer Datenstruktur ab. Wenn wir das UndoableEdit-Objekt auf dem Bildschirm ausgeben, sehen wir unsere durchgeführte Operation, zum Beispiel bei einem Einfügen:
[javax.swing.text.GapContent$InsertUndo@497934 hasBeenDone: true alive: true]
Beim Löschen erkennen wir ein:
[javax.swing.text.GapContent$RemoveUndo@ca470 hasBeenDone: true alive: true]