tuna.ui.WidgetContainer

Свойства

_listeners:Object.<string, Array.<function(tuna.events.BasicEvent, *)>>

[protected] Таблица слушателей событий определенных типов.

_propagationParent:tuna.events.IEventDispatcher

[protected] Родительский объект иерархии распростанения (баблинга).

_target:Node

[protected] Целевой DOM-элемент экземпляра модуля отображения.

Методы

[protected] _setDefaultOption:

Устанока параметра настроек виджета по умолчанию.

Аргументы:

Имя	Тип	Описание
name	string	Имя параметра настроек.
value	null | string | boolean | number	Значение параметра.

addEventListener:

Добавление обработчика события. Обработчиком события должна быть функция принимающая в качестве аргументов объект события и сопуствующие ему данные. В случае, если сопутствующие данные не были заданы в качестве данных передается null. По-умолчанию функция обработчик будет вызвана в контексте объекта который оповестил о событии.

Аргументы:

Имя	Тип	Описание
type	string	Тип события который необходимо обрабатывать.
listener	function(tuna.events.BasicEvent, *)	Функция-обработчик события.

См. также:

• tuna.events.IEventDispatcher#dispatch

destroy:

Удаление логики виджета.

destroyModules:

Уничтожение всех экземпляров модулей проинициализированных в данном контейнере.

Аргументы:

Имя	Тип	Описание
target	Node

dispatch:boolean

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

Аргументы:

Имя	Тип	Описание
event	tuna.events.BasicEvent | string	Событие, о котором необходимо оповестить. В качестве данного аргумента может выступать либо объект события, либо тип события. В случае если передан тип события объект события должен быть создан автоматически.
opt_data	*	Сопуствующие событию данные.

Возвращает:

• Флаг отсутствия отмены обрабтки по-умолчанию.

См. также:

• tuna.events.BasicEvent#preventDefault

getBooleanOption:boolean

Получение булева параметра настроек виджета.

Аргументы:

Имя	Тип	Описание
name	string	Имя параметра настроек.

Возвращает:

• Булево значение параметра.

getModuleInstanceByName:tuna.ui.Widget

Получение экземпляра модуля отображения по типу модйля и имени экземпляра.

Аргументы:

Имя	Тип	Описание
type	string	Тип модуля.
name	string	Имя экземпляра.

Возвращает:

• Экземпляр модуля отображения.

См. также:

• tuna.ui.Widget#getName

getModuleInstances:Array.

Получение всех экземпляров модулей отображения определенного типа.

Аргументы:

Имя	Тип	Описание
type	string	Тип модуля отображения.
target	Node	DOM-элемент модули которого н еобходимо вренуть.

Возвращает:

• Массив модулей отображения.

getName:string

Получение имени виджета. Имя виджета устанавливается в аттрибуте целевого DOM-элемента data-name.

Возвращает:

• Имя экземпляра.

getNumberOption:number

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

Аргументы:

Имя	Тип	Описание
name	string	Имя параметра настроек.

Возвращает:

• Строковое значение параметра.

getOption:null|string|boolean|number

Получение параметра настроек виджета.

Аргументы:

Имя	Тип	Описание
name	string	Имя параметра настроек.

Возвращает:

• Значение параметра.

getOptions:Object.

Получение таблицы настроек виджета.

Возвращает:

• Таблица настроек.

getStringOption:string

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

Аргументы:

Имя	Тип	Описание
name	string	Имя параметра настроек.

Возвращает:

• Строковое значение параметра.

getTarget:Node

Получение целевого DOM-элемента виджета.

Возвращает:

• Целевой DOM-элемент.

hasEventListener:boolean

Проверка наличия обработчика события определенного типа.

Аргументы:

Имя	Тип	Описание
type	string	Тип события который, наличие обработчика которого следует определить.
listener	function(tuna.events.BasicEvent, *)	Функция-обработчик.

Возвращает:

• Результат проверки наличия обработчика.

init:

Инициализация логики виджета.

initModules:

Инициализация модулей в DOM-элементе. Данный метод стоит использовать в том случае, если внутри целевого DOM-элемента появились дочерние элементы, в которых так же требуется проинициализировать экземпляры модулей.

Аргументы:

Имя	Тип	Описание
target	Node	DOM-элемент в котором требуется проинициализировать экземпляры модулей.

См. также:

• tuna.ui.WidgetFactory#init

isActive:boolean

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

Возвращает:

• Результат проверки.

isEnabled:boolean

Проверка работоспособности виджета.

Возвращает:

• Результат проверки.

removeEventListener:

Удаление слушателя события.

Аргументы:

Имя	Тип	Описание
type	string	Тип события который не нужно больше обрабатывать.
listener	function(tuna.events.BasicEvent, *)	Функция-обработчик.

См. также:

• tuna.events.IEventDispatcher#addEventListener

requireModules:

Установка списка имен модулей, которые требуются в этом контейнере.

Аргументы:

Имя	Тип	Описание
modules	Array.<string>	Список модулей.

setEnabled:

Установка работоспособности виджета. Работоспособность виджета отключается добавлением CSS-класса disabled у целевого DOM-элемента.

Аргументы:

Имя	Тип	Описание
isEnabled	boolean	Флаг работоспособности.

setOption:

Установка параметра настроек виджета.

Аргументы:

Имя	Тип	Описание
name	string	Имя параметра настроек.
value	null | string | boolean | number	Значение параметра.