Package org.hexworks.zircon.api.uievent

Types

ComponentEvent
Link copied to clipboard
common
data class ComponentEvent(type: ComponentEventType) : UIEvent
A ComponentEvent is a component-specific event which only happens in the context of Components (not for plain TileGrids and Screens.
ComponentEventMatcher
Link copied to clipboard
common
data class ComponentEventMatcher(type: ComponentEventType?)
ComponentEventSource
Link copied to clipboard
common
interface ComponentEventSource
An ComponentEventSource is an object which emits ComponentEvents and can be used to listen to those events.
ComponentEventType
Link copied to clipboard
common
enum ComponentEventType : Enum<ComponentEventType> , UIEventType
Event type for the different kinds of component evens.
KeyboardEvent
Link copied to clipboard
common
data class KeyboardEvent(type: KeyboardEventType, key: String, code: KeyCode, ctrlDown: Boolean, altDown: Boolean, metaDown: Boolean, shiftDown: Boolean) : UIEvent
KeyboardEventMatcher
Link copied to clipboard
common
data class KeyboardEventMatcher(type: KeyboardEventType?, key: String?, code: KeyCode?, ctrlDown: Boolean?, altDown: Boolean?, metaDown: Boolean?, shiftDown: Boolean?)
KeyboardEventType
Link copied to clipboard
common
enum KeyboardEventType : Enum<KeyboardEventType> , UIEventType
Represents the possible types of keyboard events.
KeyCode
Link copied to clipboard
common
enum KeyCode : Enum<KeyCode>
MouseEvent
Link copied to clipboard
common
data class MouseEvent(type: MouseEventType, button: Int, position: Position) : UIEvent
MouseEventMatcher
Link copied to clipboard
common
data class MouseEventMatcher(type: MouseEventType?, button: Int?, position: Position?)
MouseEventType
Link copied to clipboard
common
enum MouseEventType : Enum<MouseEventType> , UIEventType
Event type for the different kinds of mouse actions supported.
Pass
Link copied to clipboard
common
object Pass : UIEventResponse
Pass is the default UIEventResponse which indicates that no event processing happened.
PreventDefault
Link copied to clipboard
common
object PreventDefault : UIEventResponse
PreventDefault is an UIEventResponse which requests the prevention of any default actions for the given event.
Processed
Link copied to clipboard
common
object Processed : UIEventResponse
Processed indicates that at least one event handler processed the UIEvent but it did not stop propagation nor the default actions.
StopPropagation
Link copied to clipboard
common
object StopPropagation : UIEventResponse
StopPropagation will not only prevent default actions but stops propagation altogether so the event won't reach any other listener.
UIEvent
Link copied to clipboard
common
interface UIEvent
An UIEvent represents an event which happens on the UI and supports event propagation (see UIEventPhase).
UIEventPhase
Link copied to clipboard
common
enum UIEventPhase : Enum<UIEventPhase>
Represents the possible phases of event propagation for an UIEvent which is very similar to how it works in a browser.
UIEventResponse
Link copied to clipboard
common
sealed class UIEventResponse
Represents the possible responses to an UIEvent.
UIEventSource
Link copied to clipboard
common
interface UIEventSource
An UIEventSource is an object which emits UIEvents and can be used to listen to those events.
UIEventType
Link copied to clipboard
common
interface UIEventType
Interface for representing UI event types for a given UIEvent.