public Class KeyBindingViewModel

Class Inheritance

extends Object

java.lang.Object
org.jabref.gui.preferences.keybindings.KeyBindingViewModel

Imports

java.util.Optional, javafx.beans.property.SimpleStringProperty, .StringProperty, javafx.collections.FXCollections, .ObservableList, javafx.scene.input.KeyCode, .KeyCombination, .KeyEvent, org.jabref.gui.icon.IconTheme, .JabRefIcon, org.jabref.gui.keyboard.KeyBinding, .KeyBindingCategory, .KeyBindingRepository, org.jabref.logic.os.OS

This class represents a view model for objects of the KeyBinding class. It has two properties representing the localized name of an action and its key bind. It can also represent a key binding category instead of a key bind itself.

Field Summary

Modifier and Type	Field and Description
private final KeyBindingCategory	category
private final ObservableList<KeyBindingViewModel>	children
private final SimpleStringProperty	displayName
private KeyBinding	keyBinding
private final KeyBindingRepository	keyBindingRepository
private String	realBinding
private final SimpleStringProperty	shownBinding

Constructor Summary

Access	Constructor and Description
public	KeyBindingViewModel(KeyBindingRepository keyBindingRepository, KeyBinding keyBinding, String binding)
public	KeyBindingViewModel(KeyBindingRepository keyBindingRepository, KeyBindingCategory category)

Method Summary

Modifier and Type	Method and Description
public void	clear()
public String	getBinding()
public ObservableList<KeyBindingViewModel>	getChildren()
public Optional<JabRefIcon>	getClearIcon()
public KeyBinding	getKeyBinding()
public Optional<JabRefIcon>	getResetIcon()
public boolean	isCategory()
public StringProperty	nameProperty()
public void	resetToDefault() This method will reset the key bind of this models KeyBinding object to it's default bind
private void	setBinding(String bind)
private void	setDisplayName()
public boolean	Returns: true if the KeyEvent is a valid binding, false else setNewBinding(KeyEvent as KeyEvent evt) Sets a a new key bind to this objects key binding object if the given key event is a valid combination of keys.
public StringProperty	shownBindingProperty()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

category	back to summary
private final KeyBindingCategory category

children	back to summary
private final ObservableList<KeyBindingViewModel> children

displayName	back to summary
private final SimpleStringProperty displayName

keyBinding	back to summary
private KeyBinding keyBinding

keyBindingRepository	back to summary
private final KeyBindingRepository keyBindingRepository

realBinding	back to summary
private String realBinding

shownBinding	back to summary
private final SimpleStringProperty shownBinding

Constructor Detail

KeyBindingViewModel	back to summary
public KeyBindingViewModel(KeyBindingRepository keyBindingRepository, KeyBinding keyBinding, String binding)

KeyBindingViewModel	back to summary
public KeyBindingViewModel(KeyBindingRepository keyBindingRepository, KeyBindingCategory category)

Method Detail

clear	back to summary
public void clear()

getBinding	back to summary
public String getBinding()

getChildren	back to summary
public ObservableList<KeyBindingViewModel> getChildren()

getClearIcon	back to summary
public Optional<JabRefIcon> getClearIcon()

getKeyBinding	back to summary
public KeyBinding getKeyBinding()

getResetIcon	back to summary
public Optional<JabRefIcon> getResetIcon()

isCategory	back to summary
public boolean isCategory()

nameProperty	back to summary
public StringProperty nameProperty()

resetToDefault	back to summary
public void resetToDefault() This method will reset the key bind of this models KeyBinding object to it's default bind

setBinding	back to summary
private void setBinding(String bind)

setDisplayName	back to summary
private void setDisplayName()

setNewBinding	back to summary
public boolean setNewBinding(KeyEvent evt) Sets a a new key bind to this objects key binding object if the given key event is a valid combination of keys. Parameters evt:KeyEvent as KeyEvent Returns:boolean true if the KeyEvent is a valid binding, false else

setNewBinding

back to summary

public boolean setNewBinding(KeyEvent evt)

Sets a a new key bind to this objects key binding object if the given key event is a valid combination of keys.

Parameters

evt:KeyEvent: as KeyEvent

Returns:boolean

true if the KeyEvent is a valid binding, false else

shownBindingProperty	back to summary
public StringProperty shownBindingProperty()