Paquete | flash.events |
Clase | public class ProgressEvent |
Herencia | ProgressEvent Event Object |
Subclases | ModuleEvent, ResourceEvent, RSLEvent, StyleEvent, VideoProgressEvent |
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | AIR 1.0, Flash Player 9, Flash Lite 4 |
ProgressEvent.PROGRESS
y ProgressEvent.SOCKET_DATA
. Además, en AIR los objetos ProgressEvent se distribuyen cuando se envían datos en un proceso secundario utilizando la clase NativeProcess.
Elementos de API relacionados
Propiedad | Definido por | ||
---|---|---|---|
bubbles : Boolean [solo lectura]
Indica si un evento es un evento de propagación. | Event | ||
bytesLoaded : Number
Número de elementos o bytes cargados cuando el detector procesa el evento. | ProgressEvent | ||
bytesTotal : Number
Número total de elementos o bytes que se cargarán si el proceso de carga se realiza correctamente. | ProgressEvent | ||
cancelable : Boolean [solo lectura]
Indica si se puede evitar el comportamiento asociado al evento. | Event | ||
constructor : Object
Una referencia a la clase de objeto o función constructora para una instancia de objeto determinada. | Object | ||
currentTarget : Object [solo lectura]
Objeto que procesa de forma activa el objeto de evento con un detector de eventos. | Event | ||
eventPhase : uint [solo lectura]
La fase actual en el flujo del evento. | Event | ||
target : Object [solo lectura]
El destino del evento. | Event | ||
type : String [solo lectura]
El tipo de evento. | Event |
Método | Definido por | ||
---|---|---|---|
ProgressEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, bytesLoaded:Number = 0, bytesTotal:Number = 0)
Crea un objeto de evento que contiene información sobre eventos de progreso. | ProgressEvent | ||
[override]
Crea una copia del objeto ProgressEvent y define el valor de cada propiedad para que coincida con el del objeto original. | ProgressEvent | ||
Una función de utilidad para implementar el método toString() en las clases Event personalizadas de ActionScript 3.0. | Event | ||
Indica si un objeto tiene definida una propiedad especificada. | Object | ||
Comprueba si se ha llamado a preventDefault() en el evento. | Event | ||
Indica si hay una instancia de la clase Object en la cadena de prototipo del objeto especificado como parámetro. | Object | ||
Cancela el comportamiento predeterminado de un evento si es posible cancelarlo. | Event | ||
Indica si existe la propiedad especificada y si es enumerable. | Object | ||
Establece la disponibilidad de una propiedad dinámica para operaciones de bucle. | Object | ||
Impide el proceso de cualquier detector de eventos en el nodo actual y los nodos siguientes en el flujo del evento. | Event | ||
Impide el proceso de cualquier detector de eventos en nodos siguientes al nodo actual. | Event | ||
Devuelve la representación de cadena de este objeto, con formato según las convenciones específicas de configuración regional. | Object | ||
[override]
Devuelve una cadena con todas las propiedades del objeto ProgressEvent. | ProgressEvent | ||
Devuelve el valor simple del objeto especificado. | Object |
Constante | Definido por | ||
---|---|---|---|
PROGRESS : String = "progress" [estática]
Define el valor de la propiedad type de un objeto de evento progress. | ProgressEvent | ||
SOCKET_DATA : String = "socketData" [estática]
Define el valor de la propiedad type para un objeto de evento socketData. | ProgressEvent | ||
STANDARD_ERROR_DATA : String = "standardErrorData" [estática]
Define el valor de la propiedad type para un objeto de evento standardErrorData. | ProgressEvent | ||
STANDARD_INPUT_PROGRESS : String = "standardInputProgress" [estática]
Define el valor de la propiedad type para un objeto de evento standardInputProgress. | ProgressEvent | ||
STANDARD_OUTPUT_DATA : String = "standardOutputData" [estática]
Define el valor de la propiedad type para un objeto de evento standardOutputData. | ProgressEvent |
bytesLoaded | propiedad |
bytesLoaded:Number
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | AIR 1.0, Flash Player 9, Flash Lite 4 |
Número de elementos o bytes cargados cuando el detector procesa el evento.
Implementación
public function get bytesLoaded():Number
public function set bytesLoaded(value:Number):void
bytesTotal | propiedad |
bytesTotal:Number
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | AIR 1.0, Flash Player 9, Flash Lite 4 |
Número total de elementos o bytes que se cargarán si el proceso de carga se realiza correctamente. Si el evento de progreso se distribuye/asocia a un objeto Socket, el valor de bytesTotal siempre es 0, a no ser que se especifique un valor en el parámetro bytesTotal del constructor. El número real de bytes enviados y recibidos no se define y depende del desarrollador de la aplicación.
Implementación
public function get bytesTotal():Number
public function set bytesTotal(value:Number):void
ProgressEvent | () | Información sobre |
public function ProgressEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, bytesLoaded:Number = 0, bytesTotal:Number = 0)
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | AIR 1.0, Flash Player 9, Flash Lite 4 |
Crea un objeto de evento que contiene información sobre eventos de progreso. Los objetos de evento se transfieren como parámetros a los detectores de eventos.
Parámetrostype:String — El tipo de evento. Los valores posibles son:ProgressEvent.PROGRESS , ProgressEvent.SOCKET_DATA , ProgressEvent.STANDARD_ERROR_DATA , ProgressEvent.STANDARD_INPUT_PROGRESS y ProgressEvent.STANDARD_OUTPUT_DATA .
| |
bubbles:Boolean (default = false ) — Determina si el objeto de evento participa en la fase de propagación del flujo del evento.
| |
cancelable:Boolean (default = false ) — Determina si se puede cancelar el objeto Event.
| |
bytesLoaded:Number (default = 0 ) — Número de elementos o bytes cargados en el momento en que el detector procesa el evento.
| |
bytesTotal:Number (default = 0 ) — Número total de elementos o bytes que se cargarán si el proceso de carga se realiza correctamente.
|
clone | () | método |
override public function clone():Event
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | AIR 1.0, Flash Player 9, Flash Lite 4 |
Crea una copia del objeto ProgressEvent y define el valor de cada propiedad para que coincida con el del objeto original.
Valor devueltoEvent — Un nuevo objeto ProgressEvent con valores de propiedades que coinciden con los del objeto original.
|
toString | () | método |
override public function toString():String
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | AIR 1.0, Flash Player 9, Flash Lite 4 |
Devuelve una cadena con todas las propiedades del objeto ProgressEvent. La cadena tiene el siguiente formato:
[ProgressEvent type=value bubbles=value cancelable=value bytesLoaded=value bytesTotal=value]
String — Una cadena que contiene todas las propiedades del objeto ProgressEvent .
|
PROGRESS | Constante |
public static const PROGRESS:String = "progress"
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | AIR 1.0, Flash Player 9, Flash Lite 4 |
Define el valor de la propiedad type
de un objeto de evento progress
.
Este evento tiene las propiedades siguientes:
Propiedad | Valor |
---|---|
bubbles | false |
bytesLoaded | Número de elementos o bytes cargados en el momento en que el detector procesa el evento. |
bytesTotal | Número total de elementos o bytes que se cargarán en última instancia si el proceso de carga se realiza correctamente. |
cancelable | false ; no hay ningún comportamiento predeterminado que cancelar. |
currentTarget | Objeto que procesa de forma activa el objeto de evento con un detector de eventos. |
target | El objeto que informa sobre el progreso. |
Elementos de API relacionados
SOCKET_DATA | Constante |
public static const SOCKET_DATA:String = "socketData"
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | AIR 1.0, Flash Player 9, Flash Lite 4 |
Define el valor de la propiedad type
de un objeto de evento socketData
.
Este evento tiene las propiedades siguientes:
Propiedad | Valor |
---|---|
bubbles | false |
cancelable | false ; no hay ningún comportamiento predeterminado que cancelar. |
currentTarget | El objeto que procesa de forma activa el objeto de evento. |
bytesLoaded | Número de elementos o bytes cargados en el momento en que el detector procesa el evento. |
bytesTotal | 0; los objetos de evento socketData no utilizan esta propiedad. |
target | El socket que informa sobre el progreso. |
Elementos de API relacionados
STANDARD_ERROR_DATA | Constante |
public static const STANDARD_ERROR_DATA:String = "standardErrorData"
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | AIR 2, Flash Lite 4 |
Define el valor de la propiedad type
de un objeto de evento standardErrorData
.
Este evento tiene las propiedades siguientes:
Propiedad | Valor |
---|---|
bubbles | false |
cancelable | false ; no hay ningún comportamiento predeterminado que cancelar. |
currentTarget | El objeto que procesa de forma activa el objeto de evento. |
bytesLoaded | El número de bytes de datos de error pasados por el búfer por NativeProcessObject.error debido a este evento. |
bytesTotal | 0; los objetos de evento standardErrorData no utilizan esta propiedad. |
target | El objeto NativeProcess que informa sonbre los datos de error. |
Elementos de API relacionados
STANDARD_INPUT_PROGRESS | Constante |
public static const STANDARD_INPUT_PROGRESS:String = "standardInputProgress"
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | AIR 2, Flash Lite 4 |
Define el valor de la propiedad type
de un objeto de evento standardInputProgress
.
Este evento tiene las propiedades siguientes:
Propiedad | Valor |
---|---|
bubbles | false |
cancelable | false ; no hay ningún comportamiento predeterminado que cancelar. |
currentTarget | El objeto que procesa de forma activa el objeto de evento. |
bytesLoaded | El número de bytes de datos de error pasados por el búfer por NativeProcessObject.error debido a este evento. |
bytesTotal | 0; los objetos de evento standardInputProgress no utilizan esta propiedad. |
target | El objeto NativeProcess que informa sonbre los datos de error. |
Elementos de API relacionados
STANDARD_OUTPUT_DATA | Constante |
public static const STANDARD_OUTPUT_DATA:String = "standardOutputData"
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | AIR 2, Flash Lite 4 |
Define el valor de la propiedad type
de un objeto de evento standardOutputData
.
Este evento tiene las propiedades siguientes:
Propiedad | Valor |
---|---|
bubbles | false |
cancelable | false ; no hay ningún comportamiento predeterminado que cancelar. |
currentTarget | El objeto que procesa de forma activa el objeto de evento. |
bytesLoaded | El número de bytes de datos de salida pasados por el búfer por NativeProcessObject.output debido a este evento. |
bytesTotal | 0; los objetos de evento standardOutputData no utilizan esta propiedad. |
target | El objeto NativeProcess que informa sonbre los datos de salida. |
Elementos de API relacionados
ProgressEventExample
para ilustrar cómo se usan distintos detectores de eventos cuando se está descargando un archivo. El ejemplo realiza las siguientes tareas:
- Se crean las propiedades
downloadURL
yfileName
, que indican la ubicación y el nombre del archivo descargado. - En el constructor
ProgressEventExample
, se crea un nuevo objeto FileReference llamadofile
y se transfiere al métodoconfigureListeners()
. - Las propiedades
downloadURL
yfileName
se transfieren al métodofile.download()
, que solicita la ubicación en la que descargar el archivo. - El método
configureListeners()
añade siete detectores de eventos con los siguientes métodos suscriptores asociados:cancel
/cancelHandler()
se distribuye si se cancela la descarga del archivo.complete
/complereHandler()
se distribuye si finaliza el proceso de descarga del archivo.ioError
/ioErrorHandler()
se distribuye si el archivo que se va a descargar no está disponible ni accesible.open
/openHandler()
se distribuye cuando se inicia la operación de descarga.progress
/progressHandler()
se distribuye cuando se inicia el proceso de descarga y también cuando finaliza.securityError
/securityErrorHandler
se distribuye si la configuración de seguridad local de reproducción no coincide con el tipo de datos de acceso del archivo descargado (local y de red); consulte las notas a continuación.select
/selectHandler()
se distribuye cuando se selecciona el objeto descargado.
Notas:
- Necesitará compilar el archivo SWF con la opción Seguridad de reproducción local establecida como Acceder sólo a archivos de red.
- Este ejemplo necesita un archivo llamado SomeFile.pdf.
- Aunque en este ejemplo se utilizan todos los eventos disponibles en el objeto FileReference, en la mayoría de los casos sólo se requiere un subconjunto.
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, 02:12 PM Z