Guide de référence ActionScript® 3.0 pour la plate-forme Adobe® Flash®
Accueil  |  Masquer la liste des packages et des classes |  Packages  |  Classes  |  Nouveautés  |  Index  |  Annexes  |  Pourquoi existe-t-il du contenu en anglais ?
Filtres : Récupération des données du serveur...
Récupération des données du serveur...
com.adobe.icomm.assetplacement.data 

XFADataStream  - AS3 Asset Placement

Packagecom.adobe.icomm.assetplacement.data
Classepublic class XFADataStream
HéritageXFADataStream Inheritance EventDispatcher Inheritance Object

Version du langage: ActionScript 3.0
Version du produit: Bloc de création Asset Placement 10
Versions du moteur d’exécution: 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.

Consulter les exemples

Eléments de l’API associés

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.


Propriétés publiques
 PropriétéDéfini par
 Inheritedconstructor : Object
Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet.
Object
Méthodes publiques
 MéthodeDéfini par
  
Constructor
XFADataStream
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Enregistre un objet écouteur d’événement auprès d’un objet EventDispatcher afin que l’écouteur soit averti d’un événement.
EventDispatcher
 Inherited
Distribue un événement dans le flux d’événements.
EventDispatcher
 Inherited
Vérifie si des écouteurs sont enregistrés auprès de l’objet EventDispatcher pour un type spécifique d’événement.
EventDispatcher
 Inherited
Indique si la propriété spécifiée d’un objet est définie.
Object
 Inherited
Indique si une occurrence de la classe Object figure dans la chaîne de prototype de l’objet spécifié en tant que paramètre.
Object
 Inherited
Indique si la propriété spécifiée existe et est énumérable.
Object
  
Asynch call to read the xfadata set xml stream from Acrobat.
XFADataStream
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Supprime un écouteur de l’objet EventDispatcher.
EventDispatcher
 Inherited
Définit la disponibilité d’une propriété dynamique pour les opérations en boucle.
Object
 Inherited
Renvoie la représentation de chaîne de cet objet, formatée selon les paramètres régionaux en vigueur.
Object
 Inherited
Renvoie la représentation sous forme de chaîne de l’objet spécifié.
Object
 Inherited
Renvoie la valeur primitive de l’objet spécifié.
Object
 Inherited
Vérifie si un écouteur d’événement est enregistré auprès de cet objet EventDispatcher ou de ses ancêtres pour le type d’événement spécifié.
EventDispatcher
  
Asynch call to save the given XML into the xfadata set stream within Acrobat.
XFADataStream
Evénements
 Evénement Synthèse Défini par
 Inherited[Evénement de diffusion] Distribué lorsque l’application Flash Player obtient le focus du système d’exploitation et devient active.EventDispatcher
 Inherited[Evénement de diffusion] Distribué lorsque l’application Flash Player ou AIR perd le focus du système d’exploitation et devient inactive.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
Détails du constructeur

XFADataStream

()Constructeur
public function XFADataStream()

Version du langage: ActionScript 3.0
Version du produit: Bloc de création Asset Placement 10
Versions du moteur d’exécution: AIR 1.0, Flash Player 9, Flash Player 10

Constructor

Détails de la méthode

readXML

()méthode
public function readXML():void

Version du langage: ActionScript 3.0
Version du produit: Bloc de création Asset Placement 10
Versions du moteur d’exécution: 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

()méthode 
public function writeXML(xml:XML):void

Version du langage: ActionScript 3.0
Version du produit: Bloc de création Asset Placement 10
Versions du moteur d’exécution: 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.

Paramètres

xml:XML

Détails de l’événement

xfaDataLoadFailed

Evénement
Type d’objet d’événement: com.adobe.icomm.assetplacement.data.XFADataLoadFailedEvent
propriété XFADataLoadFailedEvent.type = com.adobe.icomm.assetplacement.data.XFADataLoadedEvent.XFA_DATA_LOADFAILED

Version du langage: ActionScript 3.0
Version du produit: Bloc de création Asset Placement 10
Versions du moteur d’exécution: AIR 1.0, Flash Player 10

Dispatched when the xfadataset xml fails to load

xfaDataReady

Evénement  
Type d’objet d’événement: com.adobe.icomm.assetplacement.data.XFADataReadyEvent
propriété XFADataReadyEvent.type = com.adobe.icomm.assetplacement.data.XFADataLoadedEvent.XFA_DATA_LOADED

Version du langage: ActionScript 3.0
Version du produit: Bloc de création Asset Placement 10
Versions du moteur d’exécution: AIR 1.0, Flash Player 10

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

xfaDataSaved

Evénement  
Type d’objet d’événement: com.adobe.icomm.assetplacement.data.XFADataSavedEvent
propriété XFADataSavedEvent.type = com.adobe.icomm.assetplacement.data.XFADataSavedEvent.XFA_DATA_SAVED

Version du langage: ActionScript 3.0
Version du produit: Bloc de création Asset Placement 10
Versions du moteur d’exécution: 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

Evénement  
Type d’objet d’événement: com.adobe.icomm.assetplacement.data.XFADataSaveFailedEvent
propriété XFADataSaveFailedEvent.type = com.adobe.icomm.assetplacement.data.XFADataSaveFailedEvent.XFA_DATA_SAVEFAILED

Version du langage: ActionScript 3.0
Version du produit: Bloc de création Asset Placement 10
Versions du moteur d’exécution: 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 ]Pourquoi existe-t-il du contenu en anglais ?
Certaines parties du Guide de référence ActionScript 3.0 sont en anglais

Tout le contenu du Guide de référence ActionScript 3.0 n’a pas été traduit dans toutes les langues. Si un élément de langage n’est pas traduit, il s’affiche en anglais. Par exemple, la classe ga.controls.HelpBox n’est traduite dans aucune langue. Ainsi, dans la version française du guide de référence, la classe ga.controls.HelpBox apparaît en anglais.