Module io.github.mmm.ui.api.core

Package io.github.mmm.ui.api.event

Class UiEvent

java.lang.Object

io.github.mmm.ui.api.event.UiEvent

All Implemented Interfaces:

AttributeReadProgrammatic

Direct Known Subclasses:

UiAttachingEvent, UiClickEvent, UiEnablingEvent, UiFocusEvent, UiSelectionEvent, UiValueChangeEvent, UiVisibilityEvent

public abstract class UiEvent
extends Object
implements AttributeReadProgrammatic

This is the interface for an event of the UI.

Since:

1.0.0

Constructor Summary

Constructors

Constructor	Description
UiEvent(UiWidget source, boolean programmatic)	The constructor.

Method Summary

Modifier and Type	Method	Description
UiWidget	getSource()
abstract UiEventType	getType()
boolean	isProgrammatic()

Methods inherited from class java.lang.Object

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

Constructor Details

UiEvent

public UiEvent(UiWidget source,
 boolean programmatic)

The constructor.

Parameters:

source - the source widget.

programmatic - the programmatic flag.

Method Details

getSource

public UiWidget getSource()

Returns:

the source object (widget) that sent this event.

isProgrammatic

public boolean isProgrammatic()

Specified by:

isProgrammatic in interface AttributeReadProgrammatic

Returns:

true if this event was triggered by the program (e.g. via AttributeFeatureClick.click()), false if performed by an end-user interaction (e.g. keyboard, touch, or mouse).

getType

public abstract UiEventType getType()

Returns:

the type of this event.

See Also:

• UiEventType