Referência do ActionScript® 3.0 para Adobe® Flash® Platform
Início  |  Ocultar listas de Pacotes e Classes |  Pacotes  |  Classes  |  Novidades  |  Índice  |  Apêndices  |  Por que inglês?
Filtros: Recuperando dados do servidor...
Recuperando dados do servidor...
com.adobe.icomm.assetplacement.data 

XFADataStream  - AS3 Asset Placement

Pacotecom.adobe.icomm.assetplacement.data
Classepublic class XFADataStream
HerançaXFADataStream Inheritance EventDispatcher Inheritance Object

Versão da linguagem: ActionScript 3.0
Versão de produto: Asset Placement Building Block 10
Versões de runtime: 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.

Veja os exemplos

Elementos da API relacionados

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.


Propriedades públicas
 PropriedadeDefinido por
 Inheritedconstructor : Object
Uma referência ao objeto de classe ou à função de construtor de uma determinada ocorrência de objeto.
Object
Métodos públicos
 MétodoDefinido por
  
Constructor
XFADataStream
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registra um objeto de ouvinte de evento em um objeto EventDispatcher, de forma que o ouvinte receba a notificação de um evento.
EventDispatcher
 Inherited
Envia um evento para o fluxo de eventos.
EventDispatcher
 Inherited
Verifica se o objeto EventDispatcher tem ouvintes registrados para um tipo específico de evento.
EventDispatcher
 Inherited
Indica se um objeto tem uma propriedade especificada definida.
Object
 Inherited
Indica se uma ocorrência da classe Object está na cadeia de protótipos do objeto especificado como o parâmetro.
Object
 Inherited
Indica se a propriedade especificada existe e é enumerável.
Object
  
Asynch call to read the xfadata set xml stream from Acrobat.
XFADataStream
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Remove um ouvinte do objeto EventDispatcher.
EventDispatcher
 Inherited
Define a disponibilidade de uma propriedade dinâmica para operações de repetição.
Object
 Inherited
Retorna a representação da string deste objeto, formatado segundo as convenções específicas para a localidade.
Object
 Inherited
Retorna a representação de string do objeto especificado.
Object
 Inherited
Retorna o valor primitivo do objeto especificado.
Object
 Inherited
Verifica se um ouvinte de evento está registrado nesse objeto EventDispatcher ou em qualquer um de seus ancestrais para o tipo de evento especificado.
EventDispatcher
  
Asynch call to save the given XML into the xfadata set stream within Acrobat.
XFADataStream
Eventos
 Evento Resumo Definido por
 Inherited[transmissão de evento] Despachado quando o Flash Player ou o aplicativo do AIR ganha o foco do sistema operacional e está se tornando inativo.EventDispatcher
 Inherited[transmissão de evento] Despachado quando o Flash Player ou o aplicativo do AIR perde o foco do sistema operacional e está se tornando inativo.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
Detalhes do construtor

XFADataStream

()Construtor
public function XFADataStream()

Versão da linguagem: ActionScript 3.0
Versão de produto: Asset Placement Building Block 10
Versões de runtime: AIR 1.0, Flash Player 9, Flash Player 10

Constructor

Detalhes do método

readXML

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

Versão da linguagem: ActionScript 3.0
Versão de produto: Asset Placement Building Block 10
Versões de runtime: 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étodo 
public function writeXML(xml:XML):void

Versão da linguagem: ActionScript 3.0
Versão de produto: Asset Placement Building Block 10
Versões de runtime: 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.

Parâmetros

xml:XML

Detalhe do evento

xfaDataLoadFailed

Evento
Tipo do objeto de evento: com.adobe.icomm.assetplacement.data.XFADataLoadFailedEvent
propriedade XFADataLoadFailedEvent.type = com.adobe.icomm.assetplacement.data.XFADataLoadedEvent.XFA_DATA_LOADFAILED

Versão da linguagem: ActionScript 3.0
Versão de produto: Asset Placement Building Block 10
Versões de runtime: AIR 1.0, Flash Player 10

Dispatched when the xfadataset xml fails to load

xfaDataReady

Evento  
Tipo do objeto de evento: com.adobe.icomm.assetplacement.data.XFADataReadyEvent
propriedade XFADataReadyEvent.type = com.adobe.icomm.assetplacement.data.XFADataLoadedEvent.XFA_DATA_LOADED

Versão da linguagem: ActionScript 3.0
Versão de produto: Asset Placement Building Block 10
Versões de runtime: AIR 1.0, Flash Player 10

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

xfaDataSaved

Evento  
Tipo do objeto de evento: com.adobe.icomm.assetplacement.data.XFADataSavedEvent
propriedade XFADataSavedEvent.type = com.adobe.icomm.assetplacement.data.XFADataSavedEvent.XFA_DATA_SAVED

Versão da linguagem: ActionScript 3.0
Versão de produto: Asset Placement Building Block 10
Versões de runtime: 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

Evento  
Tipo do objeto de evento: com.adobe.icomm.assetplacement.data.XFADataSaveFailedEvent
propriedade XFADataSaveFailedEvent.type = com.adobe.icomm.assetplacement.data.XFADataSaveFailedEvent.XFA_DATA_SAVEFAILED

Versão da linguagem: ActionScript 3.0
Versão de produto: Asset Placement Building Block 10
Versões de runtime: 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 ]Por que inglês?
O conteúdo na Referência do ActionScript 3.0 aparece em inglês

Nem todas as partes da Referência do ActionScript 3.0 estão traduzidas em todos os idiomas. Quando um elemento de um idioma não está traduzido, ele é exibido em inglês. Por exemplo, a classe ga.controls.HelpBox não está traduzida em nenhum idioma. Por isso, na versão da referência em português do Brasil, a classe ga.controls.HelpBox é exibida em inglês.