ActionScript® 3.0 Referenzhandbuch für die Adobe® Flash®-Plattform
Home  |  Liste der Pakete und Klassen ausblenden |  Pakete  |  Klassen  |  Neue Funktionen  |  Stichwortverzeichnis  |  Anhänge  |  Warum auf Englisch?
Filter: Daten werden vom Server abgerufen...
Daten werden vom Server abgerufen...
com.adobe.icomm.assetplacement.data 

XFADataStream  - AS3 Asset Placement

Paketcom.adobe.icomm.assetplacement.data
Klassepublic class XFADataStream
VererbungXFADataStream Inheritance EventDispatcher Inheritance Object

Sprachversion: ActionScript 3.0
Produktversion: Baustein „Asset Placement“ 10
Laufzeitversionen: AIR 1.0, Flash Player 10

XFADataStream is used for asynchronous read/write to the datasets XML packet within the XFA array of a PDF document. The datasets XML is specified in a package definition file by declaring an xml resource with a special reserved id value of "data". This packet represents the data that both the host PDF document and the SWF navigator share. In order to read/write to this packet the application must have initialized the NavigatorHostInstance class by calling
             NavigatorHostInstance.initialize(hostValue);
     
in the handshaking function between the navigator and the host.

Beispiele anzeigen

Verwandte API-Elemente

com.adobe.portfolio.api.INavigator
com.adobe.portfolio.api.INavigatorHost
Otherwise any calls to read or write to the datasets packet will throw an exception.


Öffentliche Eigenschaften
 EigenschaftDefiniert von
 Inheritedconstructor : Object
Ein Verweis auf das Klassenobjekt oder die Konstruktorfunktion für eine angegebene Objektinstanz.
Object
Öffentliche Methoden
 MethodeDefiniert von
  
Constructor
XFADataStream
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registriert ein Ereignis-Listener-Objekt bei einem EventDispatcher-Objekt, sodass der Listener über ein Ereignis benachrichtigt wird.
EventDispatcher
 Inherited
Sendet ein Ereignis in den Ereignisablauf.
EventDispatcher
 Inherited
Überprüft, ob das EventDispatcher-Objekt Listener für einen bestimmten Ereignistyp registriert hat.
EventDispatcher
 Inherited
Gibt an, ob für ein Objekt eine bestimmte Eigenschaft definiert wurde.
Object
 Inherited
Gibt an, ob eine Instanz der Object-Klasse in der Prototypkette des Objekts vorhanden ist, das als Parameter angegeben wurde.
Object
 Inherited
Gibt an, ob die angegebene Eigenschaft vorhanden ist und durchlaufen werden kann.
Object
  
Asynch call to read the xfadata set xml stream from Acrobat.
XFADataStream
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Entfernt einen Listener aus dem EventDispatcher-Objekt.
EventDispatcher
 Inherited
Legt die Verfügbarkeit einer dynamischen Eigenschaft für Schleifenoperationen fest.
Object
 Inherited
Gibt die Stringdarstellung dieses Objekts zurück, formatiert entsprechend den Konventionen des Gebietsschemas.
Object
 Inherited
Gibt das angegebene Objekt als String zurück.
Object
 Inherited
Gibt den Grundwert des angegebenen Objekts zurück.
Object
 Inherited
Überprüft, ob bei diesem EventDispatcher-Objekt oder bei einem seiner Vorgänger ein Ereignis-Listener für einen bestimmten Ereignistyp registriert ist.
EventDispatcher
  
Asynch call to save the given XML into the xfadata set stream within Acrobat.
XFADataStream
Ereignisse
 Ereignis Übersicht Definiert von
 Inherited[broadcast event] Wird ausgelöst, wenn Flash Player oder eine AIR-Anwendung den Betriebssystemfokus erhält und aktiv wird.EventDispatcher
 Inherited[broadcast event] Wird ausgelöst, wenn Flash Player- oder die AIR-Anwendung den Fokus verliert und inaktiv wird.EventDispatcher
  Dispatched when the xfadataset xml fails to loadXFADataStream
  Dispatched when the xfadataset xml is available after calling readXML()XFADataStream
  Dispatched when the xfadataset xml has finished saving after a call to saveData(xml)XFADataStream
  Dispatched when the xfadataset xml has failed to save after a call to saveXML(xml)XFADataStream
Konstruktordetails

XFADataStream

()Konstruktor
public function XFADataStream()

Sprachversion: ActionScript 3.0
Produktversion: Baustein „Asset Placement“ 10
Laufzeitversionen: AIR 1.0, Flash Player 9, Flash Player 10

Constructor

Methodendetails

readXML

()Methode
public function readXML():void

Sprachversion: ActionScript 3.0
Produktversion: Baustein „Asset Placement“ 10
Laufzeitversionen: AIR 1.0, Flash Player 10

Asynch call to read the xfadata set xml stream from Acrobat. Caller should register for xfaDataReady event as well as xfaDataLoadFailed event. Calling this function before setting NavigatorHostInstance.value throws an error.

writeXML

()Methode 
public function writeXML(xml:XML):void

Sprachversion: ActionScript 3.0
Produktversion: Baustein „Asset Placement“ 10
Laufzeitversionen: AIR 1.0, Flash Player 10

