Top Description Fields Constructors Methods
com.dlsc.gemsfx.infocenter

public Class InfoCenterEvent

extends Event
Class Inheritance
Imports
javafx.event.Event, .EventType, java.util.Objects
An event class used by the InfoCenterView, especially in combination with the InfoCenterPane. The pane can react to events fired by the view so that the info center can be shown or hidden when needed / requested.

Field Summary

Modifier and TypeField and Description
public static final EventType<InfoCenterEvent>
ANY

Hides javafx.event.Event.ANY.

public static final EventType<InfoCenterEvent>
HIDE

An explicit request to hide the info center.

private Notification<?>
notification

public static final EventType<InfoCenterEvent>
NOTIFICATION_ADDED

A notification was added.

public static final EventType<InfoCenterEvent>
NOTIFICATION_CHOSEN

The user pressed on / chose the given notification.

public static final EventType<InfoCenterEvent>
NOTIFICATION_REMOVED

A notification was removed.

Inherited from javafx.event.Event:
consumedeventTypeNULL_SOURCE_TARGETtarget

Constructor Summary

AccessConstructor and Description
public
InfoCenterEvent(EventType<InfoCenterEvent>
the type of the event
eventType)

Constructs a new event without referencing a specific notification.

public
InfoCenterEvent(EventType<InfoCenterEvent>
the event type
eventType, Notification<?>
the affected notification
notification)

Constructs a new event related to the given notification.

Method Summary

Modifier and TypeMethod and Description
public final Notification<?>

Returns:

the affected notification
getNotification()

Returns the notification that was affected (null if none was affected).

Inherited from javafx.event.Event:
cloneconsumecopyForfireEventgetEventTypegetTargetisConsumed

Field Detail

ANYback to summary
public static final EventType<InfoCenterEvent> ANY

Hides javafx.event.Event.ANY.

HIDEback to summary
public static final EventType<InfoCenterEvent> HIDE

An explicit request to hide the info center.

notificationback to summary
private Notification<?> notification
NOTIFICATION_ADDEDback to summary
public static final EventType<InfoCenterEvent> NOTIFICATION_ADDED

A notification was added.

NOTIFICATION_CHOSENback to summary
public static final EventType<InfoCenterEvent> NOTIFICATION_CHOSEN

The user pressed on / chose the given notification.

NOTIFICATION_REMOVEDback to summary
public static final EventType<InfoCenterEvent> NOTIFICATION_REMOVED

A notification was removed.

Constructor Detail

InfoCenterEventback to summary
public InfoCenterEvent(EventType<InfoCenterEvent> eventType)

Constructs a new event without referencing a specific notification.

Parameters
eventType:EventType<InfoCenterEvent>

the type of the event

InfoCenterEventback to summary
public InfoCenterEvent(EventType<InfoCenterEvent> eventType, Notification<?> notification)

Constructs a new event related to the given notification.

Parameters
eventType:EventType<InfoCenterEvent>

the event type

notification:Notification<?>

the affected notification

Method Detail

getNotificationback to summary
public final Notification<?> getNotification()

Returns the notification that was affected (null if none was affected).

Returns:Notification<?>

the affected notification