Package com.nomagic.magicdraw.ui.notification

Class NotificationViewBuilder

java.lang.Object

com.nomagic.magicdraw.ui.notification.NotificationViewBuilder

@OpenApiAll
public abstract class NotificationViewBuilder
extends 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 Component	createNotificationView(AbstractNotification notification, Component owner, NotificationViewConfig config)	Constructs popup that displays message to the user
abstract void	hideNotification(String notificationID)	Closes all notifications with specified id
abstract void	hideNotifications(Component owner)	Closes notifications that belong to provided component
abstract boolean	isVisible(String notificationID)	Returns true if notification with specified id is still visible.
abstract Component	showNotificationView(AbstractNotification notification, 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 Details

NotificationViewBuilder

public NotificationViewBuilder()

Method Details

createNotificationView

public abstract Component createNotificationView(AbstractNotification notification,
 @CheckForNull
 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 Component showNotificationView(AbstractNotification notification,
 @CheckForNull
 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
 String notificationID)

Closes all notifications with specified id

Parameters:

notificationID - notification id

hideNotifications

public abstract void hideNotifications(@CheckForNull
 Component owner)

Closes notifications that belong to provided component

isVisible

public abstract boolean isVisible(@CheckForNull
 String notificationID)

Returns true if notification with specified id is still visible.

Parameters:

notificationID - notification id