control.ListBoxItem
Расширяет ICustomizable, ISelectableControl.
Элемент раскрывающегося списка.
Конструктор | Поля | События | Методы
Конструктор
control.ListBoxItem([parameters])
Параметры:
Параметр |
Значение по умолчанию |
Описание |
|
— |
Тип: Object|String Параметры элемента либо строка - HTML-содержимое элемента. |
||
— |
Тип: Object Данные элемента. |
||
— |
Тип: String Содержимое элемента. |
||
— |
Тип: Object Опции элемента управления. |
||
'islands#listBoxItemLayout' |
Тип: Function|String Конструктор макета элемента управления, реализующий интерфейс ISelectableControlLayout или ключ макета в хранилище layout.storage. Это базовый макет, который в зависимости от значения опции type выбирает, какой из подмакетов отобразить - options.selectableLayout или options.separatorLayout. В конструктор макета передается объект, содержащий поля:
|
||
'islands#listBoxItemSelectableLayout' |
Тип: Function |
String Конструктор макета элемента списка, реализующий интерфейс ISelectableControlLayout или ключ макета в хранилище layout.storage. Применяется к элементам с опцией type='item'. Опция стандартной реализации макета элемента списка. |
|
true |
Тип: Boolean Флаг, разрешающий автоматическое выделение элемента списка по клику.
|
||
'islands#listBoxItemSeparatorLayout' |
Тип: Function|String Конструктор макета разделителя элементов списка, реализующий интерфейс IControlLayout или ключ макета в хранилище layout.storage. Применяется к элементам с опцией type='separator'. Опция стандартной реализации макета элемента списка. |
||
'selectable' |
Тип: String Тип пункта меню. В зависимости от значения этой опции макет элемента списка инстанцирует один из подмакетов - options.selectableLayout или options.separatorLayout. Возможные значения:
|
||
true |
Тип: Boolean Признак того, что элемент управления отображается. |
||
— |
Тип: Object Объект, описывающий состояние пункта меню. |
||
false |
Тип: Boolean Признак, выбран ли пункт. |
Поля
Имя |
Тип |
Описание |
Данные элемента списка. Имена полей, доступных через метод data.Manager.get:
|
||
Менеджер событий. Унаследовано от IEventEmitter. |
||
Менеджер опций. Унаследовано от ICustomizable. |
||
Состояние элемента списка. Имена полей, доступных через метод data.Manager.get:
|
События
Имя |
Описание |
Выбор элемента списка. |
|
Элемент управления не выбран. Унаследовано от ISelectableControl. |
|
Элемент управления стал недоступным. Унаследовано от ISelectableControl. |
|
Элемент управления стал доступным. Унаследовано от ISelectableControl. |
|
Изменение в опциях объекта. Унаследовано от ICustomizable. |
|
Сменился родительский объект. Поля данных:
Унаследовано от IChild. |
|
Элемент управления выбран. Унаследовано от ISelectableControl. |
Методы
Имя |
Возвращает |
Описание |
deselect() |
Отменяет выбор элемента управления (выключает). Унаследован от ISelectableControl. |
|
disable() |
Делает элемент управления недоступным (запрещены пользовательские действия). Унаследован от ISelectableControl. |
|
enable() |
Делает элемент управления доступным (разрешены пользовательские действия). Унаследован от ISelectableControl. |
|
getMap() |
Возвращает ссылку на карту. |
|
IControlParent|null |
Возвращает ссылку на родительский объект или null, если родительский элемент не был установлен. Унаследован от IControl. |
|
Boolean |
Возвращает true - элемент управления доступен, false - недоступен. Унаследован от ISelectableControl. |
|
Boolean |
Возвращает true - элемент управления выбран, false - не выбран. Унаследован от ISelectableControl. |
|
select() |
Выбирает (включает) элемент управления. Унаследован от ISelectableControl. |
|
Устанавливает родительский объект. Если передать значение null, то элемент управления будет только удален из текущего родительского объекта. Унаследован от IControl. |
Описание полей
data
{data.Manager} data
Данные элемента списка. Имена полей, доступных через метод data.Manager.get:
- content - cодержимое элемента списка в виде HTML;
- title - текст всплывающей подсказки.
state
{data.Manager} state
Состояние элемента списка. Имена полей, доступных через метод data.Manager.get:
- selected - признак, выбран ли элемент списка;
- enabled - признак, активен ли элемент списка.
Описание событий
click
Выбор элемента списка.
Описание методов
getMap
{Map} getMap()
Возвращает ссылку на карту.