Asynch call to save the given XML into the xfadata set stream within Acrobat. Caller should register for xfaDataSaved and xfaDataSaveFailed events to determine the outcome. The xml passed in must be non-null, otherwise an Error is thrown. Calling this function before setting NavigatorHostInstance.value throws an error.

Parameter

xml:XML

Ereignisdetails

xfaDataLoadFailed

Ereignis
Ereignisobjekttyp: com.adobe.icomm.assetplacement.data.XFADataLoadFailedEvent
Eigenschaft XFADataLoadFailedEvent.type = com.adobe.icomm.assetplacement.data.XFADataLoadedEvent.XFA_DATA_LOADFAILED

Sprachversion: ActionScript 3.0
Produktversion: Baustein „Asset Placement“ 10
Laufzeitversionen: AIR 1.0, Flash Player 10

Dispatched when the xfadataset xml fails to load

xfaDataReady

Ereignis  
Ereignisobjekttyp: com.adobe.icomm.assetplacement.data.XFADataReadyEvent
Eigenschaft XFADataReadyEvent.type = com.adobe.icomm.assetplacement.data.XFADataLoadedEvent.XFA_DATA_LOADED

Sprachversion: ActionScript 3.0
Produktversion: Baustein „Asset Placement“ 10
Laufzeitversionen: AIR 1.0, Flash Player 10

Dispatched when the xfadataset xml is available after calling readXML()

xfaDataSaved

Ereignis  
Ereignisobjekttyp: com.adobe.icomm.assetplacement.data.XFADataSavedEvent
Eigenschaft XFADataSavedEvent.type = com.adobe.icomm.assetplacement.data.XFADataSavedEvent.XFA_DATA_SAVED

Sprachversion: ActionScript 3.0
Produktversion: Baustein „Asset Placement“ 10
Laufzeitversionen: AIR 1.0, Flash Player 10

Dispatched when the xfadataset xml has finished saving after a call to saveData(xml)

A value that represents the Event name.

xfaDataSaveFailed

Ereignis  
Ereignisobjekttyp: com.adobe.icomm.assetplacement.data.XFADataSaveFailedEvent
Eigenschaft XFADataSaveFailedEvent.type = com.adobe.icomm.assetplacement.data.XFADataSaveFailedEvent.XFA_DATA_SAVEFAILED

Sprachversion: ActionScript 3.0
Produktversion: Baustein „Asset Placement“ 10
Laufzeitversionen: AIR 1.0, Flash Player 9, Flash Player 10

Dispatched when the xfadataset xml has failed to save after a call to saveXML(xml)

A value that represents the Event name.
This class can be used in ActionScript as follows:
     
     private xfaStream:XFADataStream = new XFADataStream();
     
     public function set host(value:INavigatorHost):void
     {
             if(value)
             {
             //
             //Initialize the navigator.
             //
                 
             //Set the host instance to allow centralized access
             NavigatorHostInstance.initialize(value);
     
             //Add handlers for read/write                       
             xfaStream.addEventListener(XFADataReadyEvent.XFA_DATA_READY, onXFADataReady);
             xfaStream.addEventListener(XFADataLoadFailedEvent.XFA_DATA_LOADFAILED, onXFADataLoadFailed);                                 
             xfaStream.addEventListener(XFADataSavedEvent.XFA_DATA_SAVED, onXFADataSaved);
             xfaStream.addEventListener(XFADataSaveFailedEvent.XFA_DATA_SAVEFAILED, onXFADataSaveFailed);
         }    
         else
         {
             //
             //Shutdown the navigator
             //
             NavigatorHostInstance.release();
     
                 //other cleanup ...
             }
     }
     
     public function readData() : void
     {
      try
       {
         xfaStream.readXML();                    
          }
      catch(e:Error)
       {
         //UNEXPECTED ERROR
       } 
     }
     
     public function writeData(newXML:XML) : void
     {
         try
         {                    
             xfaStream.writeXML(xml);
         }
         catch(e:Error) 
         {
             //UNEXPECTED ERROR 
         } 
     }
      
     //event handler for when xfa data successfully loaded via XFADataStream
     private function onXFADataReady(event:XFADataReadyEvent) : void
     {
         //The xfa data loaded successfully 
         var info:XML = event.data;
     }
     
     //event handler for when xfa data fails to load via XFADataStream
     private function onXFADataLoadFailed(event:XFADataLoadFailedEvent) : void
     {
             //Failed to load data. See event.error
     }
     
     //event handler for when xfa data successfully saved via XFADataStream
     private function onXFADataSaved(event:XFADataSavedEvent) : void
     {
             //The xfa data was saved successfully");                
     }
     
     //event handler for when xfa data fails to save via XFADataStream
     private function onXFADataSaveFailed(event:XFADataSaveFailedEvent) : void
     {
             //Failure to save data. See event.error
     }
     
     




[ X ]Warum auf Englisch?
Inhalt des ActionScript 3.0-Referenzhandbuchs wird in englischer Sprache angezeigt

Nicht alle Teile des ActionScript 3.0-Referenzhandbuchs wurden in alle Sprachen übersetzt. Wenn der Text zu einem Sprachelement nicht übersetzt wurde, wird er auf Englisch angezeigt. Zum Beispiel wurden die Informationen zur ga.controls.HelpBox-Klasse nicht in andere Sprachen übersetzt. In der deutschen Version des Referenzhandbuchs erscheint der Abschnitt zur ga.controls.HelpBox-Klasse deshalb auf Englisch.