javafx.scene.input.KeyEventBinding Maven / Gradle / Ivy
/*
* Copyright (c) 2020 JFXCore. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 or later,
* as published by the Free Software Foundation. This particular file is
* designated as subject to the "Classpath" exception as provided in the
* LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*/
package javafx.scene.input;
import javafx.beans.NamedArg;
import javafx.beans.property.ObjectProperty;
import javafx.beans.property.SimpleObjectProperty;
import javafx.event.EventType;
/**
* Executes a command when a {@link KeyEvent} with a specified {@link KeyCode} was received.
*/
public class KeyEventBinding extends EventBinding {
private final ObjectProperty keyCode = new SimpleObjectProperty<>(this, "keyCode");
public KeyEventBinding() {
super(KeyEvent.KEY_RELEASED);
}
public KeyEventBinding(@NamedArg("eventType") EventType eventType) {
super(eventType);
}
public ObjectProperty keyCodeProperty() {
return keyCode;
}
public KeyCode getKeyCode() {
return keyCode.get();
}
public void setKeyCode(KeyCode keyCode) {
this.keyCode.set(keyCode);
}
@Override
public void handle(KeyEvent event) {
if (event.getCode() == keyCode.get()) {
fireCommand();
}
}
}