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

Version du langage : ActionScript 3.0
Version du lecteur : Flash Player 9

Flash® Player distribue les objets ProgressEvent lorsqu’une opération de chargement 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 Flash Player 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 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 : uint
Nombre d’éléments ou d’octets chargés lors du traitement de l’événement par l'écouteur.
ProgressEvent
  bytesTotal : uint
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
[static] 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:uint = 0, bytesTotal:uint = 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 votre classe Event personnalisée.
Event
 Inherited
Indique si la propriété spécifiée d'un objet est définie.
Object
 Inherited
Vérifie si 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"
[static] Définit la valeur de la propriété type d'un objet événement activate.
Event
 InheritedADDED : String = "added"
[static] Définit la valeur de la propriété type d'un objet événement added.
Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] Définit la valeur de la propriété type d'un objet événement addedToStage.
Event
 InheritedCANCEL : String = "cancel"
[static] Définit la valeur de la propriété type d'un objet événement cancel.
Event
 InheritedCHANGE : String = "change"
[static] Définit la valeur de la propriété type d'un objet événement change.
Event
 InheritedCLOSE : String = "close"
[static] Définit la valeur de la propriété type d'un objet événement close.
Event
 InheritedCOMPLETE : String = "complete"
[static] Définit la valeur de la propriété type d'un objet événement complete.
Event
 InheritedCONNECT : String = "connect"
[static] Définit la valeur de la propriété type d'un objet événement connect.
Event
 InheritedDEACTIVATE : String = "deactivate"
[static] Définit la valeur de la propriété type d'un objet événement deactivate.
Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] Définit la valeur de la propriété type d'un objet événement enterFrame.
Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] Définit la valeur de la propriété type d'un objet événement fullScreen.
Event
 InheritedID3 : String = "id3"
[static] Définit la valeur de la propriété type d'un objet événement id3.
Event
 InheritedINIT : String = "init"
[static] Définit la valeur de la propriété type d'un objet événement init.
Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] Définit la valeur de la propriété type d'un objet événement mouseLeave.
Event
 InheritedOPEN : String = "open"
[static] Définit la valeur de la propriété type d'un objet événement open.
Event
  PROGRESS : String = "progress"
[static] Définit la valeur de la propriété type d'un objet événement progress.
ProgressEvent
 InheritedREMOVED : String = "removed"
[static] Définit la valeur de la propriété type d'un objet événement removed.
Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] Définit la valeur de la propriété type d'un objet événement removedFromStage.
Event
 InheritedRENDER : String = "render"
[static] Définit la valeur de la propriété type d'un objet événement render.
Event
 InheritedRESIZE : String = "resize"
[static] Définit la valeur de la propriété type d'un objet événement resize.
Event
 InheritedSCROLL : String = "scroll"
[static] Définit la valeur de la propriété type d'un objet événement scroll.
Event
 InheritedSELECT : String = "select"
[static] Définit la valeur de la propriété type d'un objet événement select.
Event
  SOCKET_DATA : String = "socketData"
[static] Définit la valeur de la propriété type d'un objet événement socketData.
ProgressEvent
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] Définit la valeur de la propriété type d'un objet événement soundComplete.
Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] Définit la valeur de la propriété type d'un objet événement tabChildrenChange.
Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] Définit la valeur de la propriété type d'un objet événement tabEnabledChange.
Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] Définit la valeur de la propriété type d'un objet événement tabIndexChange.
Event
 InheritedUNLOAD : String = "unload"
[static] Définit la valeur de la propriété type d'un objet événement unload.
Event
Détails des propriétés
bytesLoadedpropriété
bytesLoaded:uint  [lecture-écriture]

Version du langage : ActionScript 3.0
Version du lecteur : 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():uint
    public function set bytesLoaded(value:uint):void
bytesTotalpropriété 
bytesTotal:uint  [lecture-écriture]

Version du langage : ActionScript 3.0
Version du lecteur : Flash Player 9

Nombre total d'éléments ou d'octets qui seront chargés si le processus de chargement aboutit.


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

Version du langage : ActionScript 3.0
Version du lecteur : 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:uint (default = 0) — Nombre d’éléments ou d’octets chargés lors du traitement de l’événement par l'écouteur.
 
bytesTotal:uint (default = 0) — Nombre total d'éléments ou d'octets qui seront chargés si le processus de chargement aboutit.
Détails des méthodes
clone()méthode
public override function clone():Event

Version du langage : ActionScript 3.0
Version du lecteur : 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 
public override function toString():String

Version du langage : ActionScript 3.0
Version du lecteur : 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
Version du lecteur : 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
bubblesfalse
bytesLoadedNombre d’éléments ou d’octets chargés lors du traitement de l’événement par l'écouteur.
bytesTotalNombre total d'éléments ou d'octets qui seront chargés si le processus de chargement aboutit.
cancelablefalse ; il n’existe aucun comportement par défaut à annuler.
currentTargetL’objet qui traite activement l’objet Event avec un écouteur d’événements.
targetObjet réseau indiquant la progression.

Voir aussi

SOCKET_DATAConstante 
public static const SOCKET_DATA:String = "socketData"

Version du langage : ActionScript 3.0
Version du lecteur : 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
bubblesfalse
cancelablefalse ; il n’existe aucun comportement par défaut à annuler.
currentTargetObjet qui traite activement l’événement.
bytesLoadedNombre d’éléments ou d’octets chargés lors du traitement de l’événement par l'écouteur.
bytesTotal0 ; cette propriété n’est pas utilisée par les objets événement socketData.
targetObjet 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énements 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énements et leurs méthodes d'abonnés associées :
    1. cancel / cancelHandler() est distribué si le téléchargement du fichier est annulé.
    2. complete / complereHandler() est distribué lorsque le téléchargement du fichier est terminé.
    3. ioError / ioErrorHandler() est distribué si le fichier téléchargé n'est pas disponible ou accessible.
    4. open / openHandler() est distribué lorsque l'opération de téléchargement démarre.
    5. progress / progressHandler() est distribué lorsque l'opération de téléchargement commence, puis lorsqu'elle se termine.
    6. securityError / securityErrorHandler est distribué si le paramètre de sécurité de lecture locale ne correspond pas au type d'accès aux données du fichier téléchargé (local versus réseau) ; voir les remarques ci-dessous.
    7. select / selectHandler() est distribué lorsque l'objet de téléchargement est sélectionné.

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




 

M'envoyer un message électronique lorsque des commentaires sont ajoutés à cette page | Rapport de commentaire

Page en cours: http://livedocs.adobe.com/flash/9.0_fr/ActionScriptLangRefV3/flash/events/ProgressEvent.html