GemsFX 3.10.1 · com.dlsc.gemsfx.infocenter.InfoCenterView

Modifier and Type	Class and Description
private static class	InfoCenterView.StyleableProperties

Modifier and Type	Field and Description
private BooleanProperty	autoOpenGroup
private static final boolean	DEFAULT_AUTO_OPEN_GROUP
private static final Duration	DEFAULT_EXPAND_DURATION
private static final double	DEFAULT_NOTIFICATION_SPACING
private static final Node	DEFAULT_PLACEHOLDER
private static final Duration	DEFAULT_SLIDE_IN_DURATION
private static final boolean	DEFAULT_TRANSPARENT
private ObjectProperty<Duration>	expandDuration
private final ObservableList<NotificationGroup<?, ?>>	groups
private final ObservableList<Notification<?>>	notifications
private DoubleProperty	notificationSpacing
private final ObjectProperty<Consumer<NotificationGroup<?, ?>>>	onShowAllGroupNotifications
private final ObservableList<NotificationGroup<?, ?>>	pinnedGroups
private final ObservableList<Notification<?>>	pinnedNotifications
private ObjectProperty<Node>	placeholder
private final ObjectProperty<Duration>	showAllFadeDuration
private final ObjectProperty<NotificationGroup<T, S extends Notification<T>>>	showAllGroup
private ObjectProperty<Duration>	slideInDuration
private static final String	TRANSPARENT
private BooleanProperty	transparent
private final ObservableList<Notification<?>>	unmodifiableNotifications
private final ObservableList<NotificationGroup<?, ?>>	unmodifiablePinnedGroups
private final ObservableList<Notification<?>>	unmodifiablePinnedNotifications
private final ObservableList<NotificationGroup<?, ?>>	unmodifiableUnpinnedGroups
private final ObservableList<Notification<?>>	unmodifiableUnpinnedNotifications
private final ObservableList<NotificationGroup<?, ?>>	unpinnedGroups
private final ObservableList<Notification<?>>	unpinnedNotifications
private final InvalidationListener	updateNotificationsListener
private final InvalidationListener	updatePinnedGroupsListener
private final WeakInvalidationListener	weakUpdateNotificationsListener
private final WeakInvalidationListener	weakUpdatePinnedGroupsListener

Access	Constructor and Description
public	InfoCenterView() Constructs a new view.

Method Summary

