Март 2011

Package { import flash. display.*; import flash. utils.*;

public class ButterflyGame extends Sprite { private var timer:Timer; private var butterfly:Butterfly;

public function ButterflyGame ( ) { // Игровой таймер timer = new Timer(25. 0); timer. start( ); addButterfly( );

}

// Добавляет бабочку в игру public function addButterfly ( ):void { butterfly = new Butterfly(timer);

// Удаляет бабочку из игры public function removeButterfly ( ):void { butterfly = null:

}

}

}

Для добавления бабочки в игру класс ButterflyGame использует следующий код: butterfly = new Butterfly(timer);

Этот код приведет к выполнению конструктора класса Butterfly, в результате чего метод timerListener ( ) класса Butterfly зарегистрируется в объекте gameTimer для получения событий TimerEvent. TIMER.

Когда игрок поймает бабочку, объект ButterflyGame удалит соответствующий объект Butterfly из программы, используя следующий код:

butterfly = null;

Однако, даже несмотря на то, что предыдущий код удаляет ссылку на объект Butte rfly из объекта ButterflyGame, в списке приемников объекта gameTimer продолжает храниться ссылка на метод timerListener ( ) объекта Butterfly и, соответственно, на сам объект Butterfly. Более того, метод timerListener ( ) продолжает выполняться каждый раз при возникновении события TimerEvent. TIMER. Таким образом, объект Butterfly продолжает потреблять память и процессорное время и способен вызвать неожиданные или нежелательные побочные эффекты в программе. Чтобы избежать подобных проблем, перед удалением объекта Butterfly из игры нужно сначала отменить регистрацию метода timerListener ( ) для событий TimerEvent. TIMER.

Добавим новую переменную gameTimer и новый метод destroy ( ) в класс Butterfly, чтобы облегчить процесс отмены регистрации приемника для события TimerEvent. TIMER. Основной игровой таймер присваивается переменной gameTimer. Метод destroy ( ) отменяет регистрацию метода timerListener ( ) для событий TimerEvent. TIMER. Рассмотрим код класса Butterfly с внесенными изменениями, которые выделены полужирным шрифтом:

package { import flash. display.*; import flash. events.*; import flash. utils.*;

public class Butterfly extends Sprite { private var gameTimer:Timer;

public function Butterfly (gameTimer:Timer) { this. gameTimer = gameTimer;

this. gameTi mer. addEventLi stener(Ti merEvent. TIMER. timerLi stener);

}

private function timerListener (e:TimerEvent):void { traceCCalculating new butterfly position…»);

// Вычисление нового местоположения бабочки (код не показан)

public function destroy ( ):void { gameTimer. removeEventListener(TimerEvent. TIMER, timerListener);

}

}

}

Перед тем как удалить ссылку на объект Butterfly, в методе экземпляра removeButterfly ( ) класса ButterflyGame мы вызываем метод destroy ( ), как показано в следующем коде:

public function removeButterfly ( ):void { butterfly. destroy( );

butterfly = null;

}

Вызывая метод destroy ( ) перед удалением объекта Butterfly из игры, мы не позволяем методу timerListener ( ) оказаться «заброшенным» в списке приемников объекта Timer.

1 Если вы регистрируете приемник события в каком-либо объекте, убедитесь, что ваша

мй’ J. программа с течением времени также отменяет регистрацию этого приемника.

Слабые ссылки на приемники событий. В предыдущем разделе было рассказано, что по умолчанию объект, регистрирующий приемник для определенного события, хранит ссылку на этот приемник до тех пор, пока его регистрация для указанного события не будет отменена явно, даже если в программе не остается других ссылок на этот приемник. Тем не менее это стандартное поведение можно изменить с помощью параметра использоватьСлабуюСсылку метода addEventListener ( ).

^ I Для изучения этого раздела требуется предварительное понимание механизма сборки??, 4 « мусора в языке ActionScript. Этот механизм рассматривается в гл. 14.

W:_

