Package dk.gtz.graphedit.util

Class Keymap

java.lang.Object

dk.gtz.graphedit.util.Keymap

public class Keymap
extends Object

A class to manage keybindings.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	Keymap.Keybind	A record to store a graphedit keybinding.

Constructor Summary

Constructors

Constructor	Description
Keymap()	Construct a new Keymap instance.

Method Summary

Modifier and Type	Method	Description
Map<javafx.scene.input.KeyCombination,Keymap.Keybind>	get()	Get the keymap.
void	onKeymapOverridden(dk.yalibs.yafunc.IRunnable1<Map.Entry<javafx.scene.input.KeyCombination,Keymap.Keybind>> handler)	Add a handler to be called when a keymap is overridden.
void	onNewKeymap(dk.yalibs.yafunc.IRunnable1<Map.Entry<javafx.scene.input.KeyCombination,Keymap.Keybind>> handler)	Add a handler to be called when a new keymap is set.
void	set(String keycombination, Runnable action, String description)	Set a keybinding with no category.
void	set(String keycombination, Runnable action, String description, String category)	Set a keybinding with a category.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Keymap

public Keymap()

Construct a new Keymap instance.

Method Details

set

public void set(String keycombination,
 Runnable action,
 String description)

Set a keybinding with no category. See set(String, Runnable, String, String) for an example.

Parameters:

keycombination - The keycombination to bind the action to.

action - The action to run when the keycombination is pressed.

description - A description of the action.

set

public void set(String keycombination,
 Runnable action,
 String description,
 String category)

Set a keybinding with a category. The category can be used to group keybindings and will be displayed in the top menubar. Note that if the keybinding is already set, the old value will be overridden. Example:

 keymap.set("Shortcut+O", () -> EditorActions.openProject, "Open a project", "File");
 

This will bind the action EditorActions.openProject to the keycombination Shortcut+O and display it under the 'File > Open a project' menu.

Parameters:

keycombination - The keycombination to bind the action to.

action - The action to run when the keycombination is pressed.

description - A description of the action.

category - The category to group the keybinding under.

get

public Map<javafx.scene.input.KeyCombination,Keymap.Keybind> get()

Get the keymap.

Returns:

The keymap.

onNewKeymap

public void onNewKeymap(dk.yalibs.yafunc.IRunnable1<Map.Entry<javafx.scene.input.KeyCombination,Keymap.Keybind>> handler)

Add a handler to be called when a new keymap is set. Note that this will also be called when a keymap is overridden.

Parameters:

handler - The handler to add.

onKeymapOverridden

public void onKeymapOverridden(dk.yalibs.yafunc.IRunnable1<Map.Entry<javafx.scene.input.KeyCombination,Keymap.Keybind>> handler)

Add a handler to be called when a keymap is overridden.

Parameters:

handler - The handler to add.