YMaps.ListBox
Расширяет YMaps.Group, YMaps.IToolBarItem.
Класс для создания элемента тулбара в виде раскрывающегося списка.
Элемент тулбара в виде раскрывающегося списка, предлагающего на выбор несколько взаимоисключающих вариантов. Чтобы открыть список, пользователю требуется нажать на стрелку справа от него.
Список может иметь заголовок, который показывается на тулбаре. В список можно добавлять и удалять элементы. Элементы списка могут быть как экземплярами стандартных классов YMaps.ToolBarItem и YMaps.ToolBarToggleItem, так и пользовательскими объектами, реализующими интерфейс YMaps.IToolBarItem.
Конструктор
| Имя | Описание |
|---|---|
| YMaps.ListBox(options) | Создает элемент тулбара в виде раскрывающегося списка. |
Наследуемые поля
- Из YMaps.Group:
- Events
Наследуемые события
- Из YMaps.Group:
- Add, Remove
Методы
| Имя | Возвращает | Описание |
|---|---|---|
| collapse() | Скрывает список. | |
| expand() | Раскрывает список. | |
| getCaption() | String | Возвращает текущий заголовок раскрывающегося списка. |
| getToolBar() | YMaps.ToolBar | Возвращает тулбар, на который добавлен раскрывающийся список. |
| isExpanded() | Boolean | Возвращает состояние раскрывающегося списка (раскрыт/скрыт). |
| setCaption(caption) | Задает новый заголовок раскрывающегося списка. |
Наследуемые методы
- Из YMaps.IToolBarItem:
- onAddToToolBar, onRemoveFromToolBar
- Из YMaps.Group:
- add, filter, forEach, get, indexOf, length, remove, removeAll, splice
Подробное описание конструктора
YMaps.ListBox(options)
Создает элемент тулбара в виде раскрывающегося списка.
Параметры:
| Имя | Тип | Необязательный | По умолчанию | Описание |
|---|---|---|---|---|
options |
Object | Опции раскрывающегося списка. | ||
options.width |
Integer |  |
140 | Ширина списка (в пикселах). |
options.caption |
String | |
'' | Заголовок списка. |
Подробное описание методов
collapse
collapse()
Скрывает список.
expand
expand()
Раскрывает список.
getCaption
{String} getCaption()
Возвращает текущий заголовок раскрывающегося списка.
Возвращает:
| Тип | Описание |
|---|---|
| String | Заголовок списка. |
getToolBar
{YMaps.ToolBar} getToolBar()
Возвращает тулбар, на который добавлен раскрывающийся список.
Возвращает:
| Тип | Описание |
|---|---|
| YMaps.ToolBar | Тулбар, на который добавлен раскрывающийся список. |
isExpanded
{Boolean} isExpanded()
Возвращает состояние раскрывающегося списка (раскрыт/скрыт).
Возвращает:
| Тип | Описание |
|---|---|
| Boolean | true - раскрыт, false - скрыт. |
setCaption
setCaption(caption)
Задает новый заголовок раскрывающегося списка.
Параметры:
| Имя | Тип | Описание |
|---|---|---|
caption |
String | Новый заголовок списка. |