15.32 Undo durchführen

Gute Benutzerschnittstellen zeichnen sich dadurch aus, dass der Benutzer Fehler machen darf. Die Änderungen müssen jedoch wieder zurückgenommen werden können. Um das 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.

Listing 15.45 IComeUndone.java

import java.awt.*;
import java.awt.event.*;
import javax.swing.*;
import javax.swing.event.*;
import javax.swing.undo.*;
public class IComeUndone
{
  public static void main( String args[] )
  {
    JFrame f = new JFrame();
    f.setDefaultCloseOperation( JFrame.EXIT_ON_CLOSE );
    
    final UndoManager undomanager = new UndoManager();
    
    final JTextArea textarea = new JTextArea( 20, 40 );
    textarea.setText( "Hier zurück" );
    f.getContentPane().add( new JScrollPane(textarea) );
    textarea.getDocument().addUndoableEditListener( undomanager );
    
    undomanager.setLimit( 1000 );
    
    JButton undoB = new JButton( "Undo" );
    
    undoB.addActionListener( new ActionListener() {
          public void actionPerformed( ActionEvent e )
          {
            undomanager.end();
            
            if ( undomanager.canUndo() )
              undomanager.undo();
            
            textarea.requestFocus();
          }
        });
    
    f.getContentPane().add( undoB, BorderLayout.SOUTH );
    
    f.pack();
    f.setVisible( true );
  }
}

Um genauer zu sehen, was das UndoManager-Objekt rückgängig macht, ist es nett, eine Unterklasse von UndoManager zu implementieren und dann die Methode undoableEditHappened() zu überschreiben. Diese Methode implementiert UndoManager von der Schnittstelle UndoableEditListener. Überschreiben wir nun die Methode in einer Unterklasse und geben aus, was bei jeder Aktion in den UndoManager kommt.

class MyUndoManager extends UndoManager
{
  public void undoableEditHappened( UndoableEditEvent e )
  {
    UndoableEdit ue = e.getEdit();
    
    System.out.println( ue );
    
    addEdit( ue );
  }
}

Die Methode undoableEditHappened() bekommt ein UndoableEditEvent, in dem der Verweis auf eine zurücknehmbare Operation abgelegt ist. An diese kommen wir mit getEdit(). Die Rückgabe ist ein UndoableEdit-Objekt, also genau eine Operation, die fähig zu einem Undo und Redo 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]