Clipboard  - AS3

Ein Array von Strings, das die Namen der Datenformate enthält, die in diesem Clipboard-Objekt verfügbar sind.

Stringkonstanten für die Namen der Standardformate sind in der ClipboardFormats-Klasse definiert. Auch andere durch die Anwendung definierte Strings können als Formatnamen für die Übertragung von Daten als Objekt verwendet werden.

Verwandte API-Elemente

 var availableFormats:Array = Clipboard.generalClipboard.formats;

Die Zwischenablage des Betriebssystems.

Alle Daten, die in die Zwischenablage kopiert werden, sind für andere Anwendungen verfügbar. Dazu kann auch unsicherer Remotecode gehören, der in einem Webbrowser ausgeführt wird.

Hinweis: In Flash Player 10-Anwendungen erfordert ein Einfügevorgang aus der Zwischenablage ein durch den Benutzer ausgelöstes Ereignis (z. B. Tastaturbefehl, „Einfügen“-Befehl, Mausklick auf den „Einfügen“-Befehl in einem Kontextmenü). Clipboard.getData() gibt die Inhalte der Zwischenablage nur zurück, wenn das InteractiveObject ein paste-Ereignis erhalten hat und darauf reagiert. Unter anderen Bedingungen ist der Aufruf von Clipboard.getData() erfolglos. Dieselbe Einschränkung gilt in AIR für Inhalte außerhalb der Anwendungssandbox.

Das generalClipboard-Objekt wird automatisch erstellt. Sie können dieser Eigenschaft keine weitere Clipboard-Instanz zuweisen. Verwenden Sie stattdessen die Methoden getData() und setData(), um Daten in das vorhandene Objekt zu schreiben bzw. daraus zu lesen.

Sie sollten die Zwischenablage immer leeren, bevor Sie neue Daten hineinschreiben, um sicher zu sein, dass alte Daten aller Formate gelöscht wurden.

Das generalClipboard-Objekt kann nicht an den AIR-NativeDragManager übergeben werden. Erstellen Sie ein neues Clipboard-Objekt für native Drag&Drop-Operationen in einer AIR-Anwendung.

 import flash.desktop.ClipboardFormats;
 
 var copy:String = "A string to copy to the system clipboard.";
 Clipboard.generalClipboard.clear();
 Clipboard.generalClipboard.setData(ClipboardFormats.TEXT_FORMAT, copy);

 import flash.desktop.ClipboardFormats;
 
 var pasteData:String  = Clipboard.generalClipboard.getData(ClipboardFormats.TEXT_FORMAT) as String;

Gibt an, ob das Zwischenablageformat der Dateizusage vom Clientsystem unterstützt wird.

Erstellt ein leeres Clipboard-Objekt.

Erstellen Sie Clipboard-Objekte, um die Daten einer nativen Drag & Drop-Geste in Adobe AIR aufzunehmen. Clipboard-Objekte können nur für eine Drag & Drop-Geste verwendet werden; sie lassen sich nicht wiederverwenden.

Erstellen Sie Clipboard-Objekte nicht für Kopieren-und-Einfügen-Vorgänge. Verwenden Sie stattdessen ein einzelnes Clipboard.generalClipboard-Objekt.

Verwandte API-Elemente

 import flash.desktop.Clipboard;
 
 var clipboard:Clipboard = new Clipboard();

Löscht alle Datendarstellungen aus diesem Clipboard-Objekt.

 Clipboard.generalClipboard.clear();

Löscht alle Datendarstellungen für das angegebene Format.

Parameter

 import flash.desktop.ClipboardFormats;
 
 Clipboard.generalClipboard.clearData(ClipboardFormats.TEXT_FORMAT);

Ruft die Daten in der Zwischenablage ab, falls Daten im angegebenen Format vorhanden sind.

In Flash Player muss die getData()-Methode in einer paste-Ereignisprozedur aufgerufen werden. In AIR gilt diese Einschränkung nur für Inhalte außerhalb der Sicherheitssandbox der Anwendung.

Wenn auf ein Standarddatenformat zugegriffen wird, werden die Daten als ein neues Objekt des entsprechenden Flash-Datentyps zurückgegeben.

Wenn auf ein von der Anwendung definiertes Format zugegriffen wird, bestimmt der Wert des transferMode-Parameters, ob ein Verweis auf das ursprüngliche Objekt oder ein anonymes Objekt mit einer serialisierten Kopie des ursprünglichen Objekts zurückgegeben wird. Wenn ein originalPreferred- oder clonePreferred-Modus festgelegt ist, geben Flash Player oder AIR die alternative Version zurück, wenn die ursprüngliche nicht verfügbar ist. Wenn ein originalOnly- oder cloneOnly-Modus festgelegt ist, geben Flash Player oder AIR null zurück, wenn die angeforderte Version nicht verfügbar ist.

