Packageflash.events
Classepublic class ProgressEvent
HéritageProgressEvent Inheritance Event Inheritance Object
Sous-classes VideoProgressEvent

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: AIR 1.0 Flash Player 9

Un objet ProgressEvent est distribué lorsqu'une opération load a commencé ou qu'un socket a reçu des données. En règle générale, ces événements sont générés lors du chargement dans une application de fichiers SWF, d'images ou de données. Il existe deux types de d'événements progress : ProgressEvent.PROGRESS et ProgressEvent.SOCKET_DATA.

Consulter les exemples

Voir aussi

classe FileStream
Classe LoaderInfo
Classe Socket


Propriétés publiques
 PropriétéDéfini par
 Inheritedbubbles : Boolean
[lecture seule] Indique si un événement peut se propager vers le haut (bubbling).
Event
  bytesLoaded : Number
Nombre d'éléments ou d'octets chargés lors du traitement de l'événement par l'écouteur.
ProgressEvent
  bytesTotal : Number
Nombre total d'éléments ou d'octets qui seront chargés si le processus de chargement aboutit.
ProgressEvent
 Inheritedcancelable : Boolean
[lecture seule] Indique si le comportement associé à l'événement peut être annulé.
Event
 Inheritedconstructor : Object
Référence à l'objet de classe ou à la fonction constructeur d'une occurrence donnée d'un objet.
Object
 InheritedcurrentTarget : Object
[lecture seule] L'objet qui traite activement l'objet Event avec un écouteur d'événements.
Event
 InheritedeventPhase : uint
[lecture seule] Phase actuelle du flux d'événements.
Event
 Inheritedprototype : Object
[statique] Référence à l'objet prototype d'un objet de classe ou fonction.
Object
 Inheritedtarget : Object
[lecture seule] Cible de l'événement.
Event
 Inheritedtype : String
[lecture seule] Type d'événement.
Event
Méthodes publiques
 MéthodeDéfini par
  
ProgressEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, bytesLoaded:Number = 0, bytesTotal:Number = 0)
Crée un objet Event contenant des informations sur les événements progress.
ProgressEvent
  
Crée une copie de l'objet ProgressEvent et définit la valeur de chaque propriété de sorte qu'elle corresponde à la valeur d'origine.
ProgressEvent
 Inherited
formatToString(className:String, ... arguments):String
Fonction d'un utilitaire permettant d'implémenter la méthode toString() dans des classes Event ActionScript 3.0 personnalisées.
Event
 Inherited
Indique si la propriété spécifiée d'un objet est définie.
Object
 Inherited
Vérifie si la méthode preventDefault() a été appelée pour l'événement.
Event
 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
Annule le comportement par défaut d'un événement si cette opération est possible.
Event
 Inherited
Indique si la propriété spécifiée existe et est énumérable.
Object
 Inherited
Définit la disponibilité d'une propriété dynamique pour les opérations en boucle.
Object
 Inherited
Bloque le traitement des écouteurs d'événement dans le nœud actuel et les suivants dans le flux d'événements.
Event
 Inherited
Bloque le traitement des écouteurs d'événement dans les nœuds qui suivent le nœud actuel dans le flux d'événements.
Event
  
Renvoie une chaîne répertoriant toutes les propriétés de l'objet ProgressEvent.
ProgressEvent
 Inherited
Renvoie la valeur primitive de l'objet spécifié.
Object
Constantes publiques
 ConstanteDéfini par
 InheritedACTIVATE : String = "activate"
[statique] La constante ACTIVATE définit la valeur de la propriété type d'un objet événement activate.
Event
 InheritedADDED : String = "added"
[statique] La constante Event.ADDED définit la valeur de la propriété type d'un objet événement added.
Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[statique] La constante Event.ADDED_TO_STAGE définit la valeur de la propriété type d'un objet d'événement addedToStage.
Event
 InheritedCANCEL : String = "cancel"
