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