Packageru.antkarlov.anthill.signals
Classpublic class AntSignal
InheritanceAntSignal Inheritance Object
Subclasses AntDeluxeSignal

Language Version : ActionScript 3
Since : 25.02.2013
Runtime Versions : AIR 1.0, Flash Player 9.0.0

Сигнал используется для отправки сообщений с аргументам для произвольного количество подписанных слушателей.

Вдохновлено C# событиями и делегатами, а так же signals and slots in Qt.



Public Properties
 PropertyDefined By
  numListeners : uint
[read-only] Возвращает количество слушателей подписавшихся на сигнал.
AntSignal
  strict : Boolean
Определяет необходимость строгого типа данных.
AntSignal
  valueClasses : Array
Опциональный список классов для определения типов параметров которые будут отправлятся слушателям.
AntSignal
Protected Properties
 PropertyDefined By
  _bindings : AntSignalBindingList
Список связей.
AntSignal
  _valueClasses : Array
Список типов данных с которыми будет проводится сверка отправляемых аргументов в строгом режиме соответствия.
AntSignal
Public Methods
 MethodDefined By
  
AntSignal(... aValueClasses)
AntSignal
  
add(aListener:Function):AntSignalBinding
Подписывает слушателя на сигнал.
AntSignal
  
addInstant(aListener:Function):AntSignalBinding
Подписывает одноразовый слушатель на сигнал.
AntSignal
  
clear():void
Отписывает всех слушателей от сигнала.
AntSignal
  
destroy():void
Осовобождает используемые ресурсы.
AntSignal
  
dispatch(... aValueObjects):void
Отправляет сигнал слушателям.
AntSignal
  
remove(aListener:Function):AntSignalBinding
Отписывает слушателя от сигнала.
AntSignal
Protected Methods
 MethodDefined By
  
registerListener(aListener:Function, aInstant:Boolean = false):AntSignalBinding
Регистрирует нового слушателя.
AntSignal
  
registrationPossible(aListener:Function, aInstant:Boolean):Boolean
Определяет возможно ли зарегистрировать указанный слушатель.
AntSignal
Property Detail
_bindingsproperty
protected var _bindings:AntSignalBindingList

Список связей.

_valueClassesproperty 
protected var _valueClasses:Array

Список типов данных с которыми будет проводится сверка отправляемых аргументов в строгом режиме соответствия.

numListenersproperty 
numListeners:uint  [read-only]

Возвращает количество слушателей подписавшихся на сигнал.


Implementation
    public function get numListeners():uint
strictproperty 
public var strict:Boolean

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

The default value is true.

valueClassesproperty 
valueClasses:Array

Опциональный список классов для определения типов параметров которые будут отправлятся слушателям.


Implementation
    public function get valueClasses():Array
    public function set valueClasses(value:Array):void
Constructor Detail
AntSignal()Constructor
public function AntSignal(... aValueClasses)

Parameters
... aValueClasses
Method Detail
add()method
public function add(aListener:Function):AntSignalBinding

Подписывает слушателя на сигнал.

Parameters

aListener:Function — Указатель на метод который будет выполнятся при возникновении сигнала и получать необходимые аргументы.

Returns
AntSignalBinding — Возвращает AntSignalBinding который содержит параметры добавленного слушателя.
addInstant()method 
public function addInstant(aListener:Function):AntSignalBinding

Подписывает одноразовый слушатель на сигнал.

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

Parameters

aListener:Function — Указатель на метод который будет выполнятся при возникновении сигнала и получать необходимые аргументы.

Returns
AntSignalBinding — Возвращает обновленный список.
clear()method 
public function clear():void

Отписывает всех слушателей от сигнала.

destroy()method 
public function destroy():void

Осовобождает используемые ресурсы.

dispatch()method 
public function dispatch(... aValueObjects):void

Отправляет сигнал слушателям.

При использовании строгого режима будет выполнена проверка отправляемых аргументов на соотвествие типам в valueClasses.

Parameters

... aValueObjects — Произвольное количество аргументов отправляемых подписчикам.


Throws
ArgumentError ArgumentError: — aValueObjects не совпадают с типами классов в valueClasses.
registerListener()method 
protected function registerListener(aListener:Function, aInstant:Boolean = false):AntSignalBinding

Регистрирует нового слушателя.

Parameters

aListener:Function — Указатель на метод слушателя.
 
aInstant:Boolean (default = false) — Определяет является ли слушатель одноразовым.

Returns
AntSignalBinding — Возвращает AntSignalBinding который содержит параметры добавленного слушателя.
registrationPossible()method 
protected function registrationPossible(aListener:Function, aInstant:Boolean):Boolean

Определяет возможно ли зарегистрировать указанный слушатель.

Parameters

aListener:Function — Указатель на метод слушателя.
 
aInstant:Boolean — Определяет является ли слушатель одноразовым.

Returns
Boolean — Возвращает true если регистрация возможна.
remove()method 
public function remove(aListener:Function):AntSignalBinding

Отписывает слушателя от сигнала.

Parameters

aListener:Function — Указатель на метод который необходимо удалить из списка слушателей сигнала.

Returns
AntSignalBinding — Возвращает обновленный список.