Referenshandbok för ActionScript® 3.0 i Adobe® Flash®-plattformen
Hem  |  Dölj paket och klasslista |  Paket  |  Klasser  |  Nyheter  |  Index  |  Bilagor  |  Varför på engelska?
Filter: Hämtar data från servern ...
Hämtar data från servern ...
flash.events 

ProgressEvent  - AS3

Paketflash.events
Klasspublic class ProgressEvent
ArvProgressEvent Inheritance Event Inheritance Object
Underklasser ModuleEvent, ResourceEvent, RSLEvent, StyleEvent, VideoProgressEvent

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9, Flash Lite 4

Ett ProgressEvent-objekt skickas när en inläsning har börjat eller när en socket har tagit emot data. Dessa händelser genereras vanligen när SWF-filer, bilder eller data läses in i ett program. Det finns två typer av förloppshändelser: ProgressEvent.PROGRESS och ProgressEvent.SOCKET_DATA. Dessutom skickas ProgressEvent-objekt i AIR när data skickas till eller från en underordnad process med klassen NativeProcess.

Visa exemplen

Relaterade API-element



Publika egenskaper
 EgenskapDefinieras med
 Inheritedbubbles : Boolean
[skrivskyddad] indikerar om händelsen är en bubblande händelse.
Event
  bytesLoaded : Number
Antalet objekt eller byte som har lästs in när avlyssnaren behandlar händelsen.
ProgressEvent
  bytesTotal : Number
Det totala antalet objekt eller byte som har lästs in när inläsningen är klar.
ProgressEvent
 Inheritedcancelable : Boolean
[skrivskyddad] Indikerar om beteendet som är kopplat till händelsen kan förhindras.
Event
 Inheritedconstructor : Object
En referens till klassobjektet eller konstruktorfunktionen för en given objektinstans.
Object
 InheritedcurrentTarget : Object
[skrivskyddad] Det objekt som aktivt behandlar Event-objektet med en händelseavlyssnare.
Event
 InheritedeventPhase : uint
[skrivskyddad] Den nuvarande fasen i händelseflödet.
Event
 Inheritedtarget : Object
[skrivskyddad] Händelsens mål.
Event
 Inheritedtype : String
[skrivskyddad] Händelsens typ.
Event
Publika metoder
 MetodDefinieras med
  
ProgressEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, bytesLoaded:Number = 0, bytesTotal:Number = 0)
Skapar ett nytt Event-objekt som innehåller information om förloppshändelser.
ProgressEvent
  
[åsidosätt] Skapar en kopia av ProgressEvent-objektet och ställer in värdet för alla egenskaper så att de matchar originalets egenskaper.
ProgressEvent
 Inherited
formatToString(className:String, ... arguments):String
Ett verktyg som används för att implementera metoden toString() i de anpassade klasserna ActionScript 3.0.
Event
 Inherited
Anger om det finns en egenskap angiven för ett objekt.
Object
 Inherited
Kontrollerar om preventDefault()-metoden har anropats för händelsen.
Event
 Inherited
Anger om en instans av klassen Object finns i prototypkedjan för objektet som anges som parameter.
Object
 Inherited
Avbryter en händelses standardbeteende om det beteendet kan avbrytas.
Event
 Inherited
Anger om den angivna egenskapen finns och är uppräkningsbar.
Object
 Inherited
Anger tillgänglighet för en dynamisk egenskap för slingåtgärder.
Object
 Inherited
Förhindrar behandling av händelsehanterare i den aktuella noden och alla noder som följer den aktuella noden i händelseflödet.
Event
 Inherited
Förhindrar behandling av händelsehanterare i noder som följer den aktuella noden i händelseflödet.
Event
 Inherited
Returnerar det här objektets strängrepresentation, formaterad i enlighet med språkspecifika konventioner.
Object
  
[åsidosätt] Returnerar en sträng som innehåller alla egenskaper i ProgressEvent-objektet.
ProgressEvent
 Inherited
