Package com.nomagic.magicdraw.ui.notification

Class NotificationViewBuilder

java.lang.Object

com.nomagic.magicdraw.ui.notification.NotificationViewBuilder

@OpenApiAll
public abstract class NotificationViewBuilder
extends java.lang.Object

Base class for MagicDraw notification builders, that creates and shows notification popups. User who wants to display his own notification popups in MagicDraw, must create builder implementing this interface and register it with NotificationManager

Constructor Summary

Constructors

Constructor	Description
NotificationViewBuilder()

Method Summary

Modifier and Type	Method	Description
abstract java.awt.Component	createNotificationView(AbstractNotification notification, java.awt.Component owner, NotificationViewConfig config)	Constructs popup that displays message to the user
abstract void	hideNotification(java.lang.String notificationID)	Closes all notifications with specified id
abstract void	hideNotifications(java.awt.Component owner)	Closes notifications that belong to provided component
abstract boolean	isVisible(java.lang.String notificationID)	Returns true if notification with specified id is still visible.
abstract java.awt.Component	showNotificationView(AbstractNotification notification, java.awt.Component owner, NotificationViewConfig config)	Shows popup that displays message to the user

Methods inherited from class java.lang.Object

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

Constructor Detail

NotificationViewBuilder

public NotificationViewBuilder()

Method Detail

createNotificationView

public abstract java.awt.Component createNotificationView(AbstractNotification notification,
                                                          @CheckForNull
                                                          java.awt.Component owner,
                                                          @CheckForNull
                                                          NotificationViewConfig config)

Constructs popup that displays message to the user

Parameters:

notification - notification data

owner - newly created popup owner

config - notification view configuration parameters

Returns:

created popup that displays message to the user

showNotificationView

@CheckForNull
public abstract java.awt.Component showNotificationView(AbstractNotification notification,
                                                        @CheckForNull
                                                        java.awt.Component owner,
                                                        @CheckForNull
                                                        NotificationViewConfig config)

Shows popup that displays message to the user

Parameters:

notification - notification data

owner - newly created popup owner

config - notification view configuration parameters

Returns:

popup that displays message to the user

hideNotification

public abstract void hideNotification(@CheckForNull
                                      java.lang.String notificationID)

Closes all notifications with specified id

Parameters:

notificationID - notification id

hideNotifications

public abstract void hideNotifications(@CheckForNull
                                       java.awt.Component owner)

Closes notifications that belong to provided component

isVisible

public abstract boolean isVisible(@CheckForNull
                                  java.lang.String notificationID)

Returns true if notification with specified id is still visible.

Parameters:

notificationID - notification id