Package com.sun.javafx.scene.control.behavior

Class KeyBinding

java.lang.Object

com.sun.javafx.scene.control.behavior.KeyBinding

public class KeyBinding
extends Object

KeyBindings are used to describe which action should occur based on some KeyEvent state and Control state. These bindings are used to populate the keyBindings variable on BehaviorBase. The KeyBinding can be subclassed to add additional matching criteria. A match in a subclass should always have a specificity that is 1 greater than its superclass in the case of a match, or 0 in the case where there is no match. Note that this API is, at present, quite odd in that you use a constructor and then use shift(), ctrl(), alt(), or meta() separately. It gave me an object-literal like approach but isn't ideal. We will want some builder approach here (similar as in other places).

Constructor Summary

Constructors

Constructor	Description
KeyBinding(KeyCode code, String action)
KeyBinding(KeyCode code, EventType<KeyEvent> type, String action)

Method Summary

Modifier and Type	Method	Description
KeyBinding	alt()
KeyBinding	alt(OptionalBoolean value)
KeyBinding	ctrl()
KeyBinding	ctrl(OptionalBoolean value)
final String	getAction()
final OptionalBoolean	getAlt()
final KeyCode	getCode()
final OptionalBoolean	getCtrl()
final OptionalBoolean	getMeta()
final OptionalBoolean	getShift()
int	getSpecificity(Control control, KeyEvent event)
final EventType<KeyEvent>	getType()
KeyBinding	meta()
KeyBinding	meta(OptionalBoolean value)
KeyBinding	shift()
KeyBinding	shift(OptionalBoolean value)
KeyBinding	shortcut()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

KeyBinding

public KeyBinding(KeyCode code,
 String action)

KeyBinding

public KeyBinding(KeyCode code,
 EventType<KeyEvent> type,
 String action)

Method Details

shift

public KeyBinding shift()

shift

public KeyBinding shift(OptionalBoolean value)

ctrl

public KeyBinding ctrl()

ctrl

public KeyBinding ctrl(OptionalBoolean value)

alt

public KeyBinding alt()

alt

public KeyBinding alt(OptionalBoolean value)

meta

public KeyBinding meta()

meta

public KeyBinding meta(OptionalBoolean value)

shortcut

public KeyBinding shortcut()

getCode

public final KeyCode getCode()

getType

public final EventType<KeyEvent> getType()

getAction

public final String getAction()

getShift

public final OptionalBoolean getShift()

getCtrl

public final OptionalBoolean getCtrl()

getAlt

public final OptionalBoolean getAlt()

getMeta

public final OptionalBoolean getMeta()

getSpecificity

public int getSpecificity(Control control,
 KeyEvent event)

toString

public String toString()

Overrides:

toString in class Object