Packageru.antkarlov.anthill
Classpublic class AntPluginManager
InheritanceAntPluginManager Inheritance Object

Language Version : ActionScript 3
Since : 26.05.2013
Runtime Versions : AIR 1.0, Flash Player 10.0.0

Данный класс реализует управление активными и не активными плагинами.

Экземпляр менеджера плагинов создается автоматически при запуске Anthill и доступен через AntG.plugins. Чтобы добавить в работу свой плагин, необходимо добавить его в менеджер:

AntG.plugins.add(new MyPlugin());

Так же в задачи менеджера плагинов входить возможность приостанавливать и возобновлять работу плагинов соотвествующих указанным критериям. В качестве критериев принимаются: тэги, классы и указатели на сами плагины.

AntG.plugins.stop("someTag", MyPluginClass, myPlugin);

Чтобы возобновить работу остановленных плагинов, достаточно вызывать resume():

AntG.plugins.resume("someTag", MyPluginClass, myPlugin);

Более подробно о том как использовать и создавать свои плагины, читайте в Anthill Wiki.



Public Properties
 PropertyDefined By
  listOfActive : Vector.<IPlugin>
Список активных плагинов.
AntPluginManager
  listOfPaused : Vector.<IPlugin>
Список остановленных плагинов.
AntPluginManager
  numActive : int
[read-only] Возвращает количество активных плагинов, включая пустые ячейки в списке listOfActive.
AntPluginManager
  numPaused : int
[read-only] Возвращает количество остановленных плагинов, включая пустые ячейки в списке listOfPaused.
AntPluginManager
  numWorks : int
[read-only] Возвращает количество реально работающих плагинов.
AntPluginManager
Protected Properties
 PropertyDefined By
  _numActive : int
AntPluginManager
  _numPaused : int
AntPluginManager
  _sortOrder : int
AntPluginManager
Public Methods
 MethodDefined By
  
AntPluginManager
  
Добавляет плагин.
AntPluginManager
  
Добавляет плагин в список остановленных плагинов.
AntPluginManager
  
contains(aPlugin:IPlugin):Boolean
Проверят был ли ранее добавлен указанный плагин.
AntPluginManager
  
draw(aCamera:AntCamera):void
Отрисовка плагинов.
AntPluginManager
  
get(... aPlugins):Array
Извлекает список плагинов по указанным критериям.
AntPluginManager
  
isActive(aPlugin:IPlugin):Boolean
Проверят находится ли указанный плагин в списке активных плагинов.
AntPluginManager
  
isPaused(aPlugin:IPlugin):Boolean
Проверяет находится ли указанный плагин в списке остановленных плагинов.
AntPluginManager
  
pause(... aPlugins):int
Останавливает работу плагинов которые соотвествуют указанным критериям.
AntPluginManager
  
remove(aPlugin:IPlugin, aSplice:Boolean = false):IPlugin
Удаляет плагин.
AntPluginManager
  
removeFromPaused(aPlugin:IPlugin, aSplice:Boolean = false):IPlugin
Удаляет плагин из списка остановленных.
AntPluginManager
  
removeSeveral(... aPlugins):Array
Удаляет несколько плагинов по указанным критериям.
AntPluginManager
  
resume(... aPlugins):int
Возобновляет работу плагинов которые соотвествуют указанным критериям.
AntPluginManager
  
update():void
Обработка плагинов.
AntPluginManager
Protected Methods
 MethodDefined By
  
compare(aCondition:*, aPlugin:IPlugin):Boolean
Проверяет соотвествует ли указанный критерий для указанного плагина.
AntPluginManager
  
getPlugin(aPlugin:*, aResult:Array = null):Array
Извлекает плагин соответствующий указанному критерию.
AntPluginManager
  
removePlugin(aPlugin:*, aResult:Array = null):Array
Удаляет плагин соответствующий указанному критерию.
AntPluginManager
  
resumePlugin(aPlugin:*):int
Возобновляет работу плагина соотвествующего указанному критерию.
AntPluginManager
  