Parameter

Verwandte API-Elemente

 import flash.desktop.ClipboardFormats;

 var pasteData:String = Clipboard.generalClipboard.getData(ClipboardFormats.TEXT_FORMAT) as String;

Überprüft, ob in diesem Clipboard-Objekt Daten im angegebenen Format vorhanden sind.

Verwenden Sie für Verweise auf Standardformatnamen die Konstanten der ClipboardFormats-Klasse.

Parameter

Verwandte API-Elemente

if(Clipboard.generalClipboard.hasFormat(ClipboardFormats.TEXT_FORMAT)){
    //do something 
}

Fügt eine Darstellung der Informationen hinzu, die in das angegebene Datenformat übertragen werden sollen.

In der Anwendungssandbox von Adobe AIR kann setData() jederzeit aufgerufen werden. In anderen Kontexten kann setData() nur als Reaktion auf ein vom Benutzer generiertes Ereignis, zum Beispiel Tastenbetätigung oder Mausklick, aufgerufen werden.

Verschiedene Darstellungen derselben Informationen können der Zwischenablage in verschiedenen Formaten hinzugefügt werden, sodass anderen Komponenten oder Anwendungen die verfügbaren Daten mit größerer Wahrscheinlichkeit nutzen können. Ein Bild kann zum Beispiel in Form von Bitmapdaten für Bildbearbeitungsanwendungen hinzufügt werden, als URL und als codierte PNG-Datei für die Übertragung in das native Dateisystem.

Der data-Parameter muss den entsprechenden Datentyp für das angegebene Format aufweisen:

Benutzerdefinierte Formatnamen dürfen nicht mit „air:“ oder „flash:“ beginnen. Um Konflikte bei der Benennung zu vermeiden, wenn Sie benutzerdefinierte Formate verwenden, können Sie die Anwendungs-ID oder einen Paketnamen als Präfix für den Formatnamen verwenden, zum Beispiel „com.example.applicationName.dataPacket“.

Beim Übertragen innerhalb von oder zwischen Anwendungen bestimmt der serializable-Parameter, ob sowohl ein Verweis und eine Kopie verfügbar sind, oder ob nur ein Verweis auf ein Objekt verfügbar ist. Stellen Sie serializable auf true, damit sowohl ein Verweis als auch eine Kopie der Daten verfügbar sind. Stellen Sie serializable auf false, damit nur der Objektverweis verfügbar ist. Objektverweise sind nur innerhalb der aktuellen Anwendung gültig, sodass die Einstellung von serializable auf false auch bedeutet, dass die Daten in diesem Format nicht für andere Flash Player- oder AIR-Anwendungen verfügbar sind. Eine Komponente kann wahlweise den Verweis oder die Objektkopie abrufen, indem der entsprechende Übertragungsmodus für die Zwischenablage eingestellt wird, wenn auf die Daten für dieses Format zugegriffen wird.

Hinweis: Die Standardformate werden immer in native Formate konvertiert, wenn Daten außerhalb einer unterstützten Anwendung eingefügt oder gezogen werden, sodass der Wert des serializable-Parameters keinen Einfluss auf die Verfügbarkeit der Daten in Standardformaten für nicht Flash-basierte Anwendungen hat.

Verwenden Sie stattdessen die setDataHandler()-Methode, um die Wiedergabe von Daten eines bestimmten Formats zurückzustellen. Wenn sowohl die setData()- als auch die setDataHandler()-Methode verwendet wird, um eine Datendarstellung mit demselben Formatnamen hinzuzufügen, wird die Prozedurfunktion nie aufgerufen.

Hinweis: Wenn Sie auf Mac OS den format-Parameter auf ClipboardFormats.URL_FORMAT setzen, wird die URL nur übertragen, wenn es sich um eine gültige URL handelt. Andernfalls wird das Clipboard-Objekt geleert (und das Aufrufen von getData() ergibt null).

Parameter

Verwandte API-Elemente

 import flash.desktop.ClipboardFormats;
 
 var htmlString:String = "<html><body>Body content</body></html>";
 Clipboard.generalClipboard.setData(ClipboardFormats.TEXT_FORMAT, urlString);
 Clipboard.generalClipboard.setData(ClipboardFormats.HTML_FORMAT, urlString);

