be.yildizgames.module.window.javafx.widget.experimental.VirtualKeyboard Maven / Gradle / Ivy
/*
* MIT License
*
* Copyright (c) 2019 Grégory Van den Borre
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
package be.yildizgames.module.window.javafx.widget.experimental;
import javafx.beans.binding.Bindings;
import javafx.beans.binding.StringBinding;
import javafx.beans.property.BooleanProperty;
import javafx.beans.property.ReadOnlyBooleanProperty;
import javafx.beans.property.ReadOnlyObjectProperty;
import javafx.beans.property.SimpleBooleanProperty;
import javafx.beans.property.SimpleStringProperty;
import javafx.beans.property.StringProperty;
import javafx.beans.value.ObservableStringValue;
import javafx.event.ActionEvent;
import javafx.event.EventHandler;
import javafx.event.EventTarget;
import javafx.event.EventType;
import javafx.geometry.Insets;
import javafx.geometry.Pos;
import javafx.scene.Node;
import javafx.scene.control.Button;
import javafx.scene.control.ToggleButton;
import javafx.scene.input.KeyCode;
import javafx.scene.input.KeyEvent;
import javafx.scene.layout.HBox;
import javafx.scene.layout.Priority;
import javafx.scene.layout.VBox;
/**
* @author Grégory Van den Borre
*/
public class VirtualKeyboard {
private final VBox root ;
/**
* Creates a Virtual Keyboard.
* @param target The node that will receive KeyEvents from this keyboard.
* If target is null, KeyEvents will be dynamically forwarded to the focus owner
* in the Scene containing this keyboard.
*/
public VirtualKeyboard(ReadOnlyObjectProperty target) {
this.root = new VBox(5);
root.setPadding(new Insets(10));
root.getStyleClass().add("virtual-keyboard");
final Modifiers modifiers = new Modifiers();
// Data for regular buttons; split into rows
final String[][] unshifted = new String[][] {
{ "`", "1", "2", "3", "4", "5", "6", "7", "8", "9", "0", "-", "=" },
{ "q", "w", "e", "r", "t", "y", "u", "i", "o", "p", "[", "]", "\\" },
{ "a", "s", "d", "f", "g", "h", "j", "k", "l", ";", "'" },
{ "z", "x", "c", "v", "b", "n", "m", ",", ".", "/" } };
final String[][] shifted = new String[][] {
{ "~", "!", "@", "#", "$", "%", "^", "&", "*", "(", ")", "_", "+" },
{ "Q", "W", "E", "R", "T", "Y", "U", "I", "O", "P", "{", "}", "|" },
{ "A", "S", "D", "F", "G", "H", "J", "K", "L", ":", "\"" },
{ "Z", "X", "C", "V", "B", "N", "M", "<", ">", "?" } };
final KeyCode[][] codes = new KeyCode[][] {
{ KeyCode.BACK_QUOTE, KeyCode.DIGIT1, KeyCode.DIGIT2, KeyCode.DIGIT3,
KeyCode.DIGIT4, KeyCode.DIGIT5, KeyCode.DIGIT6, KeyCode.DIGIT7,
KeyCode.DIGIT8, KeyCode.DIGIT9, KeyCode.DIGIT0, KeyCode.SUBTRACT,
KeyCode.EQUALS },
{ KeyCode.Q, KeyCode.W, KeyCode.E, KeyCode.R, KeyCode.T, KeyCode.Y,
KeyCode.U, KeyCode.I, KeyCode.O, KeyCode.P, KeyCode.OPEN_BRACKET,
KeyCode.CLOSE_BRACKET, KeyCode.BACK_SLASH },
{ KeyCode.A, KeyCode.S, KeyCode.D, KeyCode.F, KeyCode.G, KeyCode.H,
KeyCode.J, KeyCode.K, KeyCode.L, KeyCode.SEMICOLON, KeyCode.QUOTE },
{ KeyCode.Z, KeyCode.X, KeyCode.C, KeyCode.V, KeyCode.B, KeyCode.N,
KeyCode.M, KeyCode.COMMA, KeyCode.PERIOD, KeyCode.SLASH } };
// non-regular buttons (don't respond to Shift)
final Button escape = createNonshiftableButton("Esc", KeyCode.ESCAPE, modifiers, target);
final Button backspace = createNonshiftableButton("Backspace", KeyCode.BACK_SPACE, modifiers, target);
final Button delete = createNonshiftableButton("Del", KeyCode.DELETE, modifiers, target);
final Button enter = createNonshiftableButton("Enter", KeyCode.ENTER, modifiers, target);
final Button tab = createNonshiftableButton("Tab", KeyCode.TAB, modifiers, target);
// "Extras" to go at the left or right end of each row of buttons.
final Node[][] extraLeftButtons = new Node[][] { {escape}, {tab}, {modifiers.capsLockKey()}, {modifiers.shiftKey()} };
final Node[][] extraRightButtons = new Node[][] { {backspace}, {delete}, {enter}, {modifiers.secondShiftKey()} };
// build layout
for (int row = 0; row < unshifted.length; row++) {
HBox hbox = new HBox(5);
hbox.setAlignment(Pos.CENTER);
root.getChildren().add(hbox);
hbox.getChildren().addAll(extraLeftButtons[row]);
for (int k = 0; k < unshifted[row].length; k++) {
hbox.getChildren().add( createShiftableButton(unshifted[row][k], shifted[row][k], codes[row][k], modifiers, target));
}
hbox.getChildren().addAll(extraRightButtons[row]);
}
final Button spaceBar = createNonshiftableButton(" ", KeyCode.SPACE, modifiers, target);
spaceBar.setMaxWidth(Double.POSITIVE_INFINITY);
HBox.setHgrow(spaceBar, Priority.ALWAYS);
final HBox bottomRow = new HBox(5);
bottomRow.setAlignment(Pos.CENTER);
bottomRow.getChildren().addAll(modifiers.ctrlKey(), modifiers.altKey(),
modifiers.metaKey(), spaceBar);
root.getChildren().add(bottomRow);
}
/**
* Creates a VirtualKeyboard which uses the focusProperty of the scene to which it is attached as its target
*/
public VirtualKeyboard() {
this(null);
}
/**
* Visual component displaying this keyboard. The returned node has a style class of "virtual-keyboard".
* Buttons in the view have a style class of "virtual-keyboard-button".
* @return a view of the keyboard.
*/
public Node view() {
return root ;
}
// Creates a "regular" button that has an unshifted and shifted value
private Button createShiftableButton(final String unshifted, final String shifted,
final KeyCode code, Modifiers modifiers, final ReadOnlyObjectProperty target) {
final ReadOnlyBooleanProperty letter = new SimpleBooleanProperty( unshifted.length() == 1 && Character.isLetter(unshifted.charAt(0)));
final StringBinding text =
Bindings.when(modifiers.shiftDown().or(modifiers.capsLockOn().and(letter)))
.then(shifted)
.otherwise(unshifted);
Button button = createButton(text, code, modifiers, target);
return button;
}
// Creates a button with fixed text not responding to Shift
private Button createNonshiftableButton(final String text, final KeyCode code, final Modifiers modifiers, final ReadOnlyObjectProperty target) {
StringProperty textProperty = new SimpleStringProperty(text);
Button button = createButton(textProperty, code, modifiers, target);
return button;
}
// Creates a button with mutable text, and registers listener with it
private Button createButton(final ObservableStringValue text, final KeyCode code, final Modifiers modifiers, final ReadOnlyObjectProperty target) {
final Button button = new Button();
button.textProperty().bind(text);
// Important not to grab the focus from the target:
button.setFocusTraversable(false);
// Add a style class for css:
button.getStyleClass().add("virtual-keyboard-button");
button.setOnAction(new EventHandler() {
@Override
public void handle(ActionEvent event) {
final Node targetNode ;
if (target != null) {
targetNode = target.get();
} else {
targetNode = view().getScene().getFocusOwner();
}
if (targetNode != null) {
final String character;
if (text.get().length() == 1) {
character = text.get();
} else {
character = KeyEvent.CHAR_UNDEFINED;
}
final KeyEvent keyPressEvent = createKeyEvent(button, targetNode, KeyEvent.KEY_PRESSED, character, code, modifiers);
targetNode.fireEvent(keyPressEvent);
final KeyEvent keyReleasedEvent = createKeyEvent(button, targetNode, KeyEvent.KEY_RELEASED, character, code, modifiers);
targetNode.fireEvent(keyReleasedEvent);
if (character != KeyEvent.CHAR_UNDEFINED) {
final KeyEvent keyTypedEvent = createKeyEvent(button, targetNode, KeyEvent.KEY_TYPED, character, code, modifiers);
targetNode.fireEvent(keyTypedEvent);
}
modifiers.releaseKeys();
}
}
});
return button;
}
private KeyEvent createKeyEvent(Object source, EventTarget target,
EventType eventType, String character, KeyCode code,
Modifiers modifiers) {
return new KeyEvent(source, target, eventType, character, code.toString(),
code, modifiers.shiftDown().get(), modifiers.ctrlDown().get(),
modifiers.altDown().get(), modifiers.metaDown().get());
}
// Convenience class to bundle together the modifier keys and their selected state
private static class Modifiers {
private final ToggleButton shift;
private final ToggleButton shift2;
private final ToggleButton ctrl;
private final ToggleButton alt;
private final ToggleButton meta;
private final ToggleButton capsLock;
Modifiers() {
this.shift = createToggle("Shift");
this.shift2 = createToggle("Shift");
this.ctrl = createToggle("Ctrl");
this.alt = createToggle("Alt");
this.meta = createToggle("Meta");
this.capsLock = createToggle("Caps");
shift2.selectedProperty().bindBidirectional(shift.selectedProperty());
}
private ToggleButton createToggle(final String text) {
final ToggleButton tb = new ToggleButton(text);
tb.setFocusTraversable(false);
return tb;
}
public Node shiftKey() {
return shift;
}
public Node secondShiftKey() {
return shift2;
}
public Node ctrlKey() {
return ctrl;
}
public Node altKey() {
return alt;
}
public Node metaKey() {
return meta;
}
public Node capsLockKey() {
return capsLock;
}
public BooleanProperty shiftDown() {
return shift.selectedProperty();
}
public BooleanProperty ctrlDown() {
return ctrl.selectedProperty();
}
public BooleanProperty altDown() {
return alt.selectedProperty();
}
public BooleanProperty metaDown() {
return meta.selectedProperty();
}
public BooleanProperty capsLockOn() {
return capsLock.selectedProperty();
}
public void releaseKeys() {
shift.setSelected(false);
ctrl.setSelected(false);
alt.setSelected(false);
meta.setSelected(false);
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy