Главная / Action Script 3
Пакетflash.events
Классpublic class ProgressEvent
НаследованиеProgressEvent Inheritance Event Inheritance Object
Подклассы VideoProgressEvent

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Flash® Player отправляет объекты ProgressEvent после начала операции загрузки или получения данных сокетом. Эти события обычно генерируются, когда SWF-файлы, изображения или данные загружаются в проигрыватель Flash Player. Существует два типа событий прогресса: ProgressEvent.PROGRESS и ProgressEvent.SOCKET_DATA.

Посмотреть примеры

См. также

Класс LoaderInfo
Класс Socket


Общедоступные свойства
 СвойствоОпределено
 Inheritedbubbles : Boolean
[только для чтения] Определяет, является ли событие "событием на цепочке".
Event
  bytesLoaded : uint
Число элементов или байт, загруженных на момент обработки события прослушивателем.
ProgressEvent
  bytesTotal : uint
Общее число элементов или байт, которые будут получены в случае успешного завершения загрузки.
ProgressEvent
 Inheritedcancelable : Boolean
[только для чтения] Определяет, можно ли отключить поведение, связанное с событием.
Event
 Inheritedconstructor : Object
Ссылка на объект класса или функцию конструктора для данного экземпляра объекта.
Object
 InheritedcurrentTarget : Object
[только для чтения] Объект, активно обрабатывающий объект Event с помощью прослушивателя событий.
Event
 InheritedeventPhase : uint
[только для чтения] Текущая фаза в потоке событий.
Event
 Inheritedprototype : Object
[статические] Ссылка на модель объекта класса или функции.
Object
 Inheritedtarget : Object
[только для чтения] Целевой объект события.
Event
 Inheritedtype : String
[только для чтения] Тип события.
Event
Общедоступные методы
 МетодОпределено
  
ProgressEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, bytesLoaded:uint = 0, bytesTotal:uint = 0)
Создает объект Event, содержащий данные о событиях в ходе работы.
ProgressEvent
  
Создает копию объекта ProgressEvent и задает значение каждого свойства, совпадающее с оригиналом.
ProgressEvent
 Inherited
formatToString(className:String, ... arguments):String
Служебная функция для реализации метода toString() в пользовательских классах ActionScript 3.0 Event.
Event
 Inherited
Показывает, определено ли заданное свойство для объекта.
Object
 Inherited
Проверяет, выполнялся ли для события вызова метода preventDefault().
Event
 Inherited
Показывает, есть ли экземпляр класса Object в цепи прототипов объекта, заданного в качестве параметра.
Object
 Inherited
Отменяет поведение по умолчанию для события, если такое поведение можно отменить.
Event
 Inherited
Показывает наличие заданного свойства и его перечисляемость.
Object
 Inherited
Задает доступность динамического свойства для операций цикла.
Object
 Inherited
Отменяет обработку прослушивателей событий в текущем узле, а также во всех узлах, которые следуют в потоке событий за текущим узлом.
Event
 Inherited
Отменяет обработку прослушивателей событий в узлах, которые следуют в потоке событий за текущим узлом.
Event
  
Возвращает строку, содержащую все свойства объекта ProgressEvent.
ProgressEvent
 Inherited
Возвращает элементарное значение заданного объекта.
Object
Общедоступные константы
 Константа Определено
 InheritedACTIVATE : String = "activate"
[статические] Константа Event.ACTIVATE определяет значение свойства type объекта события Activitate.
Event
 InheritedADDED : String = "added"
[статические] Константа Event.ADDED определяет значение свойства type добавленного объекта события.
Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[статические] Константа Event.ADDED_TO_STAGE определяет значение свойства type объекта события addedToStage.
Event
 InheritedCANCEL : String = "cancel"
[статические] Константа Event.CANCEL определяет значение свойства type объекта события cancel.
Event
 InheritedCHANGE : String = "change"
[статические] Константа Event.CHANGE определяет значение свойства type объекта события change.
Event
 InheritedCLEAR : String = "clear"
[статические] Задает значение свойства type для объекта события clear.
Event
 InheritedCLOSE : String = "close"
[статические] Константа Event.CLOSE определяет значение свойства type объекта события close.
Event
 InheritedAIR-only CLOSING : String = "closing"
[статические] Константа Event.CLOSING определяет значение свойства type объекта события closing.
Event
 InheritedCOMPLETE : String = "complete"
[статические] Константа Event.COMPLETE определяет значение свойства type объекта события complete.
Event
 InheritedCONNECT : String = "connect"
[статические] Константа Event.CONNECT определяет значение свойства type объекта события connect.
Event
 InheritedCOPY : String = "copy"
[статические] Задает значение свойства type для объекта события copy.
Event
 InheritedCUT : String = "cut"
[статические] Задает значение свойства type для объекта события cut.
Event
 InheritedDEACTIVATE : String = "deactivate"
[статические] Константа Event.DEACTIVATE определяет значение свойства type объекта события deactivate.
Event
 InheritedDISPLAYING : String = "displaying"
[статические] Задает значение свойства type для объекта события displaying.
Event
 InheritedENTER_FRAME : String = "enterFrame"
[статические] Константа Event.ENTER_FRAME определяет значение свойства type объекта события enterFrame.
Event
 InheritedEXIT_FRAME : String = "exitFrame"
[статические] Определяет значение свойства type объекта exitFrame.
Event
 InheritedAIR-only EXITING : String = "exiting"
[статические] Константа Event.EXITING определяет значение свойства type объекта exiting.
Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[статические] Задает значение свойства type для объекта события frameConstructed.
Event
 InheritedFULLSCREEN : String = "fullScreen"
[статические] Константа Event.FULL_SCREEN определяет значение свойства type для объекта события fullScreen.
Event
 InheritedAIR-only HTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[статические] Константа Event.HTML_BOUNDS_CHANGE определяет значение свойства type объекта htmlBoundsChange.
Event
 InheritedAIR-only HTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[статические] Константа Event.HTML_DOM_INITIALIZE определяет значение свойства type объекта события htmlDOMInitialize.
Event
 InheritedAIR-only HTML_RENDER : String = "htmlRender"
[статические] Константа Event.HTML_RENDER определяет значение свойства type объекта события htmlRender.
Event
 InheritedID3 : String = "id3"
[статические] Константа Event.ID3 определяет значение свойства type объекта id3.
Event
 InheritedINIT : String = "init"
[статические] Константа Event.INIT определяет значение свойства type объекта init.
Event
 InheritedAIR-only LOCATION_CHANGE : String = "locationChange"
[статические] Константа Event.LOCATION_CHANGE определяет значение свойства type объекта события locationChange.
Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[статические] Константа Event.MOUSE_LEAVE определяет значение свойства type объекта события mouseLeave.
Event
 InheritedAIR-only NETWORK_CHANGE : String = "networkChange"
[статические] Константа Event.NETWORK_CHANGE определяет значение свойства type объекта события networkChange.
Event
 InheritedOPEN : String = "open"
[статические] Константа Event.OPEN определяет значение свойства type объекта open.
Event
 InheritedPASTE : String = "paste"
[статические] Задает значение свойства type для объекта события paste.
Event
  PROGRESS : String = "progress"
[статические] Задает значение свойства type для объекта события Progress.
ProgressEvent
 InheritedREMOVED : String = "removed"
[статические] Константа Event.REMOVED определяет значение свойства type объекта события removed.
Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[статические] Константа REMOVED_FROM_STAGE определяет значение свойства type объекта события removedFromStage.
Event
 InheritedRENDER : String = "render"
[статические] Константа Event.RENDER определяет значение свойства type объекта события render.
Event
 InheritedRESIZE : String = "resize"
[статические] Константа Event.RESIZE определяет значение свойства type объекта события resize.
Event
 InheritedSCROLL : String = "scroll"
[статические] Константа Event.SCROLL определяет значение свойства type объекта события scroll.
Event
 InheritedSELECT : String = "select"
[статические] Константа Event.SELECT определяет значение свойства type объекта события select.
Event
 InheritedSELECT_ALL : String = "selectAll"
[статические] Задает значение свойства type для объекта события selectAll.
Event
  SOCKET_DATA : String = "socketData"
[статические] Задает значение свойства type для объекта события socketData.
ProgressEvent
 InheritedSOUND_COMPLETE : String = "soundComplete"
[статические] Константа Event.SOUND_COMPLETE определяет значение свойства type объекта события soundComplete.
Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[статические] Константа Event.TAB_CHILDREN_CHANGE определяет значение свойства type объекта события tabChildrenChange.
Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[статические] Константа Event.TAB_ENABLED_CHANGE определяет значение свойства type объекта события tabEnabledChange.
Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[статические] Константа Event.TAB_INDEX_CHANGE определяет значение свойства type объекта события tabIndexChange.
Event
 InheritedUNLOAD : String = "unload"
[статические] Константа Event.UNLOAD определяет значение свойства type объекта unload.
Event
 InheritedAIR-only USER_IDLE : String = "userIdle"