Регистрация приемника с использованием параметра использоватьСлабуюСсылку, для которого установлено значение true, не позволит этому приемнику оказаться «заброшенным» в списке приемников объекта, выполняющего регистрацию. Предположим, что объект (О) регистрирует приемник (П) для события (С) с использованием параметра использоватьСлабуюСсылку, для которого установлено значение true. Кроме того, предположим, что единственной ссылкой на П, которой обладает программа, является ссылка, хранящаяся в О. В обычной ситуации п будет храниться в О до тех пор, пока регистрация П для события С не будет отменена. Однако поскольку при регистрации П был использован параметр использоватьСлабуюСсылку со значением true и О хранит единственную оставшуюся ссылку на П в программе, П сразу же становится пригодным для сборки мусора. Впоследствии сборщик мусора по своему усмотрению может автоматически исключить П из списка приемников О и удалить его из памяти.

Для демонстрации работы параметра использоватьСлабуюСсылку вернемся к классу AnonymousListener. Как уже говорилось, класс AnonymousListener создает

анонимную функцию и регистрирует ее для событий MouseEvent. MOUSE_MOVE в экземпляре Stage клиентской среды выполнения Flash. Однако на этот раз при регистрации функции для событий MouseEvent. MOUSE_MOVE мы используем параметр использоватьСлабуюСсылку со значением true.

