Verified Owner
Top Description Fields Constructors Methods
org.jabref.gui.keyboard

public Class KeyBindingRepository

extends Object
Class Inheritance
Imports
java.util.ArrayList, .Arrays, .Comparator, .List, .Optional, .Set, .SortedMap, .TreeMap, java.util.stream.Collectors, javafx.beans.property.MapProperty, .SimpleMapProperty, javafx.collections.FXCollections, javafx.scene.input.KeyCode, .KeyCombination, .KeyEvent
Handles keyboard shortcuts. Including checking whether a keybinding matches. See matches.

Field Summary

Modifier and TypeField and Description
private final MapProperty<KeyBinding, String>
bindings

sorted by localization

Constructor Summary

AccessConstructor and Description
public
KeyBindingRepository()

public
KeyBindingRepository(SortedMap<KeyBinding, String> bindings)

public
KeyBindingRepository(List<String> bindNames, List<String> bindings)

Method Summary

Modifier and TypeMethod and Description
public static boolean

Returns:

true if matching, else false
checkKeyCombinationEquality(KeyCombination
as KeyCombination
combination, KeyEvent
as KeEvent
keyEvent)

Check if the given keyCombination equals the given keyEvent

public boolean

Returns:

true if matching, else false
checkKeyCombinationEquality(KeyBinding
as KeyBinding
binding, KeyEvent
as KeEvent
keyEvent)

Check if the given KeyBinding equals the given keyEvent

public boolean
equals(Object o)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public Optional<String>
get(KeyBinding key)

public String
get(String key)

public List<String>
getBindings()

public MapProperty<KeyBinding, String>
getBindingsProperty()

public List<String>
getBindNames()

private Optional<KeyBinding>
getKeyBinding(String key)

public SortedMap<KeyBinding, String>
getKeyBindings()

Returns the HashMap containing all key bindings.

public Optional<KeyCombination>
getKeyCombination(KeyBinding bindName)

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public Optional<KeyBinding>
mapToKeyBinding(KeyEvent keyEvent)

Searches the key bindings for the given KeyEvent.

private Set<KeyBinding>
mapToKeyBindings(KeyEvent keyEvent)

Used if the same key could be used by multiple actions

public boolean
matches(KeyEvent event, KeyBinding keyBinding)

Checks if the given KeyEvent matches the given KeyBinding.

public void
put(KeyBinding key, String value)

public void
put(String key, String value)

public void
resetToDefault(String key)

public void
resetToDefault()

public int
size()

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAlltoStringwaitwaitwait

Field Detail

bindingsback to summary
private final MapProperty<KeyBinding, String> bindings

sorted by localization

Constructor Detail

KeyBindingRepositoryback to summary
public KeyBindingRepository()
KeyBindingRepositoryback to summary
public KeyBindingRepository(SortedMap<KeyBinding, String> bindings)
KeyBindingRepositoryback to summary
public KeyBindingRepository(List<String> bindNames, List<String> bindings)

Method Detail

checkKeyCombinationEqualityback to summary
public static boolean checkKeyCombinationEquality(KeyCombination combination, KeyEvent keyEvent)

Check if the given keyCombination equals the given keyEvent

Parameters
combination:KeyCombination

as KeyCombination

keyEvent:KeyEvent

as KeEvent

Returns:boolean

true if matching, else false

checkKeyCombinationEqualityback to summary
public boolean checkKeyCombinationEquality(KeyBinding binding, KeyEvent keyEvent)

Check if the given KeyBinding equals the given keyEvent

Parameters
binding:KeyBinding

as KeyBinding

keyEvent:KeyEvent

as KeEvent

Returns:boolean

true if matching, else false

equalsback to summary
public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Annotations
@Override
getback to summary
public Optional<String> get(KeyBinding key)
getback to summary
public String get(String key)
getBindingsback to summary
public List<String> getBindings()
getBindingsPropertyback to summary
public MapProperty<KeyBinding, String> getBindingsProperty()
getBindNamesback to summary
public List<String> getBindNames()
getKeyBindingback to summary
private Optional<KeyBinding> getKeyBinding(String key)
getKeyBindingsback to summary
public SortedMap<KeyBinding, String> getKeyBindings()

Returns the HashMap containing all key bindings.

getKeyCombinationback to summary
public Optional<KeyCombination> getKeyCombination(KeyBinding bindName)
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Annotations
@Override
mapToKeyBindingback to summary
public Optional<KeyBinding> mapToKeyBinding(KeyEvent keyEvent)

Searches the key bindings for the given KeyEvent. Only the first matching key binding is returned.

If you need all matching key bindings, use mapToKeyBindings(KeyEvent) instead.

mapToKeyBindingsback to summary
private Set<KeyBinding> mapToKeyBindings(KeyEvent keyEvent)

Used if the same key could be used by multiple actions

matchesback to summary
public boolean matches(KeyEvent event, KeyBinding keyBinding)

Checks if the given KeyEvent matches the given KeyBinding.

Used if a keyboard shortcut leads to multiple actions (e.g., ESC for closing a dialog and clearing the search).

putback to summary
public void put(KeyBinding key, String value)
putback to summary
public void put(String key, String value)
resetToDefaultback to summary
public void resetToDefault(String key)
resetToDefaultback to summary
public void resetToDefault()
sizeback to summary
public int size()