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...
mx.rpc.livecycle 

DocumentReference  - AS3 ADEP Data Services

Paketmx.rpc.livecycle
Klassepublic class DocumentReference
VererbungDocumentReference Inheritance Object

Sprachversion: ActionScript 3.0
Produktversion: Adobe Digital Enterprise Platform Data Services für Java EE 3
Laufzeitversionen: Flash Player 9, AIR 1.1

Die DocumentReference-Klasse stellt die Mittel zur Verfügung, um von einem Flex-Client auf Dokumente auf dem Server zu verweisen. Eine DocumentReference sollte als Eingabeparameter für alle LiveCycle-Vorgänge verwendet werden, die einen Dokumenteingabeparameter erwarten. Eine DocumentReference wird auch als Ausgabeparameter für LiveCycle-Vorgänge zurückgegeben, die einen Parameter des Typs „Dokument“ zurückgeben.

Wenn das Dokument noch nicht auf dem Server liegt, verwenden Sie das LiveCycle Remoting-Servlet zum Hochladen, um das Dokument auf den Server zu stellen und mithilfe der vom Servlet zurückgegebenen URL eine DocumentReference zu erstellen.

     import flash.events.DataEvent;
     import flash.net.FileReference;
     
      private function startUpload():void
     {        
       fileRef.addEventListener(Event.SELECT, selectHandler);
       fileRef.addEventListener(DataEvent.UPLOAD_COMPLETE_DATA, completeHandler);
       try 
       {
           var success:Boolean = fileRef.browse();
       } 
       catch (error:Error) 
       {
           trace("Unable to browse for files.");
       }
     
     }
     
     private function selectHandler(event:Event):void {
       var request:URLRequest = new URLRequest("http://SERVER:PORT/remoting/lcfileupload")
       try 
       {
           fileRef.upload(request);
       } 
       catch (error:Error) 
       {
           trace("Unable to upload file.");
       }
     }
     
     private function completeHandler(event:DataEvent):void 
     {
          
       var params:Object = new Object();
       var docRef:DocumentReference = new DocumentReference();
       docRef.url = event.data as String;
       docRef.referenceType = DocumentReference.REF_TYPE_URL;
     }
     

