Button
Button – это класс для элемента управления Кнопка. Класс расширяет возможности базового класса Control.
Подробнее: Control.
Свойства
caption
Задаёт или получает имя кнопки.
caption: string;
clickAction
Слушает нажатия на кнопку.
clickAction: EventListener;
Метод еще не доработан и может быть изменен в следующих версиях.
Методы
addClass()
Метод добавляет пользовательский CSS-стиль к элементу управления.
addClass(cssClass: string): void;
где:
cssClass – имя класса CSS-стиля.
removeClass()
Метод удаляет пользовательский CSS-стиль из элемента управления.
removeClass(cssClass: string): void;
где:
cssClass – имя класса CSS-стиля.
setIsChecked()
Метод позволяет установить стиль выбора для кнопки.
setIsChecked(value: boolean): void;
где:
value – указывает, селектирована кнопка или нет.
setState()
Метод позволяет установить состояние кнопки.
setState(state: ControlState.State): boolean;
где:
state – состояние кнопки. Подробнее: ControlState.State .
setText()
Метод позволяет установить текст кнопки.
setText(text: string): void;
где:
text – текст, который будет отображать кнопка.
getState()
Метод возвращает состояние кнопки.
getState(): ControlState.State;
setIcon()
Метод позволяет установить иконку для кнопки.
setIcon(iconClassName: string): void;
где:
iconClassName – имя класса CSS-стиля, где содержится иконка.
setFromSvgTemlate()
Метод позволяет установить иконку кнопки в svg-формате.
setFromSvgTemlate(template: string): void
где:
template – svg-элемент иконки в виде строки.
setHotkey()
Метод позволяет установить сочетание клавиш для команды.
setHotkey(hotkey: string): Button
где:
hotkey – сочетание клавиш в виде строки. Например, Ctrl+C.
onClick()
Метод вызывается при клике по кнопке.
onClick = function(event: MouseEvent): void;
Чтобы перехватить это событие, нужно переопределить этот метод:
const button = new Button("my_button_id");
button.onClick = (e) => {
// код события идет здесь
consol.log(e);
}
onMouseOver()
Метод вызывается при наведении указателя мыши над кнопкой.
onMouseOver = function (event: MouseEvent): void;
Чтобы перехватить это событие, нужно переопределить этот метод:
const button = new Button("my_button_id");
button.onMouseOver = (e) => {
// код события идет здесь
consol.log(e);
}
onMouseOut()
Метод вызывается, когда указатель мыши покидает кнопку.
onMouseOut = function (event: MouseEvent): void;
Чтобы перехватить это событие нужно переопределить этот метод:
const button = new Button("my_button_id");
button.onMouseOut = (e) => {
// код события идет здесь
consol.log(e);
}
onMouseDown()
Метод вызывается, когда когда происходит нажатие кнопки мыши над кнопкой.
По умолчанию метод перехватывает событие и не допускает установки фокуса на кнопке.
onMouseDown = function (event: MouseEvent): void {
event.preventDefault();
}
Чтобы перехватить это событие, нужно переопределить этот метод:
const button = new Button("my_button_id");
button.onMouseDown = (e) => {
// код события идет здесь
consol.log(e);
}