package { import Л ash. display.*; import flash. events.*;

public class AnonymousListener extends Sprite { public function AnonymousListener ( ) { // Добавляем анонимную функцию в список приемников экземпляра Stage stage. addEventListener(MouseEvent. M0USE_M0VE.

function (e:MouseEvent):void { trace(«mouse move»);

}.

False. 0.

true);

}

После выполнения предыдущего кода единственной ссылкой на анонимную функцию в программе является ссылка, хранящаяся в экземпляре Stage. Поскольку анонимная функция была зарегистрирована с использованием параметра использоватьСлабуюСсылку, для которого было установлено значение true, она сразу же становится пригодной для сборки мусора. Таким образом, сборщик мусора по своему усмотрению может впоследствии автоматически исключить анонимную функцию из списка приемников экземпляра Stage и удалить ее из памяти.

Безусловно, тот факт, что анонимная функция пригодна для сборки мусора, совершенно не означает, что она будет удалена из памяти. На самом деле в случае с предыдущим простым примером, функция, скорее всего, не будет удалена из памяти, поскольку объем используемой приложением памяти недостаточен для запуска механизма сборки мусора. В результате функция будет продолжать выполняться при получении события MouseEvent. MOUSE_MOVE экземпляром Stage, хотя теоретически она может быть удалена из памяти в любой момент времени. Из этого следует, что вообще не следует полагаться на параметр исполь — зоватьСлабуюСсылку как на способ автоматического удаления приемников событий. Наилучшее решение — просто избегать появления заброшенных приемников событий.

*^ | Если вы регистрируете приемник события в каком-либо объекте, убедитесь, что ваша м& d m программа с течением времени также отменяет регистрацию этого приемника.

До сих пор в этой главе мы работали исключительно с предопределенными событиями языка ActionScript. Теперь рассмотрим процесс создания в программе своих собственных пользовательских событий.

Пользовательские события

Чтобы выполнить диспетчеризацию нового пользовательского события в языке ActionScript, достаточно расширить класс EventDispatcher, присвоить новому событию имя и вызвать метод экземпляра dispatchEvent ( ) класса EventDispatcher. Для изучения процесса создания пользовательских событий в программе мы рассмотрим два примера: в первом событие создается для игры, а во втором — для элемента пользовательского интерфейса.

‘ * . I Если вы хотите сделать получателем события экземпляр класса, который уже рас-м$4г« ширяет другой класс, используйте композиционный подход, рассмотренный в гл. 9: Яу непосредственно реализуйте интерфейс IEventDispatcher и используйте методы класса EventDispatcher не через наследование, а через композицию.

Пользовательское событие «gameOver»

Предположим, что мы создаем универсальный каркас для разработки видеоигр. Каркас включает в себя следующие два класса: класс Game, выполняющий основные функции, необходимые для любой видеоигры, и класс Console, который представляет панель для запуска новых игр. Каждый раз при запуске новой игры класс Console создает объект класса Game. Любой экземпляр класса Game, создаваемый классом Console, является получателем пользовательского события «gameOver», которое возникает после окончания игры.

Чтобы объекты класса Game могли выступать в роли получателей событий, класс Game расширяет класс EventDispatcher, как показано в следующем коде:

package { import flash. events.*;

public class Game extends EventDispatcher { }

}

Кроме того, в классе Game определена константа Game. GAME_OVER, значением которой является имя пользовательского события: «gameOver». По соглашению имена констант событий записываются полностью прописными буквами, а слова разделяются знаком подчеркивания, например: GAME_OVER. Константы пользовательских событий обычно определяются либо в классе получателя события (в данном случае в классе Game), либо, если используется подкласс класса Event, в этом подклассе (как показано в нашем следующем примере с элементом пользовательского интерфейса). Поскольку в нашем текущем примере подклассы класса Event не используются, определим константу для события «gameOver» в классе Game, как показано в следующем коде:

package { import flash. events.*;

public class Game extends EventDispatcher { public static const GAME OVER:String = «gameOver»;

}

}

Когда игра завершается, объект Game вызывает метод endGame ( ), который возвращает игровую среду в исходное состояние, что позволит начать новую игру. Вот код метода endGame ( ):

package { import flash. events.*;

public class Game extends EventDispatcher { public static const GAME_0VER:String = «gameOver»;

private function endGame ( ):void { // Выполнение действий для завершения игры (код не показан)

}

}

}

Когда все действия, завершающие игру, выполнены, метод endGame ( ) использует метод dispatchEvent ( ), чтобы приступить к диспетчеризации события Game. GAME_OVER, сигнализирующего об окончании игры:

package { import flash. events.*;

public class Game extends EventDispatcher { public static const GAME_0VER:String = «gameOver»;

private function endGame ( ):void { // Выполнение действий для завершения игры // (код не показан)

// …после чего просим среду Flash выполнить

// диспетчеризацию события, обозначающего окончание игры

dispatchEvent(new Event(Game. GAME_OVER));

}

}

}

Обратите внимание, что, поскольку метод dispatchEvent ( ) вызывается над

объектом Game, этот объект и является получателем события.

_

I Объект, над которым вызывается метод dispatchEvent(), является получателем собы-| тия.

Метод dispatchEvent ( ), продемонстрированный в предыдущем коде, принимает один параметр — объект Event, предоставляющий событие для диспетчеризации. Сам конструктор класса Event принимает три параметра — тип, всплывающее и отменяемое, как показано в следующем обобщенном коде:

Event(тип, всплывающее, отменяемое)

Тем не менее в большинстве случаев требуется только первый аргумент — тип; он определяет строковое имя события (в нашем случае Game. GAME OVER). Параметр всплывающее используется только в тех случаях, когда получателем события является отображаемый объект; этот параметр обозначает присутствие (true) или отсутствие (false) всплывающей фазы в цепочке диспетчеризации событий (дополнительную информацию можно найти в разд. «Пользовательские события и цепочка диспетчеризации события» гл. 21). Параметр отменяемое применяется для создания пользовательских событий с избегаемым стандартным поведением (этот вопрос рассматривается далее в подразд. «Отмена стандартного поведения для пользовательских событий» разд. «Пользовательские события»).

Чтобы зарегистрировать приемник события для нашего пользовательского события Game. GAME OVER, как и при регистрации приемника для предопределенного события, используется метод addEventListener ( ). Предположим, что по окончании игры мы хотим, чтобы класс Console выводил окно, позволяющее пользователю вернуться к панели запуска или снова сыграть в выбранную игру. Определить момент окончания игры в классе Console позволит регистрация приемника для событий Game. GAME_OVER, как показано в следующем коде:

package { import flash. display.*; import flash. events.*;

public class Console extends Sprite {

// Конструктор

public function Console ( ) { var game:Game = new Game( );

game. addEventLi stener(Game. GAME_0VER. gameOverLi stener);

private function gameOverListener (e:Event):void { traceCThe game has ended!»);

// Отображает пользовательский интерфейс «back to console» // (код не показан)

}

Обратите внимание, что тип данных событийного объекта, передаваемого в метод gameOverListener ( ), соответствует типу данных событийного объекта, изначально передаваемого в метод dispatchEvent ( ) внутри метода экземпляра endGame ( ) класса Game (как показано в предыдущем коде).

___«j

При создании приемника для пользовательского события указывайте тип данных параметра приемника в соответствии с типом данных событийного объекта, изначально передаваемого в метод dispatchEvent().

В листинге 12.4 полностью показан код для нашего пользовательского события Game. GAME_OVER, который также содержит таймер, вызывающий метод

endGame ( ), имитируя окончание реальной игры (подробную информацию по классу Timer можно найти в справочнике по языку ActionScript корпорации Adobe).

Листинг 12.4. Пользовательское событие «gameOver»

// Класс Game (получатель события) package { import flash. events.*;

import flash. utils.*; // Требуется для класса Timer

public class Game extends EventDispatcher { public static const GAME_0VER:String = «gameOver»;

public function Game ( ) { // Завершает игру спустя одну секунду var timer:Timer = new TimerdOOO. 1); timer. addEventListener(TimerEvent. TIMER. timerListener); timer. start( );

// Вложенная функция, которая выполняется через одну секунду // после создания данного объекта function timerListener (e:TimerEvent):void { endGame( );

}

}

private function endGame ( ):void { // Выполнение действий для завершения игры (код не показан)

// …после чего просим среду Flash // выполнить диспетчеризацию события. // обозначающего окончание игры di spatchEvent(new Event(Game. GAME_0VER));

}

}

}

// Класс Console (регистрирует приемник для события) package {

import flash. display.*;

import flash. events.*;

public class Console extends Sprite { // Конструктор

public function Console ( ) { var game:Game = new Game( );

game. addEventListener(Game. GAME_0VER. gameOverListener);

}

private function gameOverListener (e:Event):void { traceCThe game has ended!»);

// Отображает пользовательский интерфейс «back to console» (код не показан)

}

}

}