Sie können auch eine FileReferenceList verwenden, um mehrere Dokumente gleichzeitig hochzuladen. Beispiel:

     import flash.events.DataEvent;
     import flash.net.FileReference;
     import flash.net.FileReferenceList;
     
          private function startUpload():void
          {
               pendingFiles = new Array();
               documents = new Array();
               fileRefList.addEventListener(Event.SELECT, selectHandler);
               try
               {
                   var success:Boolean = fileRefList.browse();
               }
               catch (error:Error)
               {
                   trace("Unable to browse for files.");
               }
           }
     
           private function selectHandler(event:Event):void
           {               
               var file:FileReference;                
               for (var i:uint = 0; i < fileRefList.fileList.length; i++) 
               {
                   file = FileReference(fileRefList.fileList[i]);
                   try
                   {
                       addPendingFile(file);
                   }
                   catch (error:Error)
                   {
                       Alert.show("Unable to upload file.");
                   }
               }                                       
           }        
           
           private function addPendingFile(file:FileReference):void 
           {
               trace("addPendingFile: name=" + file.name);
               var request:URLRequest = new URLRequest("http://10.60.147.127:8080/remoting/lcfileupload");
               pendingFiles.push(file);
               file.addEventListener(DataEvent.UPLOAD_COMPLETE_DATA, completeHandler);
               file.upload(request);
           }                  
           
           private function removePendingFile(file:FileReference):void 
           {
               for (var i:uint; i < pendingFiles.length; i++) 
               {
                   if (pendingFiles[i].name == file.name) 
                   {
                       pendingFiles.splice(i, 1);
                   }
               }
           }            
     
           private function completeHandler(event:DataEvent):void
           {               
               var params:Object = new Object();
               var docRef:DocumentReference = new DocumentReference();
               docRef.url = event.data as String;
               docRef.referenceType = DocumentReference.REF_TYPE_URL;
               documents.push(docRef);
               
               var file:FileReference = FileReference(event.target);
               removePendingFile(file);  
               
               if (pendingFiles.length == 0)
               {
                   // invoke a serivce that takes a collection of documents as an argument here
                   // using the "documents" array
                  ...
     

Wenn sich das Dokument bereits auf dem Server befindet und der Speicherort bekannt ist, setzen Sie das referenceType-Feld auf REF_TYPE_FILE und definieren Sie für das fileRef-Feld den Speicherort der Datei auf dem Server. Beispiel:

     var docRef:DocumentReference = new DocumentReference();
     docRef.fileRef = "C:/temp/file1";
     docRef.referenceType=DocumentReference.REF_TYPE_FILE;
     

Wenn sich das Dokument bereits auf dem Server befindet und die zugehörige URL bekannt ist, setzen Sie das referenceType-Feld auf die URL und das URL-Feld auf REF_TYPE_URL. Beispiel:

     var docRef:DocumentReference = new DocumentReference();
     docRef.url = "http://localhost:8080/DocumentManager/1168728809000/7855483216115920647";
     docRef.referenceType=DocumentReference.REF_TYPE_URL;
     

Außerdem können Sie ein Dokument aus einem Textstück auf dem Client erstellen. Auf dem Server wird dieser String zunächst in ein Byte-Array und anschließend in ein serverseitiges Dokument konvertiert. Standardmäßig wird der Standardzeichensatz des Servers für die Konvertierung in ein Byte-Array verwendet. Wenn ein anderer Zeichensatz verwendet werden soll, kann dieser über die charsetName-Eigenschaft dieses Objekts festgelegt werden. Beispiel:

     var docRef:DocumentReference = new DocumentReference();
     docRef.referenceType = DocumentReference.REF_TYPE_INLINE;
     docRef.text = "Text for my document";
     // to override server's default character set uncomment and set character set name
     // docRef.charsetName = "<name of your charset>"; 
     
     

Abschließend können Sie ein Dokument aus den Binärdaten auf dem Client erstellen. Diese Binärdaten werden in ein serverseitiges Dokument umgewandelt. Dieser Vorgang eignet sich bei einer geringen Datenmenge. Dabei wird der Inhalt nicht auf den Server hochgeladen und keine URL verwendet. Beim Festlegen von contentType im Verweis wird der Typ im Dokument definiert, wenn der serverseitige Code diesen Wert nicht feststellen kann. Beispiel:

     var image:ByteArray = ...
     var docRef:DocumentReference = new DocumentReference();
     docRef.referenceType = DocumentReference.REF_TYPE_INLINE;
     docRef.bytes = image;
     docRef.contentType = "image/jpg"; 
     

Flex-Clients erhalten Objekte des Typs DocumentReference.as für LC-Vorgänge, die Dokumente als Ausgabeparameter zurückgeben. Der referenceType des DocumentReference-Objekts informiert den Client, ob sich der Inhalt im DocumentReference-Objekt selbst oder in der DocumentReference.xml (bei XML-Dokumenten) befindet oder über eine URL (DocumentReference.url) abgerufen werden muss. Das DocumentReference.contentType-Feld informiert den Client über den Dokumenttyp.



Öffentliche Eigenschaften
 EigenschaftDefiniert von
  bytes : ByteArray
Vom Client sollte dieses Feld angegeben werden, wenn die DocumentReference aus den auf dem Client verfügbaren Binärdaten erstellt wird.
DocumentReference
  charsetName : String
Wenn die Option REF_TYPE_INLINE verwendet wird, um eine DocumentReference zu erstellen und ein Wert für das Textfeld dieses Objekts festgelegt wurde, kann dieses Feld so eingestellt werden, dass es den auf dem Server für die Konvertierung des übermittelten Textstrings in ein Byte-Array verwendeten Zeichensatz bestimmt.
DocumentReference
 Inheritedconstructor : Object
Ein Verweis auf das Klassenobjekt oder die Konstruktorfunktion für eine angegebene Objektinstanz.
Object
  contentType : String
Stringcode für den Inhaltstyp des Dokuments.
DocumentReference
  fileRef : String
Gefüllt, wenn der Verweistyp FILE ist.
DocumentReference
  referenceType : int
Verweistyp - REF_TYPE_URL, REF_TYPE_FILE oder REF_TYPE_INLINE.
DocumentReference
  text : String
Der Client muss dieses Feld einstellen, wenn die DocumentReference aus einem Textstring erstellt wird, der auf dem Client verfügbar ist.
DocumentReference
  url : String
Gefüllt, wenn der Verweistyp „URL“ ist.
DocumentReference
  xml : String
Gefüllt für XML-Dokumente, deren Inhalte inline übergeben werden.
DocumentReference
Öffentliche Methoden
 MethodeDefiniert von
  
[statisch] Erstellt eine Anforderung, die beim Hochladen eines Dokuments zu Remoting-Zwecken verwendet wird.
DocumentReference
  
Gibt den Wert des angegebenen Attributs zurück.
DocumentReference
 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
  
Gibt eine Liste von Attributnamen für die DocumentReference zurück.
DocumentReference
 Inherited
Gibt an, ob die angegebene Eigenschaft vorhanden ist und durchlaufen werden kann.
Object
  
Entfernt die Attribute aus der Attributliste.
DocumentReference
  
Fügt ein Attribut zur Attributliste für das Dokument hinzu.
DocumentReference
 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
Öffentliche Konstanten
 KonstanteDefiniert von
  REF_TYPE_FILE : uint = 2
[statisch] Verweis auf ein Dokument auf dem LC-Server über die Ordnerposition.
DocumentReference
  REF_TYPE_INLINE : uint = 3
[statisch] Auf den Dokumentinhalt wird nicht verwiesen, ist jedoch in diesem Objekt enthalten.
DocumentReference
  REF_TYPE_URL : uint = 1
[statisch] Erstellen Sie einen Verweis auf ein Dokument mithilfe einer von LC DocumentManager zur Verfügung gestellten URL für den LC-Server.
DocumentReference
Eigenschaftendetails

bytes

Eigenschaft
public var bytes:ByteArray

Sprachversion: ActionScript 3.0
Produktversion: Adobe Digital Enterprise Platform Data Services für Java EE 3
Laufzeitversionen: Flash Player 9, AIR 1.1

Vom Client sollte dieses Feld angegeben werden, wenn die DocumentReference aus den auf dem Client verfügbaren Binärdaten erstellt wird. Der referenceType muss in diesem Fall auf REF_TYPE_INLINE eingestellt sein.

charsetName

Eigenschaft 
public var charsetName:String

Sprachversion: ActionScript 3.0
Produktversion: Adobe Digital Enterprise Platform Data Services für Java EE 3
Laufzeitversionen: Flash Player 9, AIR 1.1

Wenn die Option REF_TYPE_INLINE verwendet wird, um eine DocumentReference zu erstellen und das Textfeld dieses Objekts gesetzt wurde, kann dieses Feld so eingestellt werden, dass es den auf dem Server für die Konvertierung des übermittelten Textstring in einen Bytearray verwendeten Zeichensatz bestimmt. Fehlt diese Einstellung, wird der Standardzeichensatz des Servers verwendet.

contentType

Eigenschaft 
public var contentType:String

Sprachversion: ActionScript 3.0
Produktversion: Adobe Digital Enterprise Platform Data Services für Java EE 3
Laufzeitversionen: Flash Player 9, AIR 1.1

Stringcode für den Inhaltstyp des Dokuments. Zum Beispiel „text/xml“.

fileRef

Eigenschaft 
public var fileRef:String

Sprachversion: ActionScript 3.0
Produktversion: Adobe Digital Enterprise Platform Data Services für Java EE 3
Laufzeitversionen: Flash Player 9, AIR 1.1

Gefüllt, wenn der Verweistyp FILE ist.

referenceType

Eigenschaft 
public var referenceType:int

Sprachversion: ActionScript 3.0
Produktversion: Adobe Digital Enterprise Platform Data Services für Java EE 3
Laufzeitversionen: Flash Player 9, AIR 1.1

Verweistyp - REF_TYPE_URL, REF_TYPE_FILE oder REF_TYPE_INLINE.

text

Eigenschaft 
public var text:String

Sprachversion: ActionScript 3.0
Produktversion: Adobe Digital Enterprise Platform Data Services für Java EE 3
Laufzeitversionen: Flash Player 9, AIR 1.1

Der Client muss dieses Feld einstellen, wenn die DocumentReference aus einem Textstring erstellt wird, der auf dem Client verfügbar ist. Der referenceType muss in diesem Fall auf REF_TYPE_INLINE eingestellt sein.

url

Eigenschaft 
public var url:String

Sprachversion: ActionScript 3.0
Produktversion: Adobe Digital Enterprise Platform Data Services für Java EE 3
Laufzeitversionen: Flash Player 9, AIR 1.1

Gefüllt, wenn der Verweistyp „URL“ ist.

xml

Eigenschaft 
public var xml:String

Sprachversion: ActionScript 3.0
Produktversion: Adobe Digital Enterprise Platform Data Services für Java EE 3
Laufzeitversionen: Flash Player 9, AIR 1.1

Gefüllt für XML-Dokumente, deren Inhalte inline übergeben werden.

Methodendetails

constructRequestForUpload

()Methode
public static function constructRequestForUpload(serverURL:String, authToken:String):URLRequest

Sprachversion: ActionScript 3.0
Produktversion: Adobe Digital Enterprise Platform Data Services für Java EE 3
Laufzeitversionen: Flash Player 9, AIR 1.1

Erstellt eine Anforderung, die beim Hochladen eines Dokuments zu Remoting-Zwecken verwendet wird. Die zurückgegebene Anforderung muss zusammen mit flash.net.FileReference verwendet werden. Sie sollte als Argument der upload-Funktion übergeben werden.

Parameter

serverURL:String — Die URL des Servers, auf den Sie ein Dokument hochladen. Beispiele: „http://localhost:8080“ oder „https://localhost:8443“.
 
authToken:String — Der Authentifizierungstoken des Dateiuploads wie er von einem Aufruf an getFileUploadToken des LC.FileUploadAuthenticator RemoteObject-Ziels zurückgegeben wurde. Eine authentifizierte Anforderung muss für den Server vorgenommen oder eine einmalige Anmeldung verwendet werden, bevor ein Dateiupload durchgeführt werden kann.

Rückgabewerte
URLRequest — Eine Anforderung, die beim Hochladen eines Dokuments zu Remoting-Zecken verwendet wird.

getAttribute

()Methode 
public function getAttribute(name:String):Object

Sprachversion: ActionScript 3.0
Produktversion: Adobe Digital Enterprise Platform Data Services für Java EE 3
Laufzeitversionen: Flash Player 9, AIR 1.1

Gibt den Wert des angegebenen Attributs zurück.

Parameter

name:String — Der Name des Attributs.

Rückgabewerte
Object

listAttributes

()Methode 
public function listAttributes():Array

Sprachversion: ActionScript 3.0
Produktversion: Adobe Digital Enterprise Platform Data Services für Java EE 3
Laufzeitversionen: Flash Player 9, AIR 1.1

Gibt eine Liste von Attributnamen für die DocumentReference zurück.

Rückgabewerte
Array — Eine Liste von Attributnamen für die DocumentReference.

removeAttribute

()Methode 
public function removeAttribute(name:String):void

Sprachversion: ActionScript 3.0
Produktversion: Adobe Digital Enterprise Platform Data Services für Java EE 3
Laufzeitversionen: Flash Player 9, AIR 1.1

Entfernt die Attribute aus der Attributliste.

Parameter

name:String — Der Attributname.

setAttribute

()Methode 
public function setAttribute(name:String, value:Object):void

Sprachversion: ActionScript 3.0
Produktversion: Adobe Digital Enterprise Platform Data Services für Java EE 3
Laufzeitversionen: Flash Player 9, AIR 1.1

Fügt ein Attribut zur Attributliste für das Dokument hinzu.

Parameter

name:String — Der Name des Attributs.
 
value:Object — Der Wert des Attributs.

Konstantendetails

REF_TYPE_FILE

Konstante
public static const REF_TYPE_FILE:uint = 2

Sprachversion: ActionScript 3.0
Produktversion: Adobe Digital Enterprise Platform Data Services für Java EE 3
Laufzeitversionen: Flash Player 9, AIR 1.1

Verweis auf ein Dokument auf dem LC-Server über die Ordnerposition.

REF_TYPE_INLINE

Konstante 
public static const REF_TYPE_INLINE:uint = 3

Sprachversion: ActionScript 3.0
Produktversion: Adobe Digital Enterprise Platform Data Services für Java EE 3
Laufzeitversionen: Flash Player 9, AIR 1.1

Auf den Dokumentinhalt wird nicht verwiesen, ist jedoch in diesem Objekt enthalten.

REF_TYPE_URL

Konstante 
public static const REF_TYPE_URL:uint = 1

Sprachversion: ActionScript 3.0
Produktversion: Adobe Digital Enterprise Platform Data Services für Java EE 3
Laufzeitversionen: Flash Player 9, AIR 1.1

Erstellen Sie einen Verweis auf ein Dokument mithilfe einer von LC DocumentManager zur Verfügung gestellten URL für den LC-Server.





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