Packageru.andrewskorik.prrelib
Classpublic class BannerContainer
InheritanceBannerContainer Inheritance flash.display.Sprite

Главный класс библиотеки, представляет собой баннерное место. Возможно инстанцирование с помощью конструктора, но рекомендуется использовать статический метод - initializeFromType


Example
    // Пример минимальной установки контейнера
    // create container
   prreContainer = BannerContainer.initializeFromType(BannerType.BANNER_240X400);
   // setup logging type and level
   prreContainer.notificationLevel = ErrorNotificationLevel.LOG;
   SimpleTraceLogger.logLevel = LogEventLevel.ERROR;
   // setup container
   prreContainer.applicationId = "1744756";
   addChild(prreContainer);



Public Properties
 PropertyDefined by
  age : int
Небязательный параметр.
BannerContainer
  applicationId : String
Обязательный параметр.
BannerContainer
  containerHeight : Number
[read-only] Возвращает высоту баннера.
BannerContainer
  containerWidth : Number
[read-only] Возвращает ширину баннера.
BannerContainer
  country : String
Небязательный параметр.
BannerContainer
  customScriptPath : String
Устанавливает произвольный путь к скрипту для загрузки xml.
BannerContainer
  defaultScriptPath : String
[read-only] Значение по умолчанию для пути к скрипту на сервере.
BannerContainer
  host : String
Устанавливает адрес сервера (без указания схемы протокола и разделителей)
BannerContainer
  logger : ILogger
Экземпляр-имплементор ru.andrewskorik.prrelib.log.ILogger
BannerContainer
  notificationLevel : String
Уровень оповещений.
BannerContainer
  port : int
Устанавливает порт
BannerContainer
  sex : String
Небязательный параметр.
BannerContainer
  showHandCursor : Boolean
Устанавливает режим курсора.
BannerContainer
  userId : String
Небязательный параметр.
BannerContainer
Public Methods
 MethodDefined by
  
BannerContainer(w:Number, h:Number)
Конструктор класса.
BannerContainer
  
forceRefresh():void
Вызов метода приводит к выгрузке загруженного содержимого и немедленной загрузке нового.
BannerContainer
  
[static] Статический метод для инстанцирования экземпляра класса.
BannerContainer
Protected Methods
 MethodDefined by
  
completeHandler(event:Event):void
Метод обработчик завершения загрузки баннера.
BannerContainer
  
Метод создает детей компонента.
BannerContainer
  
createRPC():void
Метод создает сервис удаленных процедур.
BannerContainer
  
drawRect(gr:Graphics, rect:Rectangle, color:uint = 0x000000, alpha:Number = 1.0):void
Метод для заливки на объете graphics Возможна перезапись для модификации поведения компонента.
BannerContainer
  
Метод формирует URI для сервиса удаленных процедурп.
BannerContainer
  
httpStatusHandler(event:HTTPStatusEvent):void
Метод обработчик http-статусов загрузчика Возможна перезапись для модификации поведения компонента.
BannerContainer
  
initHandler(event:Event):void
Метод обработчик инициализации загруженного баннера Возможна перезапись для модификации поведения компонента.
BannerContainer
  
ioErrorHandler(event:IOErrorEvent):void
Метод обработчик ошибки ввода-вывода при загрузке баннера Возможна перезапись для модификации поведения компонента.
BannerContainer
  
notify(message:String, level:int, e:Error = null):void
Метод реализует отправку сообщений в лог либо возбуждение иключения времени выполнения, в зависимости от текущей политики оповещения
BannerContainer
  
onCatcherClick(e:MouseEvent):void
Метод обработчик клика мышью на спрайте-перехватчике событий мыши.
BannerContainer
  
Метод - обрабочик ошибки загрузки XML.
BannerContainer
  
Метод - обрабочик события завершения разбора загруженного XML.
BannerContainer
  
openHandler(event:Event):void
Метод обработчик открытия соединения при загрузке баннера.
BannerContainer
  
