Interface BasePaneListener<T extends BasePane>

All Known Subinterfaces:

WindowListener

All Known Implementing Classes:

WindowListenerAdapter

public interface BasePaneListener<T extends BasePane>

Base listener interface having callback methods for events relating to BasePane (and Window, which extends BasePane) so that you can be notified by a callback when certain events happen. Assume it is the GUI thread that will call these methods. You typically use this through WindowListener and calling Window.addWindowListener(WindowListener)

Method Summary

Modifier and Type	Method	Description
void	onInput(T basePane, KeyStroke keyStroke, AtomicBoolean deliverEvent)	Called when a user input is about to be delivered to the focused Interactable inside the BasePane, but before it is actually delivered.
void	onUnhandledInput(T basePane, KeyStroke keyStroke, AtomicBoolean hasBeenHandled)	Called when a user entered some input which wasn't handled by the focused component.

Method Details

onInput

void onInput(T basePane,
 KeyStroke keyStroke,
 AtomicBoolean deliverEvent)

Called when a user input is about to be delivered to the focused Interactable inside the BasePane, but before it is actually delivered. You can catch it and prevent it from being passed into the component by using the deliverEvent parameter and setting it to false.

Parameters:

basePane - Base pane that got the input event

keyStroke - The actual input event

deliverEvent - Set to true automatically, if you change it to false it will prevent the GUI from passing the input event on to the focused Interactable

onUnhandledInput

void onUnhandledInput(T basePane,
 KeyStroke keyStroke,
 AtomicBoolean hasBeenHandled)

Called when a user entered some input which wasn't handled by the focused component. This allows you to catch it at a BasePane (or Window) level and prevent it from being reported to the TextGUI as an unhandled input event.

Parameters:

basePane - BasePane that got the input event

keyStroke - The unhandled input event

hasBeenHandled - Initially set to false, if you change it to true then the event will not be reported as an unhandled input to the TextGUI