Modifier and Type	Method and Description
public final BooleanProperty	Returns: true if the group of a newly added notification should be automatically expanded autoOpenGroupProperty() Groups can be opened automatically when a notification gets added to them.
public void	clearAll()
private static StackPane	createDefaultPlaceholder()
protected Skin<?>	createDefaultSkin() Overrides javafx.scene.control.Control.createDefaultSkin. Create a new instance of the default skin for this control.
public final ObjectProperty<Duration>	Returns: the expand / collapse animation duration expandDurationProperty() The duration used for the expand / collapse animation when the view opens or closes a group.
public static List<CssMetaData<? extends Styleable, ?>>	getClassCssMetaData() Hides javafx.scene.control.Control.getClassCssMetaData. Gets the `CssMetaData` associated with this class, which may include the `CssMetaData` of its superclasses.
public List<CssMetaData<? extends Styleable, ?>>	getControlCssMetaData() Overrides javafx.scene.control.Control.getControlCssMetaData. Gets the unmodifiable list of the control's CSS-styleable properties.
public final Duration	getExpandDuration()
public final ObservableList<NotificationGroup<?, ?>>	Returns: the list of notification groups getGroups() A list of groups of notifications that will be visualized by the view.
public final double	getNotificationSpacing()
public final Consumer<NotificationGroup<?, ?>>	getOnShowAllGroupNotifications()
public final Node	getPlaceholder()
public final Duration	getShowAllFadeDuration()
public final NotificationGroup<T, S extends Notification<T>>	getShowAllGroup()
public final Duration	getSlideInDuration()
public final ObservableList<Notification<?>>	Returns: a flattened list of all notifications getUnmodifiableNotifications() A read-only list of all notifications of all groups currently added to the view.
public final ObservableList<NotificationGroup<?, ?>>	Returns: the list of pinned groups getUnmodifiablePinnedGroups() A read-only list of the currently pinned groups.
public final ObservableList<Notification<?>>	Returns: a flattened list of all notifications inside pinned groups getUnmodifiablePinnedNotifications() A read-only list of all notifications of all pinned groups currently added to the view.
public final ObservableList<NotificationGroup<?, ?>>	Returns: the list of pinned groups getUnmodifiableUnpinnedGroups() A read-only list of the currently unpinned groups.
public final ObservableList<Notification<?>>	Returns: a flattened list of all notifications inside groups that are currently not pinned getUnmodifiableUnpinnedNotifications() A read-only list of all notifications of all unpinned groups currently added to the view.
public String	getUserAgentStylesheet() Overrides javafx.scene.layout.Region.getUserAgentStylesheet. An implementation may specify its own user-agent styles for this Region, and its children, by overriding this method.
public final boolean	isAutoOpenGroup()
public final boolean	isTransparent()
public final DoubleProperty	Returns: the DoubleProperty that controls the spacing between notifications in the same group. notificationSpacingProperty() Represents the spacing between individual notification views within the same notification group.
public final ObjectProperty<Consumer<NotificationGroup<?, ?>>>	Returns: the callback that gets invoked when requesting to see all notifications of a group onShowAllGroupNotificationsProperty() A callback that gets invoked when the user presses the "show all" button of a group that has more than the maximum number of notifications linked to it.
public final ObjectProperty<Node>	Returns: the placeholder node placeholderProperty() A placeholder node that is shown when the info is empty.
public final void	setAutoOpenGroup(boolean autoOpenGroup)
public final void	setExpandDuration(Duration expandDuration)
public final void	setNotificationSpacing(double notificationSpacing)
public final void	setOnShowAllGroupNotifications(Consumer<NotificationGroup<?, ?>> onShowAllGroupNotifications)
public final void	setPlaceholder(Node placeholder)
public final void	setShowAllFadeDuration(Duration showAllFadeDuration)
public final void	setShowAllGroup(NotificationGroup<T, S extends Notification<T>> showAllGroup)
public final void	setSlideInDuration(Duration slideInDuration)
public final void	setTransparent(boolean transparent)
public final ObjectProperty<Duration>	Returns: the duration for the fade-in / fade-out animation used for toggling views showAllFadeDurationProperty() The duration used for the animation when switching between the standard view and the "show all" view.
public final ObjectProperty<NotificationGroup<T, S extends Notification<T>>>	Returns: the group for which all notifications are shown in a list view showAllGroupProperty() The group that is currently being shown in the "show all" view of the control.
public final ObjectProperty<Duration>	Returns: the slide-in duration of a new notification slideInDurationProperty() The duration used for animating the slide-in / slide-out of a notification.
public final BooleanProperty	Returns: true if the control is not transparent transparentProperty() Determines whether the control will be transparent or not.
private void	updateNotificationsList()
private void	updatePinnedAndUnpinnedGroupsList()
private void	updateStyle()

Field Detail

autoOpenGroup	back to summary
private BooleanProperty autoOpenGroup

DEFAULT_AUTO_OPEN_GROUP	back to summary
private static final boolean DEFAULT_AUTO_OPEN_GROUP

DEFAULT_EXPAND_DURATION	back to summary
private static final Duration DEFAULT_EXPAND_DURATION

DEFAULT_NOTIFICATION_SPACING	back to summary
private static final double DEFAULT_NOTIFICATION_SPACING

DEFAULT_PLACEHOLDER	back to summary
private static final Node DEFAULT_PLACEHOLDER

DEFAULT_SLIDE_IN_DURATION	back to summary
private static final Duration DEFAULT_SLIDE_IN_DURATION

DEFAULT_TRANSPARENT	back to summary
private static final boolean DEFAULT_TRANSPARENT

expandDuration	back to summary
private ObjectProperty<Duration> expandDuration

groups	back to summary
private final ObservableList<NotificationGroup<?, ?>> groups

notifications	back to summary
private final ObservableList<Notification<?>> notifications

notificationSpacing	back to summary
private DoubleProperty notificationSpacing

onShowAllGroupNotifications	back to summary
private final ObjectProperty<Consumer<NotificationGroup<?, ?>>> onShowAllGroupNotifications

