Module com.dlsc.gemsfx

Package com.dlsc.gemsfx.infocenter

Class InfoCenterEvent

java.lang.Object

java.util.EventObject

javafx.event.Event

com.dlsc.gemsfx.infocenter.InfoCenterEvent

All Implemented Interfaces:

Serializable, Cloneable

public class InfoCenterEvent
extends javafx.event.Event

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.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final javafx.event.EventType<InfoCenterEvent>	ANY
static final javafx.event.EventType<InfoCenterEvent>	HIDE	An explicit request to hide the info center.
static final javafx.event.EventType<InfoCenterEvent>	NOTIFICATION_ADDED	A notification was added.
static final javafx.event.EventType<InfoCenterEvent>	NOTIFICATION_CHOSEN	The user pressed on / chose the given notification.
static final javafx.event.EventType<InfoCenterEvent>	NOTIFICATION_REMOVED	A notification was removed.

Fields inherited from class javafx.event.Event

consumed, eventType, NULL_SOURCE_TARGET, target

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor	Description
InfoCenterEvent(javafx.event.EventType<InfoCenterEvent> eventType)	Constructs a new event without referencing a specific notification.
InfoCenterEvent(javafx.event.EventType<InfoCenterEvent> eventType, Notification<?> notification)	Constructs a new event related to the given notification.

Method Summary

Modifier and Type	Method	Description
final Notification<?>	getNotification()	Returns the notification that was affected (null if none was affected).

Methods inherited from class javafx.event.Event

clone, consume, copyFor, fireEvent, getEventType, 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 Details

ANY

public static final javafx.event.EventType<InfoCenterEvent> ANY

NOTIFICATION_CHOSEN

public static final javafx.event.EventType<InfoCenterEvent> NOTIFICATION_CHOSEN

The user pressed on / chose the given notification.

NOTIFICATION_ADDED

public static final javafx.event.EventType<InfoCenterEvent> NOTIFICATION_ADDED

A notification was added.

NOTIFICATION_REMOVED

public static final javafx.event.EventType<InfoCenterEvent> NOTIFICATION_REMOVED

A notification was removed.

HIDE

public static final javafx.event.EventType<InfoCenterEvent> HIDE

An explicit request to hide the info center.

Constructor Details

InfoCenterEvent

public InfoCenterEvent(javafx.event.EventType<InfoCenterEvent> eventType)

Constructs a new event without referencing a specific notification.

Parameters:

eventType - the type of the event

InfoCenterEvent

public InfoCenterEvent(javafx.event.EventType<InfoCenterEvent> eventType,
 Notification<?> notification)

Constructs a new event related to the given notification.

Parameters:

eventType - the event type

notification - the affected notification

Method Details

getNotification

public final Notification<?> getNotification()

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

Returns:

the affected notification