YMaps.ToolBarRadioButton

Расширяет YMaps.ToolBarToggleButton.

Элемент группы переключателей (radio button).

КонструкторКонструктор

Наследуемые поляНаследуемые поля

Из YMaps.ToolBarButton:

Events

СобытияСобытия

Наследуемые событияНаследуемые события

Из YMaps.ToolBarToggleButton:

Deselect

Из YMaps.ToolBarButton:

Click

МетодыМетоды

Наследуемые методыНаследуемые методы

Из YMaps.ToolBarButton:

deselect, disable, enable, getContent, getToolBar, hide, isEnabled, isSelected, isShown, setContent, show

Из YMaps.IToolBarItem:

onAddToToolBar, onRemoveFromToolBar

Подробное описание конструктораПодробное описание конструктора

YMaps.ToolBarRadioButton(groupId, content, options)

Создает отдельный элемент группы переключателей (radio button). Группа переключателей позволяет выбрать одну из нескольких взаимоисключающих возможностей.

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

Пример:

// Создает и добавляет на тулбар группу из двух переключателей, которые включают/выключают элементы управления
// "Линейка" и "Увеличение", соответственно.
var btn1 = new YMaps.ToolBarRadioButton('my-group', { icon: "http://some.url/path/img.gif", caption: "Линейка"});
var btn2 = new YMaps.ToolBarRadioButton('my-group', { icon: "http://some.url/path/img.gif", caption: "Увеличить"});
YMaps.Events.observe(btn1, btn1.Events.Select, function () {
    this.getMap().enableRuler();
}, toolbar);
YMaps.Events.observe(btn1, btn1.Events.Deselect, function () {
    this.getMap().disableRuler();
}, toolbar);
YMaps.Events.observe(btn2, btn2.Events.Select, function () {
    this.getMap().enableMagnifier();
}, toolbar);
YMaps.Events.observe(btn2, btn2.Events.Deselect, function () {
    this.getMap().disableMagnifier();
}, toolbar);
toolbar.add(btn1);
toolbar.add(btn2);

Параметры:

Имя	Тип	Необязательный	По умолчанию	Описание
groupId	String			Группа, к которой принадлежит переключатель.
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 - недоступен.

Подробное описание событийПодробное описание событий

SelectSelect

Select

Событие выбора переключателя.

В callback-функцию передаются два аргумента:

• ссылка на переключатель;
• ссылка на предыдущий выбранный переключатель в группе.

Подробное описание методовПодробное описание методов

getGroupIdgetGroupId

{String} getGroupId()

Возвращает имя группы, которой принадлежит переключатель.

Возвращает:

selectselect

select()

Устанавливает переключатель в состояние "выбран". При этом, для предыдущего выбранного переключателя группы будет вызван метод deselect().