Galileo Computing :: Java 7 - Mehr als eine Insel - 9 Grafische Oberflächen mit Swing

9.23 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.

9.23.1 Clipboard-Objekte

Die Zwischenablage ist in Java durch ein Clipboard-Objekt repräsentiert. Es gibt bei grafischen Oberflächen ein System-Clipboard, das 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 weiterzuarbeiten, 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 ICCCM[76](Das Inter-Client Communication Convention Manual (ICCCM) ist ein Handbuch, das die Arbeitsweise des X-Window-Systems beschreibt.) 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 die Methode getSystemSelection(), die genauso wie getSystemClipboard() ein Clipboard-Objekt zurückgibt.

9.23.2 Mit Transferable auf den Inhalt zugreifen

Die Klasse Clipboard ist recht methodenarm; lediglich drei Methoden werden angeboten. Um an den Inhalt der Zwischenablage zu gelangen, wird die Methode getContents() eingesetzt. Jedes Objekt, das in die Zwischenablage gelegt werden kann, implementiert dabei eine ganz spezielle Schnittstelle: Transferable. Daher ist es nicht weiter verwunderlich, wenn eine Anfragemethode von 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 überdies 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 );

Abbildung 9.56: UML-Diagramm der Abhängigkeiten von Clipboard

Das letzte Argument DataFlavor.stringFlavor – das kleine »s« ist kein Schreibfehler – 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. Andernfalls bekommt der ClipboardOwner ein lostOwnership() angezeigt.

9.23.3 DataFlavor ist 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-and-Drop-Operationen und beim Dateisystem vor.

Das Format eines Elements in der Zwischenablage wird von einem MIME-Typ definiert. So kann ein DataFlavor-Objekt den Inhalt auf vielfältige Weise repräsentieren, etwa als ASCII-Text, 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.

Abbildung 9.57: Klassendiagramm von DataFlavour

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, das 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.

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

Listing 9.85: com/tutego/insel/ui/datatransfer/PrintClipboard.java

package com.tutego.insel.ui.datatransfer;

import java.awt.Toolkit;
import java.awt.datatransfer.*;

class PrintClipboard
{
  public static void main( String[] args ) throws Exception
  {
    Clipboard systemClipboard = Toolkit.getDefaultToolkit().getSystemClipboard();
    Transferable transferData = systemClipboard.getContents( null );

    for ( DataFlavor dataFlavor : transferData.getTransferDataFlavors() )
    {
      Object content = transferData.getTransferData( dataFlavor );

      if ( content instanceof String )
      {
        System.out.println( content );
        break;
      }
    }
  }
}

9.23.4 Einfügungen in der Zwischenablage erkennen

Setzt der Anwender mit Strg + etwas in die Zwischenablage, kann eine andere Applikation den Inhalt der Zwischenablage verwenden. Um Änderungen am Clipboard mitzubekommen, lässt sich über addFlavorListener(FlavorListener) ein FlavorListener anhängen. removeFlavorListener(FlavorListener) entfernt ihn, und FlavorListener[] getFlavorListeners() liefert alle angemeldeten FlavorListener.

9.23.5 Drag & Drop

Mit Drag & Drop (D&D bzw. DnD) kann ein Anwender Daten von einer Stelle zu einer anderen übertragen. Viele Java-Standardkomponenten wie JList, JTable, JTextArea, JTree unterstützen direkt den Datentransfer; jede beliebige JComponent lässt sich leicht zur Drag-and-Drop-Komponente erweitern. Standardmäßig ist das DnD-Verhalten abgeschaltet, doch setDragEnabled(true) aktiviert es, wie das folgende Beispiel zeigt. Alle Einträge – also Zeichenketten – eines Standard-JTree lassen sich auf das Textfeld ziehen:

Listing 9.86: com/tutego/insel/ui/datatransfer/DaDDemo.java, main()

JFrame f = new JFrame();
f.setDefaultCloseOperation( JFrame.EXIT_ON_CLOSE );
f.setLayout( new BorderLayout() );
JTree tree = new JTree();
tree.setDragEnabled( true );
f.add( tree, BorderLayout.PAGE_START );
JTextArea textArea = new JTextArea();
f.add( new JScrollPane(textArea) );
f.setSize( 300, 300 );
f.setVisible( true );

Abbildung 9.58: Einträge aus dem JTree lassen sich auf das Textfeld ziehen.

Das Herz jeder DnD-Anwendung ist der TransferHandler. Er bietet einen Mechanismus zum Übertragen von Daten von oder zur JComponent. Wie schon bei der Zwischenablage beschreibt ein Transferable-Objekt die Daten selbst. Das Java-Tutorial »Drag and Drop and Data Transfer« unter http://download.oracle.com/javase/tutorial/uiswing/dnd/index.html beschreibt die beim Drag & Drop beteiligen Typen sehr ausführlich.

Ihr Kommentar

Wie hat Ihnen das <openbook> gefallen? Wir freuen uns immer über Ihre freundlichen und kritischen Rückmeldungen.

Name
E-Mail
Ihr Kommentar