pinnedGroups	back to summary
private final ObservableList<NotificationGroup<?, ?>> pinnedGroups

pinnedNotifications	back to summary
private final ObservableList<Notification<?>> pinnedNotifications

placeholder	back to summary
private ObjectProperty<Node> placeholder

showAllFadeDuration	back to summary
private final ObjectProperty<Duration> showAllFadeDuration

showAllGroup	back to summary
private final ObjectProperty<NotificationGroup<T, S extends Notification<T>>> showAllGroup

slideInDuration	back to summary
private ObjectProperty<Duration> slideInDuration

TRANSPARENT	back to summary
private static final String TRANSPARENT

transparent	back to summary
private BooleanProperty transparent

unmodifiableNotifications	back to summary
private final ObservableList<Notification<?>> unmodifiableNotifications

unmodifiablePinnedGroups	back to summary
private final ObservableList<NotificationGroup<?, ?>> unmodifiablePinnedGroups

unmodifiablePinnedNotifications	back to summary
private final ObservableList<Notification<?>> unmodifiablePinnedNotifications

unmodifiableUnpinnedGroups	back to summary
private final ObservableList<NotificationGroup<?, ?>> unmodifiableUnpinnedGroups

unmodifiableUnpinnedNotifications	back to summary
private final ObservableList<Notification<?>> unmodifiableUnpinnedNotifications

unpinnedGroups	back to summary
private final ObservableList<NotificationGroup<?, ?>> unpinnedGroups

unpinnedNotifications	back to summary
private final ObservableList<Notification<?>> unpinnedNotifications

updateNotificationsListener	back to summary
private final InvalidationListener updateNotificationsListener

updatePinnedGroupsListener	back to summary
private final InvalidationListener updatePinnedGroupsListener

weakUpdateNotificationsListener	back to summary
private final WeakInvalidationListener weakUpdateNotificationsListener

weakUpdatePinnedGroupsListener	back to summary
private final WeakInvalidationListener weakUpdatePinnedGroupsListener

Constructor Detail

InfoCenterView	back to summary
public InfoCenterView() Constructs a new view.

Method Detail

autoOpenGroupProperty	back to summary
public final BooleanProperty autoOpenGroupProperty() Groups can be opened automatically when a notification gets added to them. The default is false. Returns:BooleanProperty true if the group of a newly added notification should be automatically expanded

autoOpenGroupProperty

back to summary

public final BooleanProperty autoOpenGroupProperty()

Groups can be opened automatically when a notification gets added to them. The default is false.

Returns:BooleanProperty: true if the group of a newly added notification should be automatically expanded

clearAll	back to summary
public void clearAll()

createDefaultPlaceholder	back to summary
private static StackPane createDefaultPlaceholder()

createDefaultSkin back to summary

createDefaultSkin	back to summary
protected Skin<?> createDefaultSkin() Overrides javafx.scene.control.Control.createDefaultSkin. Doc from javafx.scene.control.Control.createDefaultSkin. Create a new instance of the default skin for this control. This is called to create a skin for the control if no skin is provided via CSS `-fx-skin` or set explicitly in a sub-class with `setSkin(...)`. Annotations @Override

protected Skin<?> createDefaultSkin()

Overrides javafx.scene.control.Control.createDefaultSkin.

Doc from javafx.scene.control.Control.createDefaultSkin.

Create a new instance of the default skin for this control. This is called to create a skin for the control if no skin is provided via CSS -fx-skin or set explicitly in a sub-class with setSkin(...).

Annotations

@Override

expandDurationProperty	back to summary
public final ObjectProperty<Duration> expandDurationProperty() The duration used for the expand / collapse animation when the view opens or closes a group. Returns:ObjectProperty<Duration> the expand / collapse animation duration

expandDurationProperty

back to summary

public final ObjectProperty<Duration> expandDurationProperty()

The duration used for the expand / collapse animation when the view opens or closes a group.

Returns:ObjectProperty<Duration>: the expand / collapse animation duration

getClassCssMetaData back to summary

public static List<CssMetaData<? extends Styleable, ?>> getClassCssMetaData()

Hides javafx.scene.control.Control.getClassCssMetaData.