progressHandler(event:ProgressEvent):void
Метод обработчик оповещений о прогрессе загрузки баннера.
BannerContainer
  
unLoadHandler(event:Event):void
Метод обработчик события выгрузки содержимого Возможна перезапись для модификации поведения компонента.
BannerContainer
Property detail
ageproperty
age:int  [read-write]

Небязательный параметр. Возраст пользователя

The default value is null.

Implementation
    public function get age():int
    public function set age(value:int):void
applicationIdproperty 
applicationId:String  [read-write]

Обязательный параметр. Идентификатор приложения Если этот параметр равен null или пустой строке - запрос не будет отправлен.

The default value is null.

Implementation
    public function get applicationId():String
    public function set applicationId(value:String):void
containerHeightproperty 
containerHeight:Number  [read-only]

Возвращает высоту баннера.

Implementation
    public function get containerHeight():Number
containerWidthproperty 
containerWidth:Number  [read-only]

Возвращает ширину баннера.

Implementation
    public function get containerWidth():Number
countryproperty 
country:String  [read-write]

Небязательный параметр. Страна проживания пользователя

The default value is null.

Implementation
    public function get country():String
    public function set country(value:String):void
customScriptPathproperty 
customScriptPath:String  [read-write]

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

The default value is null.

Implementation
    public function get customScriptPath():String
    public function set customScriptPath(value:String):void

Example
prreContainer.customScriptPath ="soc240x400_custom.php";

defaultScriptPathproperty 
defaultScriptPath:String  [read-only]

Значение по умолчанию для пути к скрипту на сервере. Нужно учитывать при наследовании от класса контейнера, что значение формируется в конструкторе класса из приватной константы путем подстановки размеров

The default value is "soc{W}x{H}.php".

Implementation
    public function get defaultScriptPath():String
hostproperty 
host:String  [read-write]

Устанавливает адрес сервера (без указания схемы протокола и разделителей)

The default value is prre.ru.

Implementation
    public function get host():String
    public function set host(value:String):void

Example
prreContainer.host = "prre.ru"

loggerproperty 
logger:ILogger  [read-write]

Экземпляр-имплементор ru.andrewskorik.prrelib.log.ILogger

The default value is экземпляр класса ru.andrewskorik.prrelib..

Implementation
    public function get logger():ILogger
    public function set logger(value:ILogger):void
notificationLevelproperty 
notificationLevel:String  [read-write]

Уровень оповещений. ЗНачения устанавливаются константами класса ru.andrewskorik.prrelib.log.ErrorNotificationLevel Определяет будет ли компонент писать сообщения об ошибках в лог или возбуждать исключения времени выполнения.

The default value is ru.andrewskorik.prrelib.log.ErrorNotificationLevel.LOG.

Implementation
    public function get notificationLevel():String
    public function set notificationLevel(value:String):void
portproperty 
port:int  [read-write]

Устанавливает порт

The default value is 80.

Implementation
    public function get port():int
    public function set port(value:int):void

Example
prreContainer.port = 8080

sexproperty 
sex:String  [read-write]

Небязательный параметр. Пол пользователя

The default value is null.

Implementation
    public function get sex():String
    public function set sex(value:String):void
showHandCursorproperty 
showHandCursor:Boolean  [read-write]

Устанавливает режим курсора. В случае если контейнер обрабатывает клик сам (oldBanner в xml = true)

Implementation
    public function get showHandCursor():Boolean
    public function set showHandCursor(value:Boolean):void
userIdproperty 
userId:String  [read-write]

Небязательный параметр. Идентификатор пользователя

The default value is null.

Implementation
    public function get userId():String
    public function set userId(value:String):void
Constructor detail
BannerContainer()constructor
public function BannerContainer(w:Number, h:Number)

Конструктор класса. Сохряняет размеры баннера. Инициализирует путь по умолчанию к скрипту на сервере. Добавляет слушателя добавки на стейдж.

Parameters
w:Number — Ширина баннера
 
h:Number — Высота баннера
Method detail
completeHandler()method
protected function completeHandler(event:Event):void

