Package | flash.events |
Classe | public class ProgressEvent |
Héritage | ProgressEvent Event Object |
Sous-classes | ModuleEvent, ResourceEvent, RSLEvent, StyleEvent, VideoProgressEvent |
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | AIR 1.0, Flash Player 9, Flash Lite 4 |
ProgressEvent.PROGRESS
et ProgressEvent.SOCKET_DATA
. Dans AIR, les objets ProgressEvent sont en outre distribués lorsque des données sont envoyées vers ou à partir d’un processus enfant à l’aide de la classe NativeProcess.
Eléments de l’API associés
Propriété | Défini par | ||
---|---|---|---|
bubbles : 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 | ||
cancelable : Boolean [lecture seule]
Indique si le comportement associé à l’événement peut être évité. | Event | ||
constructor : Object
Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet. | Object | ||
currentTarget : Object [lecture seule]
L’objet qui traite activement l’objet Event avec un écouteur d’événements. | Event | ||
eventPhase : uint [lecture seule]
Phase actuelle du flux d’événements. | Event | ||
target : Object [lecture seule]
Cible de l’événement. | Event | ||
type : String [lecture seule]
Type d’événement. | Event |
Méthode | Dé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 | ||
[override]
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 | ||
Fonction d’un utilitaire permettant d’implémenter la méthode toString() dans des classes Event ActionScript 3.0 personnalisées. | Event | ||
Indique si la propriété spécifiée d’un objet est définie. | Object | ||
Vérifie si la méthode preventDefault() a été appelée pour l’événement. | Event | ||
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 | ||
Annule le comportement par défaut d’un événement si cette opération est possible. | Event | ||
Indique si la propriété spécifiée existe et est énumérable. | Object | ||
Définit la disponibilité d’une propriété dynamique pour les opérations en boucle. | Object | ||
Bloque le traitement des écouteurs d’événement dans le nœud actuel et les suivants dans le flux d’événements. | Event | ||
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 la représentation de chaîne de cet objet, formatée selon les paramètres régionaux en vigueur. | Object | ||
[override]
Renvoie une chaîne répertoriant toutes les propriétés de l’objet ProgressEvent. | ProgressEvent | ||
Renvoie la valeur primitive de l’objet spécifié. | Object |
Constante | Défini par | ||
---|---|---|---|
PROGRESS : String = "progress" [statique]
Définit la valeur de la propriété type d’un objet événement progress. | ProgressEvent | ||
SOCKET_DATA : String = "socketData" [statique]
Définit la valeur de la propriété type d’un objet événement socketData. | ProgressEvent | ||
STANDARD_ERROR_DATA : String = "standardErrorData" [statique]
Définit la valeur de la propriété type d’un objet d’événement standardErrorData. | ProgressEvent | ||
STANDARD_INPUT_PROGRESS : String = "standardInputProgress" [statique]
Définit la valeur de la propriété type d’un objet d’événement standardInputProgress. | ProgressEvent | ||
STANDARD_OUTPUT_DATA : String = "standardOutputData" [statique]
Définit la valeur de la propriété type d’un objet d’événement standardOutputData. | ProgressEvent |
bytesLoaded | propriété |
bytesLoaded:Number
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | AIR 1.0, Flash Player 9, Flash Lite 4 |
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
bytesTotal | propriété |
bytesTotal:Number
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | AIR 1.0, Flash Player 9, Flash Lite 4 |
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
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, Flash Lite 4 |
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ètrestype:String — Type de l’événement. Les valeurs possibles sont les suivantes :ProgressEvent.PROGRESS , ProgressEvent.SOCKET_DATA , ProgressEvent.STANDARD_ERROR_DATA , ProgressEvent.STANDARD_INPUT_PROGRESS et ProgressEvent.STANDARD_OUTPUT_DATA .
| |
bubbles:Boolean (default = false ) — Détermine si l’objet Event prend part à la phase de propagation vers le haut du flux d’événements.
| |
cancelable:Boolean (default = false ) — Détermine si l’objet d’événement 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.
|
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, Flash Lite 4 |
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éeEvent — 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, Flash Lite 4 |
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]
String — Chaîne répertoriant toutes les propriétés de l’objet ProgressEvent .
|
PROGRESS | Constante |
public static const PROGRESS:String = "progress"
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | AIR 1.0, Flash Player 9, Flash Lite 4 |
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. |
Eléments de l’API associés
SOCKET_DATA | Constante |
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, Flash Lite 4 |
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 | Socket indiquant la progression. |
Eléments de l’API associés
STANDARD_ERROR_DATA | Constante |
public static const STANDARD_ERROR_DATA:String = "standardErrorData"
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | AIR 2, Flash Lite 4 |
Définit la valeur de la propriété type
d’un objet d’événement standardErrorData
.
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’octets des données d’erreur mises en mémoire tampon par NativeProcessObject.error suite à cet événement. |
bytesTotal | 0 ; cette propriété n’est pas utilisée par les objets d’événement standardErrorData . |
target | Objet NativeProcess publiant les données d’erreur. |
Eléments de l’API associés
STANDARD_INPUT_PROGRESS | Constante |
public static const STANDARD_INPUT_PROGRESS:String = "standardInputProgress"
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | AIR 2, Flash Lite 4 |
Définit la valeur de la propriété type
d’un objet d’événement standardInputProgress
.
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’octets des données d’erreur mises en mémoire tampon par NativeProcessObject.error suite à cet événement. |
bytesTotal | 0 ; cette propriété n’est pas utilisée par les objets d’événement standardInputProgress . |
target | Objet NativeProcess publiant les données d’erreur. |
Eléments de l’API associés
STANDARD_OUTPUT_DATA | Constante |
public static const STANDARD_OUTPUT_DATA:String = "standardOutputData"
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | AIR 2, Flash Lite 4 |
Définit la valeur de la propriété type
d’un objet d’événement standardOutputData
.
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’octets des données de sortie mises en mémoire tampon via NativeProcessObject.output suite à cet événement. |
bytesTotal | 0 ; cette propriété n’est pas utilisée par les objets d’événement standardOutputData . |
target | Objet NativeProcess publiant les données de sortie. |
Eléments de l’API associés
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 :
- Les propriétés
downloadURL
etfileName
sont créées, et indiquent l’emplacement et le nom du fichier téléchargé. - Dans le constructeur
ProgressEventExample
, un nouvel objet FileReference nomméfile
est créé, puis transmis à la méthodeconfigureListeners()
. - Les propriétés
downloadURL
etfileName
sont ensuite transmises à la méthodefile.download()
, qui demande l’emplacement de téléchargement du fichier. - La méthode
configureListeners()
ajoute sept écouteurs d’événements et leurs méthodes d’abonnés associées :cancel
/cancelHandler()
est distribué si le téléchargement du fichier est annulé.complete
/complereHandler()
est distribué lorsque le téléchargement du fichier est terminé.ioError
/ioErrorHandler()
est distribué si le fichier téléchargé n’est pas disponible ou accessible.open
/openHandler()
est distribué lorsque l’opération de téléchargement démarre.progress
/progressHandler()
est distribué lorsque l’opération de téléchargement commence, puis lorsqu’elle se termine.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.select
/selectHandler()
est distribué lorsque l’objet de téléchargement est sélectionné.
Remarques :
- Vous devrez compiler le fichier SWF en définissant « Sécurité de lecture locale » sur « Accès au réseau uniquement ».
- Cet exemple requiert un fichier nommé SomeFile.pdf.
- Cet exemple couvre tous les événements disponibles pour l’objet FileReference. Cependant, la plupart des situations n’en nécessite qu’un sous-ensemble.
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); } } }
Tue Jun 12 2018, 09:30 AM Z