Doc from javafx.scene.control.Control.getClassCssMetaData.

Gets the CssMetaData associated with this class, which may include the CssMetaData of its superclasses.

getControlCssMetaData

back to summary

public List<CssMetaData<? extends Styleable, ?>> getControlCssMetaData()

Overrides javafx.scene.control.Control.getControlCssMetaData.

Doc from javafx.scene.control.Control.getControlCssMetaData.

Gets the unmodifiable list of the control's CSS-styleable properties.

Annotations

@Override

getExpandDuration	back to summary
public final Duration getExpandDuration()

getGroups	back to summary
public final ObservableList<NotificationGroup<?, ?>> getGroups() A list of groups of notifications that will be visualized by the view. Every notification has to be a member of a group. Returns:ObservableList<NotificationGroup<?, ?>> the list of notification groups

getGroups

back to summary

public final ObservableList<NotificationGroup<?, ?>> getGroups()

A list of groups of notifications that will be visualized by the view. Every notification has to be a member of a group.

Returns:ObservableList<NotificationGroup<?, ?>>: the list of notification groups

getNotificationSpacing	back to summary
public final double getNotificationSpacing()

getOnShowAllGroupNotifications	back to summary
public final Consumer<NotificationGroup<?, ?>> getOnShowAllGroupNotifications()

getPlaceholder	back to summary
public final Node getPlaceholder()

getShowAllFadeDuration	back to summary
public final Duration getShowAllFadeDuration()

getShowAllGroup	back to summary
public final NotificationGroup<T, S extends Notification<T>> getShowAllGroup()

getSlideInDuration	back to summary
public final Duration getSlideInDuration()

getUnmodifiableNotifications

back to summary

public final ObservableList<Notification<?>> getUnmodifiableNotifications()

A read-only list of all notifications of all groups currently added to the view.

Returns:ObservableList<Notification<?>>: a flattened list of all notifications

getUnmodifiablePinnedGroups

back to summary

public final ObservableList<NotificationGroup<?, ?>> getUnmodifiablePinnedGroups()

A read-only list of the currently pinned groups.

Returns:ObservableList<NotificationGroup<?, ?>>: the list of pinned groups

getUnmodifiablePinnedNotifications

back to summary

public final ObservableList<Notification<?>> getUnmodifiablePinnedNotifications()

A read-only list of all notifications of all pinned groups currently added to the view.

Returns:ObservableList<Notification<?>>: a flattened list of all notifications inside pinned groups

getUnmodifiableUnpinnedGroups

back to summary

public final ObservableList<NotificationGroup<?, ?>> getUnmodifiableUnpinnedGroups()

A read-only list of the currently unpinned groups.

Returns:ObservableList<NotificationGroup<?, ?>>: the list of pinned groups

getUnmodifiableUnpinnedNotifications

back to summary

public final ObservableList<Notification<?>> getUnmodifiableUnpinnedNotifications()

A read-only list of all notifications of all unpinned groups currently added to the view.

Returns:ObservableList<Notification<?>>: a flattened list of all notifications inside groups that are currently not pinned

getUserAgentStylesheet back to summary

public String getUserAgentStylesheet()

Overrides javafx.scene.layout.Region.getUserAgentStylesheet.

Doc from javafx.scene.layout.Region.getUserAgentStylesheet.

An implementation may specify its own user-agent styles for this Region, and its children, by overriding this method. These styles are used in addition to whatever user-agent stylesheets are in use. This provides a mechanism for third parties to introduce styles for custom controls.