Метод обработчик завершения загрузки баннера. Удалает слушателей с лоадера. Устанавливает таймер смены баннера. Устанавливает разрешения политик безопасности. Возможна перезапись для модификации поведения компонента

Parameters
event:Event
costructChildren()method 
protected function costructChildren():void

Метод создает детей компонента. Возможна перезапись для модификации поведения компонента

createRPC()method 
protected function createRPC():void

Метод создает сервис удаленных процедур. Возможна перезапись для модификации поведения компонента

drawRect()method 
protected function drawRect(gr:Graphics, rect:Rectangle, color:uint = 0x000000, alpha:Number = 1.0):void

Метод для заливки на объете graphics Возможна перезапись для модификации поведения компонента.

Parameters
gr:Graphics
 
rect:Rectangle
 
color:uint (default = 0x000000)
 
alpha:Number (default = 1.0)
forceRefresh()method 
public function forceRefresh():void

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

getURI()method 
protected function getURI():URI

Метод формирует URI для сервиса удаленных процедурп. Возможна перезапись для модификации поведения компонента

Returns
URI
httpStatusHandler()method 
protected function httpStatusHandler(event:HTTPStatusEvent):void

Метод обработчик http-статусов загрузчика Возможна перезапись для модификации поведения компонента. Например добавки прелоадера баннеров

Parameters
event:HTTPStatusEvent
initHandler()method 
protected function initHandler(event:Event):void

Метод обработчик инициализации загруженного баннера Возможна перезапись для модификации поведения компонента. Например добавки прелоадера баннеров

Parameters
event:Event
initializeFromType()method 
public static function initializeFromType(type:BannerType):BannerContainer

Статический метод для инстанцирования экземпляра класса.

Parameters
type:BannerType

Returns
BannerContainer — Экземпляр класса с размерами для данного типа.
ioErrorHandler()method 
protected function ioErrorHandler(event:IOErrorEvent):void

Метод обработчик ошибки ввода-вывода при загрузке баннера Возможна перезапись для модификации поведения компонента. Например добавки прелоадера баннеров

Parameters
event:IOErrorEvent
notify()method 
protected function notify(message:String, level:int, e:Error = null):void

Метод реализует отправку сообщений в лог либо возбуждение иключения времени выполнения, в зависимости от текущей политики оповещения

Parameters
message:String
 
level:int
 
e:Error (default = null)

See also

onCatcherClick()method 
protected function onCatcherClick(e:MouseEvent):void

Метод обработчик клика мышью на спрайте-перехватчике событий мыши. Возможна перезапись для модификации поведения компонента. Например добавки прелоадера баннеров

Parameters
e:MouseEvent
onXMLLoadError()method 
protected function onXMLLoadError(e:RPCEvent):void

Метод - обрабочик ошибки загрузки XML. Стартует таймер на 10 сеунд и инициирует повторную загрузку по окончании Возможна перезапись для модификации поведения компонента

Parameters
e:RPCEvent
onXMLParsed()method 
protected function onXMLParsed(e:RPCEvent):void

Метод - обрабочик события завершения разбора загруженного XML. Инициирует загрузку самого баннера в соответсвии с описанием Скрывает или отображает перехватчик событий мыши. Возможна перезапись для модификации поведения компонента

Parameters
e:RPCEvent
openHandler()method 
protected function openHandler(event:Event):void

Метод обработчик открытия соединения при загрузке баннера. Возможна перезапись для модификации поведения компонента. Например добавки прелоадера баннеров

Parameters
event:Event
progressHandler()method 
protected function progressHandler(event:ProgressEvent):void

Метод обработчик оповещений о прогрессе загрузки баннера. Возможна перезапись для модификации поведения компонента. Например добавки прелоадера баннеров

Parameters
event:ProgressEvent
unLoadHandler()method 
protected function unLoadHandler(event:Event):void

Метод обработчик события выгрузки содержимого Возможна перезапись для модификации поведения компонента. Например добавки прелоадера баннеров

Parameters
event:Event