15.31 Die Zwischenablage (Clipboard)

Seit der Java-Version 1.1 lässt sich von Java aus auf die Zwischenablage (engl. clipboard) zugreifen. Die Zwischenablage wird von Programmen zum Austausch von Daten und Objekten genutzt. Java-Objekte können von beliebigen Programmen zwischengespeichert und abgerufen werden.

Die Zwischenablage ist in Java durch ein Clipboard-Objekt repräsentiert. Es gibt bei grafischen Oberflächen ein System-Clipboard, welches sich über das Toolkit-Objekt erfragen lässt.

Clipboard systemClip = Toolkit.getDefaultToolkit().getSystemClipboard();

Neben einer System-Zwischenablage können wir aber auch beliebig viele eigene Clipboard-Objekte einsetzen. Um dann mit der Zwischenablage weiter zu arbeiten, sind noch einige andere Klassen im Spiel: Transferable und DataFlavor.

abstract class java.awt.Toolkit

abstract Clipboard getSystemClipboard() Liefert ein Exemplar des Clipboard-Objekts, das Möglichkeiten zum Zugriff auf die System-Zwischenablage bietet.

Die Betriebssysteme mit dem X11-System (Linux/Solaris ...) definieren laut dem ICCCM¹ drei Zwischenablagen: Clipboard-Selektion, Primär-Selektion und Sekundär-Selektion. In Java können wir bisher die zweite Selektion nicht nutzen, doch für die Primär-Selektion gibt es seit 1.4 die Funktion getSystemSelection(), die genauso wie getSystemClipboard() ein Clipboard-Objekt zurückgibt.

Auf den Inhalt zugreifen

Die Klasse Clipboard ist recht methodenarm; lediglich drei Funktionen werden angeboten. Um an den Inhalt zu gelangen, wird die Methode getContents() eingesetzt. Jedes Objekt, welches in die Zwischenablage gelegt werden kann, implementiert dabei eine ganz spezielle Schnittstelle: Transferable. Daher ist es nicht weiter verwunderlich, wenn eine Anfrage-Methode vom Clipboard genau ein Objekt vom Typ Transferable liefert.

class java.awt.datatransfer.Clipboard

Transferable getContents( Object requestor ) Liefert ein Transferable-Objekt, das den Inhalt der Zwischenablage verwaltet. Ein requestor wird nicht benötigt und ist daher null. Gibt es kein Element in der Zwischenablage, ist der Rückgabewert null.

Das zurückgegebene Objekt implementiert nun die Transferable-Schnittstelle und bietet über dies die Methode getTransferData() an, die den Inhalt der Zwischenablage zurückliefert.

Clipboard sysClip = Toolkit.getDefaultToolkit().getSystemClipboard();
Transferable transfer = sysClip.getContents( null );
String data = (String)transfer.getTransferData( DataFlavor.stringFlavor );

Der letzte Parameter DataFlavor.stringFlavor zeigt an, dass getTransferData() die Daten vom Transferable-Objekt als String erwartet. Der nächste Abschnitt verrät mehr über DataFlavor.

Inhalte lassen sich mit void setContents(Transferable contents, ClipboardOwner owner) in die Zwischenablage setzen. Der owner kann null sein, wenn nicht gemeldet werden soll, dass der Eigentümer nun ein neuer ist. Anderfalls bekommt der ClipboardOwner ein lostOwnership() angezeigt.

DataFlavor beschreibt das Format der Daten in der Zwischenablage

Die Klasse DataFlavor beschreibt das Format der Daten, die in der Zwischenablage liegen. Die Klasse kommt neben dem Einsatz in der Zwischenablage auch bei Drag&Drop-Operation und auch beim Dateisystem vor.

Das Format eines Elements in der Zwischenablage wird über einen MIME-Typ definert. So kann ein DataFlavor-Objekt den Inhalt auf vielfältige Weise repräsentieren, etwa als ASCII-Text oder Unicode oder auch als serialisiertes Objekt. Für einfachen Text ist der MIME-Typ etwa text/plain; charset=unicode und für serialisierte Objekte application/x-java-serialized-object.

Die Methode getTransferDataFlavors() liefert ein Feld unterstützter DataFlavor-Objekte eines gegebenen Transferable-Objekts. Dies sind in der Regel mehrere, denn der Inhalt der Zwischenablage liegt oft in verschiedenen Formaten vor. Ein von Microsoft Word in die Zwischenablage gesetzter Text liegt etwa in RTF und als Rohstring vor. Das wichtigste Objekt in dem Feld liegt an erster Stelle. Um den Typ erkennen zu können, liefert die Methode getHumanPresentableName() einen String mit einer lesbaren Beschreibung zurück, getMimeType() liefert den MIME-Typ.

interface java.awt.datatransfer.Transferable

DataFlavor[] getTransferDataFlavors() Liefert ein Feld von DataFlavor-Objekten, die den Inhalt und den Typ umfassen. Die Reihenfolge verläuft von der genauesten bis zur ungenauesten Beschreibung.

Object getTransferData( DataFlavor flavor ) throws UnsupportedFlavorException, IOException

Liefert das Objekt, welches dem angegebenen flavor entspricht. Eine UnsupportedFlavorException wird melden, dass der flavor nicht unterstützt wird. Daher ist es sinnvoll, einen der Typen aus der Liste von getTransferDataFlavors() zu nutzen.

boolean isDataFlavorSupported( DataFlavor flavor ) Liefert true, wenn der flavor unterstützt wird.

Hier klicken, um das Bild zu Vergrößern

Hier klicken, um das Bild zu Vergrößern

Das folgende Programm soll nun zeigen, wie auf die Zwischenablage zugegriffen wird und wie das Element, falls lesbar, ausgegeben wird. Am besten gelingt die Ausgabe mit einfachem ASCII-Test, der über Programme wie Notepad in die Zwischenablage gesetzt wurde.

Listing 15.44 PrintClipboard.java

import java.awt.Tooklit;
import java.awt.datatransfer.*;
class PrintClipboard
{
  public static void main( String args[] ) throws Exception
  {
    Clipboard systemClipboard = Toolkit.getDefaultToolkit().getSystemClipboard();
    
    Transferable transferData = systemClipboard.getContents( null );
    
    DataFlavor dataFlavor[] = transferData.getTransferDataFlavors();
    
    Object content = transferData.getTransferData( dataFlavor[1] );
    
    System.out.println( content );
  }
}

¹ Das Inter Client Communication Convention Manual (ICCCM) ist ein Handbuch, welches das Verfahren vom X-Window-System beschreibt.