Returnerar det angivna objektets primitiva värde.
Object
Publika konstanter
 KonstantDefinieras med
  PROGRESS : String = "progress"
[statisk] Definierar värdet för ett progress-händelseobjekts type-egenskap.
ProgressEvent
  SOCKET_DATA : String = "socketData"
[statisk] Definierar värdet för ett socketData-händelseobjekts type-egenskap.
ProgressEvent
  STANDARD_ERROR_DATA : String = "standardErrorData"
[statisk] Definierar värdet på type-egenskapen i ett standardErrorData-händelseobjekt.
ProgressEvent
  STANDARD_INPUT_PROGRESS : String = "standardInputProgress"
[statisk] Definierar värdet på type-egenskapen i ett standardInputProgress-händelseobjekt.
ProgressEvent
  STANDARD_OUTPUT_DATA : String = "standardOutputData"
[statisk] Definierar värdet på type-egenskapen i ett standardOutputData-händelseobjekt.
ProgressEvent
Egenskapsdetaljer

bytesLoaded

egenskap
bytesLoaded:Number

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9, Flash Lite 4

Antalet objekt eller byte som har lästs in när avlyssnaren behandlar händelsen.



Implementering
    public function get bytesLoaded():Number
    public function set bytesLoaded(value:Number):void

bytesTotal

egenskap 
bytesTotal:Number

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9, Flash Lite 4

Det totala antalet objekt eller byte som har lästs in när inläsningen är klar. Om progress-händelsen skickas till ett Socket-objekt kommer bytesTotal alltid att vara 0 om inte ett värde specificeras i bytesTotal-parametern i konstruktorn. Antal byte som skickas fram eller tillbaka är inte inställt och bestäms av programutvecklaren.



Implementering
    public function get bytesTotal():Number
    public function set bytesTotal(value:Number):void
Konstruktordetaljer

ProgressEvent

()Konstruktor
public function ProgressEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, bytesLoaded:Number = 0, bytesTotal:Number = 0)

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9, Flash Lite 4

Skapar ett nytt Event-objekt som innehåller information om förloppshändelser. Event-objekt skickas som parametrar till händelseavlyssnare.

Parametrar
type:String — Händelsens typ. Möjliga värden är: ProgressEvent.PROGRESS, ProgressEvent.SOCKET_DATA, ProgressEvent.STANDARD_ERROR_DATA, ProgressEvent.STANDARD_INPUT_PROGRESS och ProgressEvent.STANDARD_OUTPUT_DATA.
 
bubbles:Boolean (default = false) — Bestämmer om Event-objektet deltar i bubblingssteget av händelseflödet.
 
cancelable:Boolean (default = false) — Avgör om Event-objektet kan avbrytas.
 
bytesLoaded:Number (default = 0) — Antalet objekt eller byte som har lästs in när avlyssnaren bearbetar händelsen.
 
bytesTotal:Number (default = 0) — Det totala antalet objekt eller byte som har lästs in när inläsningen är klar.
Metoddetaljer

clone

()metod
override public function clone():Event

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9, Flash Lite 4

Skapar en kopia av ProgressEvent-objektet och ställer in värdet för alla egenskaper så att de matchar originalets egenskaper.

Returnerar
Event — Ett nytt ProgressEvent-objekt med egenskapsvärden som matchar originalet.

toString

()metod 
override public function toString():String

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9, Flash Lite 4

Returnerar en sträng som innehåller alla egenskaper i ProgressEvent-objektet. Strängen är i följande format:

[ProgressEvent type=värde bubbles=värde cancelable=värde bytesLoaded=värde bytesTotal=värde]

Returnerar
String — En sträng som innehåller alla ProgressEvent-objektets egenskaper.
Konstantdetaljer

PROGRESS

Konstant
public static const PROGRESS:String = "progress"

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9, Flash Lite 4

Definierar värdet för ett progress-händelseobjekts type-egenskap.

Den här händelsen har följande egenskaper:

