| Пакет | flash.events |
| Класс | public class ProgressEvent |
| Наследование | ProgressEvent Event Object |
| Подклассы | ModuleEvent, ResourceEvent, RSLEvent, StyleEvent, VideoProgressEvent |
| Язык версии: | ActionScript 3.0 |
| Версии среды выполнения: | AIR 1.0, Flash Player 9, Flash Lite 4 |
ProgressEvent.PROGRESS и ProgressEvent.SOCKET_DATA. Кроме того, в среде AIR объекты ProgressEvent отправляются, когда данные передаются или получаются дочерним процессом с помощью класса NativeProcess.
Связанные элементы API
| Свойство | Определено | ||
|---|---|---|---|
![]() | bubbles : Boolean [только для чтения]
Определяет, является ли событие событием восходящей цепочки. | Event | |
| bytesLoaded : Number
Число элементов или байтов, загруженных на момент обработки события прослушивателем. | ProgressEvent | ||
| bytesTotal : Number
Общее число элементов или байтов, которые будут получены в случае успешного завершения загрузки. | ProgressEvent | ||
![]() | cancelable : Boolean [только для чтения]
Указывает, можно ли предотвратить поведение, связанное с событием. | Event | |
![]() | constructor : Object
Ссылка на объект класса или функцию конструктора для данного экземпляра объекта. | Object | |
![]() | currentTarget : Object [только для чтения]
Объект, активно обрабатывающий объект Event с помощью прослушивателя событий. | Event | |
![]() | eventPhase : uint [только для чтения]
Текущая фаза в потоке событий. | Event | |
![]() | target : Object [только для чтения]
Целевой объект события. | Event | |
![]() | type : String [только для чтения]
Тип события. | Event | |
| Метод | Определено | ||
|---|---|---|---|
ProgressEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, bytesLoaded:Number = 0, bytesTotal:Number = 0)
Создает объект Event, содержащий данные о событиях в ходе работы. | ProgressEvent | ||
[переопределить]
Создает копию объекта ProgressEvent и задает значение каждого свойства, совпадающее с оригиналом. | ProgressEvent | ||
![]() |
Служебная функция для реализации метода toString() в пользовательских классах ActionScript 3.0 Event. | Event | |
![]() |
Показывает, определено ли заданное свойство для объекта. | Object | |
![]() |
Проверяет, выполнялся ли для события вызова метода preventDefault(). | Event | |
![]() |
Показывает, есть ли экземпляр класса Object в цепи прототипов объекта, заданного в качестве параметра. | Object | |
![]() |
Отменяет поведение по умолчанию для события, если такое поведение можно отменить. | Event | |
![]() |
Показывает наличие заданного свойства и его перечисляемость. | Object | |
![]() |
Задает доступность динамического свойства для операций цикла. | Object | |
![]() |
Отменяет обработку прослушивателей событий в текущем узле, а также во всех узлах, которые следуют в потоке событий за текущим узлом. | Event | |
![]() |
Отменяет обработку прослушивателей событий в узлах, которые следуют в потоке событий за текущим узлом. | Event | |
![]() |
Возвращает строковое представление этого объекта, отформатированного в соответствии со стандартами, принятыми для данной локали. | Object | |
[переопределить]
Возвращает строку, содержащую все свойства объекта ProgressEvent. | ProgressEvent | ||
![]() |
Возвращает элементарное значение заданного объекта. | Object | |
| Константа | Определено | ||
|---|---|---|---|
| PROGRESS : String = "progress" [статические]
Задает значение свойства type для объекта события progress. | ProgressEvent | ||
| SOCKET_DATA : String = "socketData" [статические]
Задает значение свойства type для объекта события socketData. | ProgressEvent | ||
| STANDARD_ERROR_DATA : String = "standardErrorData" [статические]
Задает значение свойства type для объекта события standardErrorData. | ProgressEvent | ||
| STANDARD_INPUT_PROGRESS : String = "standardInputProgress" [статические]
Задает значение свойства type для объекта события standardInputProgress. | ProgressEvent | ||
| STANDARD_OUTPUT_DATA : String = "standardOutputData" [статические]
Задает значение свойства type для объекта события standardOutputData. | ProgressEvent | ||
bytesLoaded | свойство |
bytesTotal | свойство |
bytesTotal:Number| Язык версии: | ActionScript 3.0 |
| Версии среды выполнения: | AIR 1.0, Flash Player 9, Flash Lite 4 |
Общее число элементов или байтов, которые будут получены в случае успешного завершения загрузки. Если событие прогресса отправляется/присоединяется к объекту Socket, свойство bytesTotal будет всегда иметь значение 0, если значение не задано в параметре bytesTotal конструктора. Фактическое число байт, отправляемых в обоих направлениях, не задано и определяется разработчиком приложения.
Реализация
public function get bytesTotal():Number public function set bytesTotal(value:Number):voidProgressEvent | () | Конструктор |
public function ProgressEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, bytesLoaded:Number = 0, bytesTotal:Number = 0)| Язык версии: | ActionScript 3.0 |
| Версии среды выполнения: | AIR 1.0, Flash Player 9, Flash Lite 4 |
Создает объект Event, содержащий данные о событиях в ходе работы. Объекты Event передаются прослушивателям событий в качестве параметров.
Параметрыtype:String — Тип события. Возможные значения: ProgressEvent.PROGRESS, ProgressEvent.SOCKET_DATA, ProgressEvent.STANDARD_ERROR_DATA, ProgressEvent.STANDARD_INPUT_PROGRESS и ProgressEvent.STANDARD_OUTPUT_DATA.
| |
bubbles:Boolean (default = false) — Определяет, участвует ли объект Event в фазе восходящей цепочки потока событий.
| |
cancelable:Boolean (default = false) — Определяет, можно ли отменить объект Event.
| |
bytesLoaded:Number (default = 0) — Число элементов или байтов, загруженных на момент обработки события прослушивателем.
| |
bytesTotal:Number (default = 0) — Общее число элементов или байтов, которые будут получены в случае успешного завершения загрузки.
|
clone | () | метод |
override public function clone():Event| Язык версии: | ActionScript 3.0 |
| Версии среды выполнения: | AIR 1.0, Flash Player 9, Flash Lite 4 |
Создает копию объекта ProgressEvent и задает значение каждого свойства, совпадающее с оригиналом.
ВозвращаетEvent — Новый объект ProgressEvent, значения свойств которого соответствуют значениям оригинала.
|
toString | () | метод |
override public function toString():String| Язык версии: | ActionScript 3.0 |
| Версии среды выполнения: | AIR 1.0, Flash Player 9, Flash Lite 4 |
Возвращает строку, содержащую все свойства объекта ProgressEvent. Строка имеет следующий формат:
[ProgressEvent type=value bubbles=value cancelable=value bytesLoaded=value bytesTotal=value]
String — Строка, содержащая все свойства объекта ProgressEvent.
|
PROGRESS | Константа |
public static const PROGRESS:String = "progress"| Язык версии: | ActionScript 3.0 |
| Версии среды выполнения: | AIR 1.0, Flash Player 9, Flash Lite 4 |
Задает значение свойства type для объекта события progress.
Это событие имеет следующие свойства:
| Свойство | Значение |
|---|---|
bubbles | false |
bytesLoaded | Число элементов или байтов, загруженных на момент обработки события прослушивателем. |
bytesTotal | Общее число элементов или байтов, которые в итоге будут получены в случае успешного завершения загрузки. |
cancelable | false; поведение по умолчанию, подлежащее отмене, не определено. |
currentTarget | Объект, активно обрабатывающий объект Event с помощью прослушивателя событий. |
target | Объект, сообщающий сведения о прогрессе. |
Связанные элементы API
SOCKET_DATA | Константа |
public static const SOCKET_DATA:String = "socketData"| Язык версии: | ActionScript 3.0 |
| Версии среды выполнения: | AIR 1.0, Flash Player 9, Flash Lite 4 |
Задает значение свойства type для объекта события socketData.
Это событие имеет следующие свойства:
| Свойство | Значение |
|---|---|
bubbles | false |
cancelable | false; поведение по умолчанию, подлежащее отмене, не определено. |
currentTarget | Объект, активно обрабатывающий событие. |
bytesLoaded | Число элементов или байтов, загруженных на момент обработки события прослушивателем. |
bytesTotal | 0; это свойство не используется объектами события socketData. |
target | Сокет, сообщающий сведения о прогрессе. |
Связанные элементы API
STANDARD_ERROR_DATA | Константа |
public static const STANDARD_ERROR_DATA:String = "standardErrorData"| Язык версии: | ActionScript 3.0 |
| Версии среды выполнения: | AIR 2, Flash Lite 4 |
Задает значение свойства type для объекта события standardErrorData.
Это событие имеет следующие свойства:
| Свойство | Значение |
|---|---|
bubbles | false |
cancelable | false; поведение по умолчанию, подлежащее отмене, не определено. |
currentTarget | Объект, активно обрабатывающий событие. |
bytesLoaded | Число байт данных ошибок, сохраненных в буфере объектом NativeProcessObject.error в результате этого события. |
bytesTotal | 0; это свойство не используется объектами события standardErrorData. |
target | Объект NativeProcess, сообщающий данные об ошибке. |
Связанные элементы API
STANDARD_INPUT_PROGRESS | Константа |
public static const STANDARD_INPUT_PROGRESS:String = "standardInputProgress"| Язык версии: | ActionScript 3.0 |
| Версии среды выполнения: | AIR 2, Flash Lite 4 |
Задает значение свойства type для объекта события standardInputProgress.
Это событие имеет следующие свойства:
| Свойство | Значение |
|---|---|
bubbles | false |
cancelable | false; поведение по умолчанию, подлежащее отмене, не определено. |
currentTarget | Объект, активно обрабатывающий событие. |
bytesLoaded | Число байт данных ошибок, сохраненных в буфере объектом NativeProcessObject.error в результате этого события. |
bytesTotal | 0; это свойство не используется объектами события standardInputProgress. |
target | Объект NativeProcess, сообщающий данные об ошибке. |
Связанные элементы API
STANDARD_OUTPUT_DATA | Константа |
public static const STANDARD_OUTPUT_DATA:String = "standardOutputData"| Язык версии: | ActionScript 3.0 |
| Версии среды выполнения: | AIR 2, Flash Lite 4 |
Задает значение свойства type для объекта события standardOutputData.
Это событие имеет следующие свойства:
| Свойство | Значение |
|---|---|
bubbles | false |
cancelable | false; поведение по умолчанию, подлежащее отмене, не определено. |
currentTarget | Объект, активно обрабатывающий событие. |
bytesLoaded | Число байт данных вывода, сохраненных в буфере объектом NativeProcessObject.output в результате этого события. |
bytesTotal | 0; это свойство не используется объектами события standardOutputData. |
target | Объект NativeProcess, сообщающий данные вывода. |
Связанные элементы API
ProgressEventExample, чтобы продемонстрировать использование различных прослушивателей событий при загрузке файла. Для этого выполняются следующие задачи:
- Создаются свойства
downloadURLиfileName, указывающие местоположение и имя загружаемого файла. - В конструкторе
ProgressEventExampleсоздается новый объект FileReference с именемfileи передается методуconfigureListeners(). - Затем свойства
downloadURLиfileNameпередаются методуfile.download(), который указывает местоположение для загрузки файла. - Метод
configureListeners()добавляет семь прослушивателей событий со связанными методами подписчиков:cancel/cancelHandler()отправляется в случае отмены загрузки;complete/complereHandler()отправляется по окончании загрузки файла;ioError/ioErrorHandler()отправляется, если загружаемый файл недоступен.open/openHandler()отправляется после начала операции загрузки;progress/progressHandler()отправляется два раза: когда процесс загрузки начинается и когда заканчивается;securityError/securityErrorHandlerотправляется, если параметр безопасности локального воспроизведения не соответствует типу доступа к данным для загружаемого файла (локальный/сетевой); см. примечания ниже;select/selectHandler()отправляется, когда выбирается загружаемый файл.
Примечания.
- SWF-файл требуется откомпилировать с установленным для параметра «Безопасность локального воспроизведения» режимом «Доступ только к сетевым файлам».
- Для реализации данного примера требуется файл с именем SomeFile.pdf.
- Хотя в этом примере используются все события, доступные для объекта FileReference, в большинстве случаев требуется только та или иная подгруппа..
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, 11:34 AM Z
Скрыть унаследованные общедоступные свойства
Показать унаследованные общедоступные свойства