sortHandler(aPlugin1:IPlugin, aPlugin2:IPlugin):int
Помошник для сортировки плагинов по приоритету.
AntPluginManager
  
stopPlugin(aPlugin:*):int
Останавливает работу плагина соотвествующего указанному критерию.
AntPluginManager
Protected Constants
 ConstantDefined By
  ASCENDING : int = -1
[static]
AntPluginManager
  DESCENDING : int = 1
[static]
AntPluginManager
Property Detail
_numActiveproperty
protected var _numActive:int

_numPausedproperty 
protected var _numPaused:int

_sortOrderproperty 
protected var _sortOrder:int

listOfActiveproperty 
public var listOfActive:Vector.<IPlugin>

Список активных плагинов.

listOfPausedproperty 
public var listOfPaused:Vector.<IPlugin>

Список остановленных плагинов.

numActiveproperty 
numActive:int  [read-only]

Возвращает количество активных плагинов, включая пустые ячейки в списке listOfActive.


Implementation
    public function get numActive():int
numPausedproperty 
numPaused:int  [read-only]

Возвращает количество остановленных плагинов, включая пустые ячейки в списке listOfPaused.


Implementation
    public function get numPaused():int
numWorksproperty 
numWorks:int  [read-only]

Возвращает количество реально работающих плагинов.


Implementation
    public function get numWorks():int
Constructor Detail
AntPluginManager()Constructor
public function AntPluginManager()

Method Detail
add()method
public function add(aPlugin:IPlugin):IPlugin

Добавляет плагин.

Parameters

aPlugin:IPlugin — Плагин который необходимо добавить.

Returns
IPlugin — Возвращает указатель на добавленный плагин.
addToPaused()method 
public function addToPaused(aPlugin:IPlugin):IPlugin

Добавляет плагин в список остановленных плагинов.

Parameters

aPlugin:IPlugin — Плагин который необходимо остановить.

Returns
IPlugin — Возвращает указатель на плагин добавленный в список остановленных.
compare()method 
protected function compare(aCondition:*, aPlugin:IPlugin):Boolean

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

Parameters

aCondition:* — Критерий: тэг, класс или экземпляр.
 
aPlugin:IPlugin — Конкретный плагин с которым нужно проверить соотвествие.

Returns
Boolean — Возвращает true если указанный критерий соотвествует указанному плагину.
contains()method 
public function contains(aPlugin:IPlugin):Boolean

Проверят был ли ранее добавлен указанный плагин.

Parameters

aPlugin:IPlugin — Плагин наличие которого необходимо проверить.

Returns
Boolean — Вовзращает true если плагин был ранее добавлен.
draw()method 
public function draw(aCamera:AntCamera):void

Отрисовка плагинов.

Parameters

aCamera:AntCamera

get()method 
public function get(... aPlugins):Array

Извлекает список плагинов по указанным критериям.

Пример использования:

		 AntG.plugins.get([ "tween", AntTween ]); // Извлечение по тэгу и классу
		 AntG.plugins.get("tween"); // Извлечение только по тэгу
		 AntG.plugins.get(AntTween); // Извлечение только по классу
		 

Parameters

... aPlugins — Массив или список тэгов или классов плагинов которые нужно извлечь.

Returns
Array — Возвращает массив плагинов соответствующих указанным критериям.
getPlugin()method 
protected function getPlugin(aPlugin:*, aResult:Array = null):Array

Извлекает плагин соответствующий указанному критерию.

Parameters

aPlugin:* — Тэг, класс или сам плагин который необходимо извлечь.
 
aResult:Array (default = null) — Массив в который будет записан извлеченный плагин(ы).

Returns
Array — Возвращает массив извлеченных плагинов.
isActive()method 
public function isActive(aPlugin:IPlugin):Boolean

Проверят находится ли указанный плагин в списке активных плагинов.

Parameters

aPlugin:IPlugin — Плагин который необходимо проверить.

Returns
Boolean — Возвращает true если плагин находится в списке активных.
isPaused()method 
public function isPaused(aPlugin:IPlugin):Boolean

Проверяет находится ли указанный плагин в списке остановленных плагинов.

Parameters