The URL is a hierarchical URI of the form [scheme:][//authority][path]. If the URL does not have a [scheme:] component, the URL is considered to be the [path] component only. Any leading '/' character of the [path] is ignored and the [path] is treated as a path relative to the root of the application's classpath.

Subclasses overriding this method should not assume any particular implementation approach as to the number and frequency with which it is called. For this reason, attempting any kind of dynamic implementation (i.e. returning different user agent stylesheet values) based on some state change is highly discouraged, as there is no guarantee when, or even if, this method will be called. Some JavaFX CSS implementations may choose to cache this response for an indefinite period of time, and therefore there should be no expectation around when this method is called.



package com.example.javafx.app;

import javafx.application.Application;
import javafx.scene.Group;
import javafx.scene.Scene;
import javafx.stage.Stage;

public class MyApp extends Application {

    @Override public void start(Stage stage) {
        Scene scene = new Scene(new Group());
        scene.getStylesheets().add("/com/example/javafx/app/mystyles.css");
        stage.setScene(scene);
        stage.show();
    }

    public static void main(String[] args) {
        launch(args);
    }
}

For additional information about using CSS with the scene graph, see the CSS Reference Guide.

Annotations

@Override

isAutoOpenGroup	back to summary
public final boolean isAutoOpenGroup()

isTransparent	back to summary
public final boolean isTransparent()

notificationSpacingProperty

back to summary

public final DoubleProperty notificationSpacingProperty()

Represents the spacing between individual notification views within the same notification group. This property allows adjustment of the vertical gap depending on the layout of the notification container. The default value is 10.0.

Returns:DoubleProperty: the DoubleProperty that controls the spacing between notifications in the same group.

onShowAllGroupNotificationsProperty

back to summary

public final ObjectProperty<Consumer<NotificationGroup<?, ?>>> onShowAllGroupNotificationsProperty()

A callback that gets invoked when the user presses the "show all" button of a group that has more than the maximum number of notifications linked to it. The default callback will switch to a list view control which will then be able to show all notifications of that group. Applications can choose to display the notifications in a different place, e.g. in a dialog.

Returns:ObjectProperty<Consumer<NotificationGroup<?, ?>>>: the callback that gets invoked when requesting to see all notifications of a group

placeholderProperty

back to summary

public final ObjectProperty<Node> placeholderProperty()

A placeholder node that is shown when the info is empty.

Returns:ObjectProperty<Node>: the placeholder node

setAutoOpenGroup	back to summary
public final void setAutoOpenGroup(boolean autoOpenGroup)

setExpandDuration	back to summary
public final void setExpandDuration(Duration expandDuration)

setNotificationSpacing	back to summary
public final void setNotificationSpacing(double notificationSpacing)

setOnShowAllGroupNotifications	back to summary
public final void setOnShowAllGroupNotifications(Consumer<NotificationGroup<?, ?>> onShowAllGroupNotifications)

setPlaceholder	back to summary
public final void setPlaceholder(Node placeholder)

setShowAllFadeDuration	back to summary
public final void setShowAllFadeDuration(Duration showAllFadeDuration)

setShowAllGroup	back to summary
public final void setShowAllGroup(NotificationGroup<T, S extends Notification<T>> showAllGroup)

setSlideInDuration	back to summary
public final void setSlideInDuration(Duration slideInDuration)

setTransparent	back to summary
public final void setTransparent(boolean transparent)

showAllFadeDurationProperty

back to summary

public final ObjectProperty<Duration> showAllFadeDurationProperty()

The duration used for the animation when switching between the standard view and the "show all" view.

Returns:ObjectProperty<Duration>: the duration for the fade-in / fade-out animation used for toggling views

showAllGroupProperty

back to summary

public final ObjectProperty<NotificationGroup<T, S extends Notification<T>>> showAllGroupProperty()

The group that is currently being shown in the "show all" view of the control.

Returns:ObjectProperty<NotificationGroup<T, S extends Notification<T>>>: the group for which all notifications are shown in a list view

slideInDurationProperty

back to summary

public final ObjectProperty<Duration> slideInDurationProperty()

The duration used for animating the slide-in / slide-out of a notification.

Returns:ObjectProperty<Duration>: the slide-in duration of a new notification

transparentProperty

back to summary

public final BooleanProperty transparentProperty()

Determines whether the control will be transparent or not. By default, a semi-transparent black background is showing.

Returns:BooleanProperty: true if the control is not transparent

updateNotificationsList	back to summary
private void updateNotificationsList()

updatePinnedAndUnpinnedGroupsList	back to summary
private void updatePinnedAndUnpinnedGroupsList()

updateStyle	back to summary
private void updateStyle()

public Class InfoCenterView

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class InfoCenterView.StyleableProperties

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Modifier and Type	Field and Description
private static final CssMetaData<InfoCenterView, Number>	NOTIFICATION_SPACING
private static final List<CssMetaData<? extends Styleable, ?>>	STYLEABLES