[statique] La constante Event.CANCEL définit la valeur de la propriété type d'un objet événement cancel.
Event
 InheritedCHANGE : String = "change"
[statique] La constante Event.CHANGE définit la valeur de la propriété type de l'objet d'événement change.
Event
 InheritedCLEAR : String = "clear"
[statique] La constante Event.CLEAR définit la valeur de la propriété type d'un objet événement clear.
Event
 InheritedCLOSE : String = "close"
[statique] La constante Event.CLOSE définit la valeur de la propriété type d'un objet événement close.
Event
 InheritedAIR-only CLOSING : String = "closing"
[statique] La constante Event.CLOSING définit la valeur de la propriété type d'un objet événement closing.
Event
 InheritedCOMPLETE : String = "complete"
[statique] La constante Event.COMPLETE définit la valeur de la propriété type d'un objet événement complete.
Event
 InheritedCONNECT : String = "connect"
[statique] La constante Event.CONNECT définit la valeur de la propriété type d'un objet événement connect.
Event
 InheritedCOPY : String = "copy"
[statique] Définit la valeur de la propriété type d'un objet d'événement copy.
Event
 InheritedCUT : String = "cut"
[statique] Définit la valeur de la propriété type d'un objet d'événement cut.
Event
 InheritedDEACTIVATE : String = "deactivate"
[statique] La constante Event.DEACTIVATE définit la valeur de la propriété type d'un objet événement deactivate.
Event
 InheritedDISPLAYING : String = "displaying"
[statique] La constante Event.DISPLAYING définit la valeur de la propriété type d'un objet événement displaying.
Event
 InheritedENTER_FRAME : String = "enterFrame"
[statique] La constante Event.ENTER_FRAME définit la valeur de la propriété type d'un objet événement enterFrame.
Event
 InheritedEXIT_FRAME : String = "exitFrame"
[statique] La constante Event.EXIT_FRAME définit la valeur de la propriété type d'un objet événement exitFrame.
Event
 InheritedAIR-only EXITING : String = "exiting"
[statique] La constante Event.EXITING définit la valeur de la propriété type de l'objet d'événement exiting.
Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[statique] La constante Event.FRAME_CONSTRUCTED définit la valeur de la propriété type d'un objet événement frameConstructed.
Event
 InheritedFULLSCREEN : String = "fullScreen"
[statique] La constante Event.FULL_SCREEN définit la valeur de la propriété type d'un objet événement fullScreen.
Event
 InheritedAIR-only HTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[statique] La constante Event.HTML_BOUNDS_CHANGE définit la valeur de la propriété type d'un objet événement htmlBoundsChange.
Event
 InheritedAIR-only HTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[statique] La constante Event.HTML_DOM_INITIALIZE définit la valeur de la propriété type d'un objet événement htmlDOMInitialize.
Event
 InheritedAIR-only HTML_RENDER : String = "htmlRender"
[statique] La constante Event.HTML_RENDER définit la valeur de la propriété type d'un objet événement htmlRender.
Event
 InheritedID3 : String = "id3"
[statique] La constante Event.ID3 définit la valeur de la propriété type d'un objet événement id3.
Event
 InheritedINIT : String = "init"
[statique] La constante Event.INIT définit la valeur de la propriété type d'un objet événement init.
Event
 InheritedAIR-only LOCATION_CHANGE : String = "locationChange"
[statique] La constante Event.LOCATION_CHANGE définit la valeur de la propriété type d'un objet événement locationChange.
Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[statique] La constante Event.MOUSE_LEAVE définit la valeur de la propriété type d'un objet événement mouseLeave.
Event
 InheritedAIR-only NETWORK_CHANGE : String = "networkChange"
[statique] La constante Event.NETWORK_CHANGE définit la valeur de la propriété type d'un objet événement networkChange.
Event
 InheritedOPEN : String = "open"
