com.yworks.yfiles.view

Class CompoundKeyEvent

java.lang.Object

java.util.EventObject

javafx.event.Event

javafx.scene.input.InputEvent

com.yworks.yfiles.view.CompoundKeyEvent

All Implemented Interfaces:

IEventArgs, Serializable, Cloneable

public class CompoundKeyEvent
extends InputEvent
implements IEventArgs

Event argument class for key events that carries the type of event.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static EventType<CompoundKeyEvent>	ANY Any CompoundKeyEvent.
static EventType<CompoundKeyEvent>	NONE Neither Pressed, nor Typed, nor Released.
static EventType<CompoundKeyEvent>	PRESSED The key has been pressed.
static EventType<CompoundKeyEvent>	RELEASED The key has been released.
static EventType<CompoundKeyEvent>	TYPED The character has been typed.

Fields inherited from class javafx.event.Event

consumed, NULL_SOURCE_TARGET, target

Fields inherited from class java.util.EventObject

source

Fields inherited from interface com.yworks.yfiles.utils.IEventArgs

EMPTY

Constructor Summary

Constructors

Constructor and Description
CompoundKeyEvent(Object source, EventType<CompoundKeyEvent> type, KeyEvent keyEvent) Constructs a new event.
CompoundKeyEvent(Object source, KeyEvent keyEvent) Constructs a new event for a key that has been typed.

Method Summary

Modifier and Type	Method and Description
KeyCode	getKeyCode() Returns the key code.
KeyEvent	getKeyEvent() Returns the original KeyEvent.
EventType<CompoundKeyEvent>	getKeyEventType() Gets the type of the event.
String	getKeyValue() Returns the value of the character that has been typed.
ModifierKeys	getModifiers() Returns the state of the modifiers at the time of the event.
boolean	isHandled() Gets a value that indicates whether this event has been handled.
void	setHandled(boolean value) Sets a value that indicates whether this event has been handled.

Methods inherited from class javafx.scene.input.InputEvent

getEventType

Methods inherited from class javafx.event.Event

clone, consume, copyFor, fireEvent, getTarget, isConsumed

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Field Detail

ANY

public static final EventType<CompoundKeyEvent> ANY

Any CompoundKeyEvent.

NONE

public static final EventType<CompoundKeyEvent> NONE

Neither Pressed, nor Typed, nor Released.

PRESSED

public static final EventType<CompoundKeyEvent> PRESSED

The key has been pressed.

RELEASED

public static final EventType<CompoundKeyEvent> RELEASED

The key has been released.

TYPED

public static final EventType<CompoundKeyEvent> TYPED

The character has been typed.

Constructor Detail

CompoundKeyEvent

public CompoundKeyEvent(Object source,
                        EventType<CompoundKeyEvent> type,
                        KeyEvent keyEvent)

Constructs a new event.

Parameters:

type - The type to use

keyEvent - The KeyEvent to use.

CompoundKeyEvent

public CompoundKeyEvent(Object source,
                        KeyEvent keyEvent)

Constructs a new event for a key that has been typed.

Method Detail

getKeyCode

public final KeyCode getKeyCode()

Returns the key code. This will be Keys.None for typed event.

Returns:

The KeyCode.

getKeyEvent

public final KeyEvent getKeyEvent()

Returns the original KeyEvent.

Returns:

The key event.

getKeyEventType

public final EventType<CompoundKeyEvent> getKeyEventType()

Gets the type of the event.

Returns:

The EventType.

getKeyValue

public final String getKeyValue()

Returns the value of the character that has been typed.

Returns:

The KeyValue.

getModifiers

public final ModifierKeys getModifiers()

Returns the state of the modifiers at the time of the event.

Returns:

The Modifiers.

isHandled

public final boolean isHandled()

Gets a value that indicates whether this event has been handled.

Returns:

The Handled.

See Also:

setHandled(boolean)

setHandled

public final void setHandled(boolean value)

Sets a value that indicates whether this event has been handled.

Parameters:

value - The Handled to set.

See Also:

isHandled()