YMaps.ToolBarButton
Расширяет YMaps.IToolBarItem.
Класс кнопки тулбара.
Конструктор
Имя | Описание |
---|---|
YMaps.ToolBarButton(content, options) | Создает кнопку тулбара. |
Поля
Имя | Описание |
---|---|
Events | Список событий кнопки. |
События
Имя | Описание |
---|---|
Click | Событие щелчка по кнопке. |
Методы
Имя | Возвращает | Описание |
---|---|---|
deselect() | Устанавливает кнопку в состояние "не нажата". | |
disable() | Устанавливает кнопку в состояние "недоступна". | |
enable() | Устанавливает кнопку в состояние "доступна". | |
getContent() | Object | Возвращает содержимое кнопки. |
getToolBar() | YMaps.ToolBar | Возвращает тулбар, на который добавлена кнопка. |
hide() | Скрывает кнопку. | |
isEnabled() | Boolean | Возвращает состояние кнопки "доступна"/"недоступна". |
isSelected() | Boolean | Возвращает состояние кнопки "нажата"/"не нажата". |
isShown() | Boolean | Возвращает состояние видимости кнопки. |
select() | Переводит кнопку в состояние "нажата". | |
setContent(content) | Устанавливает содержимое кнопки. | |
show() | Показывает кнопку. |
Наследуемые методы
Подробное описание конструктора
YMaps.ToolBarButton(content, options)
Создает кнопку тулбара. Обычная кнопка тулбара имеет три состояния: кнопка нажата, кнопка не нажата, кнопка недоступна.
Пример:
// Создает и добавляет на тулбар кнопку, которая включает инструмент "Линейка".
var btn = new YMaps.ToolBarButton({ icon: "http://some.url/path/img.gif", caption: "Линейка", hint: "Линейка для измерения расстояний между точками"});
YMaps.Events.observe(btn, btn.Events.Click, function () {
this.getMap().enableRuler();
}, toolbar);
toolbar.add(btn);
Параметры:
Имя | Тип | Необязательный | По умолчанию | Описание |
---|---|---|---|---|
content |
Object | Содержимое кнопки. | ||
content.icon |
String | URL значка кнопки. | ||
content.caption |
String | Заголовок кнопки. | ||
content.hint |
String | Подсказка для кнопки. | ||
content.width |
Integer | Ширина содержимого кнопки (в пикселах). | ||
options |
Object | Настройки кнопки. | ||
options.selected |
Boolean | false | Исходное состояние кнопки: true - нажата, false - не нажата. | |
options.enabled |
Boolean | true | true - кнопка доступна, false - кнопка недоступна. | |
options.shown |
Boolean | true | Состояние кнопки по умолчанию: true - показана, false - скрыта. |
Подробное описание полей
Events
Object Events
Список событий кнопки.
Подробное описание событий
Click
Click
Событие щелчка по кнопке. В callback-функцию передается ссылка на кнопку, для которой был вызван обработчик.
Подробное описание методов
deselect
deselect()
Устанавливает кнопку в состояние "не нажата".
disable
disable()
Устанавливает кнопку в состояние "недоступна". Не применяется к нажатым кнопкам.
enable
enable()
Устанавливает кнопку в состояние "доступна".
getContent
{Object} getContent()
Возвращает содержимое кнопки.
Возвращает:
Тип | Описание |
---|---|
Object |
getToolBar
{YMaps.ToolBar} getToolBar()
Возвращает тулбар, на который добавлена кнопка.
Возвращает:
Тип | Описание |
---|---|
YMaps.ToolBar | Тулбар. |
hide
hide()
Скрывает кнопку.
isEnabled
{Boolean} isEnabled()
Возвращает состояние кнопки "доступна"/"недоступна".
Возвращает:
Тип | Описание |
---|---|
Boolean | true - кнопка доступна, false - кнопка недоступна. |
isSelected
{Boolean} isSelected()
Возвращает состояние кнопки "нажата"/"не нажата".
Возвращает:
Тип | Описание |
---|---|
Boolean | true - кнопка нажата, false - кнопка не нажата. |
isShown
{Boolean} isShown()
Возвращает состояние видимости кнопки.
Возвращает:
Тип | Описание |
---|---|
Boolean | true - кнопка видна, false - не видна. |
select
select()
Переводит кнопку в состояние "нажата". Операция не применяется к недоступным кнопкам.
setContent
setContent(content)
Устанавливает содержимое кнопки.
Параметры:
Имя | Тип | Описание |
---|---|---|
content |
Object | Содержимое кнопки. |
show
show()
Показывает кнопку.