Теперь рассмотрим другой пример, создающий событие для элемента пользовательского интерфейса.

Пользовательское событие «toggle»

Предположим, что мы создаем кнопку-переключатель, которая может быть использована в пользовательском интерфейсе. Она может принимать два положения — включения и выключения. Наша кнопка-переключатель представлена классом ToggleSwitch. Всякий раз, когда кнопка включается или выключается, мы инициируем диспетчеризацию пользовательского события с именем «toggle».

В предыдущем разделе событийный объект для нашего пользовательского события Game. GAME OVER представлял собой экземпляр внутреннего класса Event. На этот раз наше пользовательское событие будет представлено своим собственным классом Toggle Event. Этот класс выполняет две следующие функции:

? определяет константу для события toggle (ToggleEvent. TOGGLE);

? задает переменную i sOn, которая будет использоваться приемниками для определения состояния объекта получателя ToggleSwitch.

Далее представлен код класса ToggleEvent. Обратите внимание, что каждый пользовательский подкласс класса Event должен переопределять методы clone ( ) и toString ( ), предоставляя версии методов, которые учитывают все пользовательские переменные данного подкласса (например, isOn).

Код кнопки-переключателя в этом разделе демонстрирует исключительно реализацию события «toggle». Код, необходимый для создания интерактивности и добавления графики, опущен.

package { import flash. events.*;

// Класс, представляющий пользовательское событие «toggle» public class ToggleEvent extends Event {

// Константа для типа события «toggle»

public static const TOGGLE;String = «toggle»;

// Обозначает, включен или выключен переключатель public var isOn:Boolean;

// Конструктор

public function ToggleEvent (type:String.

Bubbles;Boolean = false.

cancel able:Boolean = false.

isOn:Boolean = false) { // Передаем параметры конструктора в конструктор суперкласса super(type. bubbles, cancelable);

// Запоминаем состояние переключателя, которое может быть использовано // в приемниках события ToggleEvent. TOGGLE this. isOn = isOn;

}

// Любой класс пользовательского события должен переопределить // метод clone( )

public override function clone( ):Event { return new ToggleEvent(type. bubbles, cancelable. isOn);

}

// Любой класс пользовательского события должен переопределить // метод toString( ). Обратите внимание, что «eventPhase» — это // переменная экземпляра, имеющая отношение к цепочке диспетчеризации // событий (гл. 21).

public override function toString( ):String { return formatToString(«ToggleEvent». «type», «bubbles».

«cancelable». «eventPhase». «isOn»);

}

}

}

Теперь перейдем к классу ToggleSwitch, который представляет кнопку-переключатель. Единственный метод toggle ( ) класса ToggleSwitch изменяет состояние кнопки-переключателя, а затем выполняет диспетчеризацию события ToggleEvent. TOGGLE, которое обозначает изменение состояния переключателя. Следующий код демонстрирует класс ToggleSwitch. Обратите внимание, что класс ToggleSwitch расширяет класс Sprite, предоставляющий возможности для отображения объекта на экране. Кроме того, класс Sprite, являясь потомком класса EventDispatcher, предоставляет необходимую функциональность для диспетчеризации событий:

package { import flash. display.*; import flash. events.*;

// Представляет простой элемент-переключатель public class ToggleSwitch extends Sprite {

// Запоминает состояние переключателя

private var isOn:Boolean;

// Конструктор

public function ToggleSwitch ( ) { // По умолчанию переключатель выключен isOn = false;

}

// Включает переключатель, если он был выключен, или // выключает его

public function toggle ( ):void { // Изменяет состояние переключателя isOn = MsOn;

// просим среду Flash выполнить диспетчеризацию // события ToggleEvent. TOGGLE, получателем которого // является данный объект ToggleSwitch dispatchEvent(new ToggleEvent(ToggleEvent. TOGGLE,

true.

False.

isOn));

}

}

}

Чтобы продемонстрировать использование события ToggleEvent. TOGGLE, создадим простой класс SomeApp. Этот класс определяет метод toggleListener ( ) и регистрирует его в объекте ToggleSwitch для событий ToggleEvent. TOGGLE. Кроме того, для демонстрационных целей класс SomeApp программным путем включает переключатель, вызывая событие ToggleEvent. TOGGLE.

package { import flash. display.*;

// Простое приложение, демонстрирующее применение // пользовательского события ToggleEvent. TOGGLE public class SomeApp extends Sprite { // Конструктор

public function SomeApp ( ) { // Создание объекта ToggleSwitch var toggleSwitch:ToggleSwitch = new ToggleSwitch( ); // Регистрация приемника для событий ToggleEvent. TOGGLE toggleSwi tch. addEventLi stener(ToggleEvent. TOGGLE.

toggleListener);

// Изменяем состояние переключателя (обычно состояние // изменяется пользователем, но для демонстрационных целей // мы изменяем состояние программным путем) toggleSwitch. toggle( );

}

// Приемник выполняется каждый раз при возникновении события // ToggleEvent. TOGGLE

private function toggleListener (e:ToggleEvent):void { if (e. isOn) {

traceCThe ToggleSwitch is now on.»); } else {

trace(«The ToggleSwitch is now off.»);

}

}

}

}

Теперь, когда мы приобрели опыт создания пользовательских событий, рассмотрим более сложный сценарий: пользовательское событие со стандартным поведением.

Отмена стандартного поведения для пользовательских событий

В предыдущем разделе рассказывалось, что некоторые предопределенные события характеризуются стандартным поведением. Например, стандартное поведение события TextEvent. TEXT INPUT заключается в добавлении текста в текстовое поле. Мы также знаем, что для предопределенных событий, которые относятся к категории отменяемых, избежать стандартного поведения можно с помощью метода экземпляра preventDefault ( ) класса Event.

Кроме того, пользовательские события могут характеризоваться определенным стандартным поведением, избежать которого можно также с помощью метода preventDefault ( ). Стандартное поведение пользовательского события полностью определяется и реализуется в программе. Общий подход, применяемый для создания событий с отменяемым стандартным поведением, заключается в следующем.

1. На этапе диспетчеризации события создать событийный объект, представляющий событие, передав в качестве параметра отменяемое конструктора класса Event значение true.

2. Использовать метод dispatchEvent ( ) для диспетчеризации события.

3. После завершения метода dispatchEvent ( ) использовать метод экземпляра isDef aultPrevented ( ) класса Event, чтобы определить, запрашивали ли приемники отмену стандартного поведения.

4. Если метод is Default Prevented ( ) событийного объекта вернет значение false, продолжать выполнение действий, относящихся к стандартному поведению; в противном случае не выполнять действий, относящихся к стандартному поведению.

Рассмотрим обобщенный код для создания события с отменяемым стандартным поведением:

// Создание событийного объекта с произвольными значениями для параметров // тип и всплывающее. Для параметра отменяемое (третий параметр) указывается // значение true.

var e:Event = new Event(7″*f/7. всплывающее, true);

// Диспетчеризация события dispatchEvent(e);

// Проверить, запрашивали ли приемники отмену стандартного поведения.

// Если приемники не вызывали метод preventDefault( )____

if (!e. isDefaultPrevented( )) {

// …выполняем действия, относящиеся к стандартному поведению } .