[статические] Константа Event.USER_IDLE определяет значение свойства type объекта события userIdle.
Event
 InheritedAIR-only USER_PRESENT : String = "userPresent"
[статические] Константа Event.USER_PRESENT определяет значение свойства type объекта события userPresent.
Event
Сведения о свойстве
bytesLoadedсвойство
bytesLoaded:uint  [чтение и запись]

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Число элементов или байт, загруженных на момент обработки события прослушивателем.



Реализация
    public function get bytesLoaded():uint
    public function set bytesLoaded(value:uint):void
bytesTotalсвойство 
bytesTotal:uint  [чтение и запись]

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Общее число элементов или байт, которые будут получены в случае успешного завершения загрузки. Если событие прогресса отправляется/присоединяется к объекту Socket, свойство bytesTotal будет всегда иметь значение 0, если значение не задано в параметре bytesTotal конструктора. Фактическое число байт, отправляемых в обоих направлениях, не задано и определяется разработчиком приложения.



Реализация
    public function get bytesTotal():uint
    public function set bytesTotal(value:uint):void
Сведения о конструкторе
ProgressEvent()Конструктор
public function ProgressEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, bytesLoaded:uint = 0, bytesTotal:uint = 0)

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Создает объект Event, содержащий данные о событиях в ходе работы. Объекты Event передаются прослушивателям событий в качестве параметров.

Параметры
type:String — Тип события. Допустимые значения:ProgressEvent.PROGRESS и ProgressEvent.SOCKET_DATA.
 
bubbles:Boolean (default = false) — Определяет, участвует ли объект Event на этапе восходящей цепочки процесса события.
 
cancelable:Boolean (default = false) — Определяет, можно ли отменить объект Event.
 
bytesLoaded:uint (default = 0) — Число элементов или байт, загруженных на момент обработки события прослушивателем.
 
bytesTotal:uint (default = 0) — Общее число элементов или байт, которые будут получены в случае успешного завершения загрузки.
Сведения о методе
clone()метод
override public function clone():Event

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Создает копию объекта ProgressEvent и задает значение каждого свойства, совпадающее с оригиналом.

Возвращает
Event — Новый объект ProgressEvent, значения свойств которого соответствуют значениям оригинала.
toString()метод 
override public function toString():String

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Возвращает строку, содержащую все свойства объекта ProgressEvent. Строка имеет следующий формат:

[ProgressEvent type=значение bubbles=значение cancelable=значение bytesLoaded=значение bytesTotal=значение]

Возвращает
String — Строка, содержащая все свойства объекта ProgressEvent.
Сведения о константе
PROGRESSКонстанта
public static const PROGRESS:String = "progress"

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Задает значение свойства type для объекта события progress.

Данное событие имеет следующие свойства.

СвойствоЗначение
bubblesfalse
bytesLoadedЧисло элементов или байт, загруженных на момент обработки события прослушивателем.
bytesTotalОбщее число элементов или байт, которые в итоге будут получены в случае успешного завершения загрузки.
cancelablefalse; нет поведения по умолчанию для отмены.
currentTargetОбъект, активно обрабатывающий объект Event с помощью прослушивателя событий.
targetСетевой объект, сообщающий сведения о прогрессе.

См. также

SOCKET_DATAКонстанта  
public static const SOCKET_DATA:String = "socketData"

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Задает значение свойства type для объекта события socketData.

Данное событие имеет следующие свойства.

СвойствоЗначение
bubblesfalse
cancelablefalse; нет поведения по умолчанию для отмены.
currentTargetОбъект, активно обрабатывающий событие.
bytesLoadedЧисло элементов или байт, загруженных на момент обработки события прослушивателем.
bytesTotal0; это свойство не используется объектами события socketData.
targetОбъект Socket, сообщающий сведения о прогрессе.

См. также

Примеры Как пользоваться примерами
ProgressEventExample.as

В следующем примере используется класс ProgressEventExample, чтобы продемонстрировать использование различных прослушивателей событий при загрузке файла. Этот код выполняет следующие задачи.
  1. Создаются свойства downloadURL и fileName, указывающие местоположение и имя загружаемого файла.
  2. В конструкторе ProgressEventExample создается новый объект FileReference с именем file и передается методу configureListeners().
  3. Затем свойства downloadURL и fileName передаются методу file.download(), который указывает местоположение для загрузки файла.
  4. Метод configureListeners() добавляет семь прослушивателей событий со связанными методами подписчиков:

Примечания.


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