[statique] La constante Event.OPEN définit la valeur de la propriété type d'un objet événement open.
Event
 InheritedPASTE : String = "paste"
[statique] La constante Event.PASTE définit la valeur de la propriété type d'un objet événement paste.
Event
  PROGRESS : String = "progress"
[statique] Définit la valeur de la propriété type d'un objet événement progress.
ProgressEvent
 InheritedREMOVED : String = "removed"
[statique] La constante Event.REMOVED définit la valeur de la propriété type d'un objet événement removed.
Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[statique] La constante Event.REMOVED_FROM_STAGE définit la valeur de la propriété type d'un objet événement removedFromStage.
Event
 InheritedRENDER : String = "render"
[statique] La constante Event.RENDER définit la valeur de la propriété type d'un objet événement render.
Event
 InheritedRESIZE : String = "resize"
[statique] La constante Event.RESIZE définit la valeur de la propriété type d'un objet événement resize.
Event
 InheritedSCROLL : String = "scroll"
[statique] La constante Event.SCROLL définit la valeur de la propriété type d'un objet événement scroll.
Event
 InheritedSELECT : String = "select"
[statique] La constante Event.SELECT définit la valeur de la propriété type d'un objet événement select.
Event
 InheritedSELECT_ALL : String = "selectAll"
[statique] La constante Event.SELECT_ALL définit la valeur de la propriété type d'un objet événement selectAll.
Event
  SOCKET_DATA : String = "socketData"
[statique] Définit la valeur de la propriété type d'un objet événement socketData.
ProgressEvent
 InheritedSOUND_COMPLETE : String = "soundComplete"
[statique] La constante Event.SOUND_COMPLETE définit la valeur de la propriété type d'un objet événement soundComplete.
Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[statique] La constante Event.TAB_CHILDREN_CHANGE définit la valeur de la propriété type d'un objet événement tabChildrenChange.
Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[statique] La constante Event.TAB_ENABLED_CHANGE définit la valeur de la propriété type d'un objet événement tabEnabledChange.
Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[statique] La constante Event.TAB_INDEX_CHANGE définit la valeur de la propriété type d'un objet événement tabIndexChange.
Event
 InheritedUNLOAD : String = "unload"
[statique] La constante Event.UNLOAD définit la valeur de la propriété type d'un objet événement unload.
Event
 InheritedAIR-only USER_IDLE : String = "userIdle"
[statique] La constante Event.USER_IDLE définit la valeur de la propriété type d'un objet événement userIdle.
Event
 InheritedAIR-only USER_PRESENT : String = "userPresent"
[statique] La constante Event.USER_PRESENT définit la valeur de la propriété type d'un objet événement userPresent.
Event
Détails de la propriété
bytesLoadedpropriété
bytesLoaded:Number  [lecture-écriture]

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: AIR 1.0 Flash Player 9

Nombre d'éléments ou d'octets chargés lors du traitement de l'événement par l'écouteur.



Implémentation
    public function get bytesLoaded():Number
    public function set bytesLoaded(value:Number):void
bytesTotalpropriété 
bytesTotal:Number  [lecture-écriture]

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: AIR 1.0 Flash Player 9

Nombre total d'éléments ou d'octets chargés si le processus de chargement aboutit. Si l'événement progress est distribué/associé à un objet Socket, le bytesTotal est toujours 0 à moins qu'une valeur soit spécifiée dans le paramètre bytesTotal du constructeur. Le nombre réel d'octets renvoyé n'est pas défini et dépend du développeur de l'application.



Implémentation
    public function get bytesTotal():Number
    public function set bytesTotal(value:Number):void
Détails du constructeur
ProgressEvent()Constructeur
public function ProgressEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, bytesLoaded:Number = 0, bytesTotal:Number = 0)

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: AIR 1.0 Flash Player 9

Crée un objet Event contenant des informations sur les événements progress. Les objets Event sont transmis en tant que paramètres aux écouteurs d'événements.