Fügt eine Prozedurfunktion hinzu, die die zu übertragenden Daten produziert.

Verwenden Sie eine Prozedurfunktion, um die Erstellung oder Wiedergabe der Daten zurückzustellen, bis tatsächlich auf sie zugegriffen wird.

Die Prozedurfunktion muss den entsprechenden Datentyp für das angegebene Format zurückweisen:

Die Prozedurfunktion wird nur dann aufgerufen, wenn die Daten im angegebenen Format gelesen werden. Beachten Sie, dass in einigen Fällen das Betriebssystem die Funktion aufruft, bevor ein Ablegen erfolgt. Wenn Sie zum Beispiel eine Prozedurfunktion verwenden, um die Daten für eine Datei, die aus einer AIR-Anwendung in das Betriebssystem gezogen wird, bereitzustellen, ruft das Betriebssystem die Datenprozedur auf, sobald die Ziehen-Geste die AIR-Anwendung verlässt. Dies führt normalerweise zu einer unerwünschten Pause, da die Dateidaten heruntergeladen oder erstellt werden. Sie können stattdessen eine URLFilePromise zu diesem Zweck verwenden.

Beachten Sie, dass die zugrunde liegenden Daten zwischen dem Hinzufügen der Prozedur und dem Lesen der Daten geändert werden können, falls Ihre Anwendung die Daten nicht schützt. Das Verhalten, das auftritt, wenn durch eine Prozedurfunktion dargestellte Daten in der Zwischenablage mehrmals gelesen werden, kann nicht garantiert werden. Die Zwischenablage gibt entweder die Daten zurück, die durch den ersten Funktionsaufruf generiert wurden, oder die Funktion wird erneut aufgerufen. Keine der beiden Verhaltensweisen kann garantiert werden.

In der Anwendungssandbox von Adobe AIR kann setDataHandler() jederzeit aufgerufen werden. In anderen Kontexten kann setDataHandler() nur als Reaktion auf ein vom Benutzer generiertes Ereignis, zum Beispiel Tastenbetätigung oder Mausklick, aufgerufen werden.

Wenn Sie diesem Clipboard-Objekt Daten direkt hinzufügen möchten, verwenden Sie stattdessen die setData()-Methode. Wenn sowohl die setData()- als auch die setDataHandler()-Methode mit demselben Formatnamen aufgerufen wird, wird die Prozedurfunktion nie aufgerufen.

Hinweis: Wenn Sie auf Mac OS den format-Parameter auf ClipboardFormats.URL_FORMAT setzen, wird die URL nur übertragen, wenn die Prozedurfunktion eine gültige URL zurückgibt. Andernfalls wird das Clipboard-Objekt geleert (und das Aufrufen von getData() ergibt null).

Parameter

Verwandte API-Elemente

 import flash.desktop.ClipboardFormats;
 
 Clipboard.generalClipboard.setDataHandler(ClipboardFormats.TEXT_FORMAT, randomNumberGenerator);

 public function randomNumberGenerator():String{
     return Math.random().toString();
 }

1. Schreiben Sie die Daten, in diesem Fall ein String, in Clipboard.generalClipboard.
2. Lesen Sie den Inhalt der Zwischenablage aus Clipboard.generalClipboard.

Hinweis: Aufgrund von Sicherheitseinschränkungen beim Zugriff auf Daten in der Zwischenablage funktioniert dieses Beispiel in Flash Player nicht. In Flash Player können Sie die getData()-Methode eines Clipboard-Objekts nur in einer paste-Ereignisprozedur aufrufen.

package
{
    import flash.display.Sprite;
    import flash.desktop.Clipboard;
    import flash.desktop.ClipboardFormats;
    import flash.desktop.ClipboardTransferMode;

    public class ClipboardExample extends Sprite
    {
        public function ClipboardExample()
        {
            var sally:String = "Sally";
            var person:String;
            
            copy(sally);
            person = paste();
            trace(person); //traces: "Sally"
        }

        private function copy(text:String):void 
        {
            Clipboard.generalClipboard.clear();
            Clipboard.generalClipboard.setData(ClipboardFormats.TEXT_FORMAT, text);
        }
        
        private function paste():String
        {
            if(Clipboard.generalClipboard.hasFormat(ClipboardFormats.TEXT_FORMAT))
            {
                return String(Clipboard.generalClipboard.getData(ClipboardFormats.TEXT_FORMAT));
            } 
            else 
            {
                return null;
            }
        }
        
    }
}