aPlugin:IPlugin — Плагин который необходимо проверить.

Returns
Boolean — Возвращает true если плагин находится в списке остановленных.
pause()method 
public function pause(... aPlugins):int

Останавливает работу плагинов которые соотвествуют указанным критериям.

Пример использования:

		 AntG.plugins.stop([ "tween", AntTween, myTween ]); // Остановка по тэгу, классу и указателю на экземпляр
		 AntG.plugins.stop("tween"); // Остановка по тэгу
		 AntG.plugins.stop(myTween); // Остановка по указателю на экземпляр
		 

Parameters

... aPlugins — Массив или список тэгов, классов или указателей на плагины которые необходимо остановить.

Returns
int — Возвращает количество остановленных плагинов.
remove()method 
public function remove(aPlugin:IPlugin, aSplice:Boolean = false):IPlugin

Удаляет плагин.

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

Parameters

aPlugin:IPlugin — Плагин который необходимо удалить.
 
aSplice:Boolean (default = false) — Если true то элемент массива в котором размещался плагин так же будет удален.

Returns
IPlugin
removeFromPaused()method 
public function removeFromPaused(aPlugin:IPlugin, aSplice:Boolean = false):IPlugin

Удаляет плагин из списка остановленных.

Parameters

aPlugin:IPlugin — Плагин который необходимо удалить из списка остановленных.
 
aSplice:Boolean (default = false) — Флаг определяющий будет ли удалена ячейка из списка при удалении плагина.

Returns
IPlugin — Возвращает указатель на плагин удаленный из списка приостановленных.
removePlugin()method 
protected function removePlugin(aPlugin:*, aResult:Array = null):Array

Удаляет плагин соответствующий указанному критерию.

Parameters

aPlugin:* — Тэг, класс или сам плагин который необходимо удалить.
 
aResult:Array (default = null) — Массив в который будет записан удаленный плагин(ы).

Returns
Array — Возвращает массив удаленных плагинов.
removeSeveral()method 
public function removeSeveral(... aPlugins):Array

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

Пример использования:

		 AntG.plugins.removeSeveral([ "tween", AntTween ]); // Удаление по тэгу и классу
		 AntG.plugins.removeSeveral("tween"); // Удаление только по тэгу
		 AntG.plugins.removeSeveral(AntTween); // Удаление только по классу
		 

Parameters

... aPlugins — Список или массив плагинов, тэгов или классов плагинов которые следует удалить.

Returns
Array — Возвращает список удаленных плагинов.
resume()method 
public function resume(... aPlugins):int

Возобновляет работу плагинов которые соотвествуют указанным критериям.

Пример использования:

		 AntG.plugins.resume([ "tween", AntTween, myTween ]); // Запуск по тэгу, классу и указателю на экземпляр
		 AntG.plugins.resume("tween"); // Запуск по тэгу
		 AntG.plugins.resume(myTween); // Запуск по указателю на экземпляр
		 

Parameters

... aPlugins — Массив или список тэгов, классов или указателей на плагины работу которых необходимо возобновить.

Returns
int — Возвращает количество запущенных плагинов.
resumePlugin()method 
protected function resumePlugin(aPlugin:*):int

Возобновляет работу плагина соотвествующего указанному критерию.

Parameters

aPlugin:* — Тэг, класс или сам плагин который необходимо возобновить.

Returns
int — Возвращает количество возобновленных плагинов.
sortHandler()method 
protected function sortHandler(aPlugin1:IPlugin, aPlugin2:IPlugin):int

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

Parameters

aPlugin1:IPlugin
 
aPlugin2:IPlugin

Returns
int
stopPlugin()method 
protected function stopPlugin(aPlugin:*):int

Останавливает работу плагина соотвествующего указанному критерию.

Parameters

aPlugin:* — Тэг, класс или сам плагин который необходимо остановить.

Returns
int — Возвращает количество остановленных плагинов.
update()method 
public function update():void

Обработка плагинов.

Constant Detail
ASCENDINGConstant
protected static const ASCENDING:int = -1

DESCENDINGConstant 
protected static const DESCENDING:int = 1