EgenskapVärde
bubblesfalse
bytesLoadedAntalet objekt eller byte som har lästs in när avlyssnaren bearbetar händelsen.
bytesTotalDet totala antalet objekt eller byte som kommer att ha lästs in om inläsningen lyckas.
cancelablefalse; det finns inget standardbeteende att avbryta.
currentTargetDet objekt som aktivt behandlar Event-objektet med en händelseavlyssnare.
targetObjektet rapporterar förlopp.

Relaterade API-element

SOCKET_DATA

Konstant 
public static const SOCKET_DATA:String = "socketData"

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 1.0, Flash Player 9, Flash Lite 4

Definierar värdet för ett socketData-händelseobjekts type-egenskap.

Den här händelsen har följande egenskaper:

EgenskapVärde
bubblesfalse
cancelablefalse; det finns inget standardbeteende att avbryta.
currentTargetObjektet som aktivt bearbetar händelsen.
bytesLoadedAntalet objekt eller byte som har lästs in när avlyssnaren bearbetar händelsen.
bytesTotal0; den här egenskapen används inte av socketData-händelseobjekt.
targetFörloppet för socket-rapportering.

Relaterade API-element

STANDARD_ERROR_DATA

Konstant 
public static const STANDARD_ERROR_DATA:String = "standardErrorData"

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 2, Flash Lite 4

Definierar värdet på type-egenskapen i ett standardErrorData-händelseobjekt.

Den här händelsen har följande egenskaper:

EgenskapVärde
bubblesfalse
cancelablefalse; det finns inget standardbeteende att avbryta.
currentTargetObjektet som aktivt bearbetar händelsen.
bytesLoadedAntal byte med feldata som buffrats av NativeProcessObject.error på grund av den här händelsen.
bytesTotal0; den här egenskapen används inte av standardErrorData-händelseobjekt.
targetDet NativeProcess-objekt som rapporterar feldata.

Relaterade API-element

STANDARD_INPUT_PROGRESS

Konstant 
public static const STANDARD_INPUT_PROGRESS:String = "standardInputProgress"

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 2, Flash Lite 4

Definierar värdet på type-egenskapen i ett standardInputProgress-händelseobjekt.

Den här händelsen har följande egenskaper:

EgenskapVärde
bubblesfalse
cancelablefalse; det finns inget standardbeteende att avbryta.
currentTargetObjektet som aktivt bearbetar händelsen.
bytesLoadedAntal byte med feldata som buffrats av NativeProcessObject.error på grund av den här händelsen.
bytesTotal0; den här egenskapen används inte av standardInputProgress-händelseobjekt.
targetDet NativeProcess-objekt som rapporterar feldata.

Relaterade API-element

STANDARD_OUTPUT_DATA

Konstant 
public static const STANDARD_OUTPUT_DATA:String = "standardOutputData"

Språkversion: ActionScript 3.0
Körningsmiljöversioner: AIR 2, Flash Lite 4

Definierar värdet på type-egenskapen i ett standardOutputData-händelseobjekt.

Den här händelsen har följande egenskaper:

EgenskapVärde
bubblesfalse
cancelablefalse; det finns inget standardbeteende att avbryta.
currentTargetObjektet som aktivt bearbetar händelsen.
bytesLoadedAntal byte med utdata som buffrats av NativeProcessObject.output på grund av den här händelsen.
bytesTotal0; den här egenskapen används inte av standardOutputData-händelseobjekt.
targetDet NativeProcess-objekt som rapporterar utdata.

Relaterade API-element

ProgressEventExample.as