Paramètres
type:String — Type de l'événement. Les valeurs possibles sont les suivantes : ProgressEvent.PROGRESS et ProgressEvent.SOCKET_DATA.
 
bubbles:Boolean (default = false) — Détermine si l'objet Event prend part à la phase de propagation vers le haut (bubbling) du flux d'événements.
 
cancelable:Boolean (default = false) — Détermine si l'objet Event peut être annulé.
 
bytesLoaded:Number (default = 0) — Nombre d'éléments ou d'octets chargés lors du traitement de l'événement par l'écouteur.
 
bytesTotal:Number (default = 0) — Nombre total d'éléments ou d'octets qui seront chargés si le processus de chargement aboutit.
Détails de la méthode
clone()méthode
override public function clone():Event

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: AIR 1.0 Flash Player 9

Crée une copie de l'objet ProgressEvent et définit la valeur de chaque propriété de sorte qu'elle corresponde à la valeur d'origine.

Valeur renvoyée
Event — Nouvel objet ProgressEvent dont les propriétés ont la même valeur que celles de l'objet d'origine.
toString()méthode 
override public function toString():String

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: AIR 1.0 Flash Player 9

Renvoie une chaîne répertoriant toutes les propriétés de l'objet ProgressEvent. La chaîne est écrite au format suivant :

[ProgressEvent type=valeur bubbles=valeur cancelable=valeur bytesLoaded=valeur bytesTotal=valeur ]

Valeur renvoyée
String — Chaîne répertoriant toutes les propriétés de l'objet ProgressEvent.
Détails de la constante
PROGRESSConstante
public static const PROGRESS:String = "progress"

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: AIR 1.0 Flash Player 9

Définit la valeur de la propriété type d'un objet événement progress.

Les propriétés de cet événement sont les suivantes :

PropriétéValeur
bubbles false
bytesLoaded Nombre d'éléments ou d'octets chargés lors du traitement de l'événement par l'écouteur.
bytesTotal Nombre total d'éléments ou d'octets qui seront chargés si le processus de chargement aboutit.
cancelable false ; il n'existe aucun comportement par défaut à annuler.
currentTarget L'objet qui traite activement l'objet Event avec un écouteur d'événements.
target Objet indiquant la progression.

Voir aussi

SOCKET_DATAConstante 
public static const SOCKET_DATA:String = "socketData"

Version du langage: ActionScript 3.0
Versions du moteur d'exécution: AIR 1.0 Flash Player 9

Définit la valeur de la propriété type d'un objet événement socketData.

Les propriétés de cet événement sont les suivantes :

PropriétéValeur
bubbles false
cancelable false ; il n'existe aucun comportement par défaut à annuler.
currentTarget Objet qui traite activement l'événement.
bytesLoaded Nombre d'éléments ou d'octets chargés lors du traitement de l'événement par l'écouteur.
bytesTotal 0 ; cette propriété n'est pas utilisée par les objets événement socketData.
target Objet Socket indiquant la progression.

Voir aussi

Exemples Utilisation des exemples
ProgressEventExample.as

L'exemple suivant utilise la classe ProgressEventExample pour montrer comment les différents écouteurs d'événement sont utilisés lors du téléchargement d'un fichier. L'exemple exécute les tâches suivantes :
  1. Les propriétés downloadURL et fileName sont créées, et indiquent l'emplacement et le nom du fichier téléchargé.
  2. Dans le constructeur ProgressEventExample, un nouvel objet FileReference nommé file est créé, puis transmis à la méthode configureListeners().
  3. Les propriétés downloadURL et fileName sont ensuite transmises à la méthode file.download(), qui demande l'emplacement de téléchargement du fichier.
  4. La méthode configureListeners() ajoute sept écouteurs d'événement et leurs méthodes d'abonnés associées :

Remarques :

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);
        }
    }
}