I följande exempel används ProgressEventExample-klassen för att illustrera hur olika händelseavlyssnare används när en fil laddas ned. I exemplen utförs följande uppgifter:
  1. Egenskaperna downloadURL och fileName skapas, vilket anger plats och namn på filen som laddats ned.
  2. I konstruktorn ProgressEventExample skapas ett nytt FileReference-objekt med namnet file som sedan skickas till configureListeners()-metoden.
  3. Egenskaperna downloadURL och fileName skickas sedan till file.download(), vilket anger var filen ska laddas ned.
  4. Metoden configureListeners() lägger till sju händelseavlyssnare och de mottagarmetoder som är kopplade till dem:
    1. cancel/cancelHandler() skickas om filnedladdningen avbryts.
    2. complete/complereHandler() skickas när filnedladdningen är avslutad.
    3. ioError/ioErrorHandler() skickas om den laddade ned filen inte går att komma åt.
    4. open/openHandler() skickas när nedladdningen har startat.
    5. progress/progressHandler() skickas när nedladdningsprocessen startas samt när den avslutas.
    6. securityError/securityErrorHandler skickas om den lokala säkerhetsinställningen för uppspelning inte matchar den laddade ned filens typ av dataåtkomst (lokal kontra nätverk); se anteckningarna nedan.
    7. select/selectHandler() skickas när nedladdningsobjektet har valts.

Obs!

  • Du måste kompilera SWF-filen med Lokal uppspelningssäkerhet inställd på Använd bara nätverksfiler.
  • Exemplet kräver en fil med namnet SomeFile.pdf.
  • Även om det här exemplet använder alla händelser som är tillgängliga för FileReference-objektet kräver de flesta situationer bara en delmängd.

package {
    import flash.display.Sprite;
    import flash.events.*;
    import flash.net.FileReference;
    import flash.net.URLRequest;

    public class ProgressEventExample extends Sprite {
        private var downloadURL:String = "http://www.[yourDomain].com/SomeFile.pdf";
        private var fileName:String = "SomeFile.pdf";
        private var file:FileReference;

        public function ProgressEventExample() {
            var request:URLRequest = new URLRequest(downloadURL);
            file = new FileReference();
            configureListeners(file);
            file.download(request, fileName);
        }

        private function configureListeners(dispatcher:IEventDispatcher):void {
            dispatcher.addEventListener(Event.CANCEL, cancelHandler);
            dispatcher.addEventListener(Event.COMPLETE, completeHandler);
            dispatcher.addEventListener(IOErrorEvent.IO_ERROR, ioErrorHandler);
            dispatcher.addEventListener(Event.OPEN, openHandler);
            dispatcher.addEventListener(ProgressEvent.PROGRESS, progressHandler);
            dispatcher.addEventListener(SecurityErrorEvent.SECURITY_ERROR, securityErrorHandler);
            dispatcher.addEventListener(Event.SELECT, selectHandler);
        }

        private function cancelHandler(event:Event):void {
            trace("cancelHandler: " + event);
        }

        private function completeHandler(event:Event):void {
            trace("completeHandler: " + event);
        }

        private function ioErrorHandler(event:IOErrorEvent):void {
            trace("ioErrorHandler: " + event);
        }

        private function openHandler(event:Event):void {
            trace("openHandler: " + event);
        }

        private function progressHandler(event:ProgressEvent):void {
            var file:FileReference = FileReference(event.target);
            trace("progressHandler: name=" + file.name + " bytesLoaded=" + event.bytesLoaded + " bytesTotal=" + event.bytesTotal);
        }

        private function securityErrorHandler(event:SecurityErrorEvent):void {
            trace("securityErrorHandler: " + event);
        }

        private function selectHandler(event:Event):void {
            var file:FileReference = FileReference(event.target);
            trace("selectHandler: name=" + file.name + " URL=" + downloadURL);
        }
    }
}




[ X ]Varför på engelska?
Innehåll i Referenshandbok för ActionScript 3.0 i Adobe Flash-plattformen är på engelska

Det är inte alla delar av Referenshandbok för ActionScript 3.0 i Adobe Flash-plattformen som översätts till alla språk. Om ett språkelement inte översätts visas det på engelska. Klassen ga.controls.HelpBox översätts till exempel inte till något språk. I den svenska versionen av referenshandboken visas därför klassen ga.controls.HelpBox på engelska.