BCD-UI

Class: Notificator

bcdui.widget.notifications. Notificator

Notificator component displaying user notifications

new bcdui.widget.notifications.Notificator(args)

widget/notification/notificationsWidgetPackage.js, line 29
Name Type Description
args Object Parameter object
Name Type Default Description
retainMessagesNumber integer 5 optional number of messages to retain in viewable area
attachMouseHandler boolean false optional if true, the mousehover/unhover will close the box
autoHideMs integer 0 optional if greater 0, the box will autohide after that amount of ms, otherwise the box has to be closed manually

Methods

addMessage(message, type, anchorId)

widget/notification/notificationsWidgetPackage.js, line 76
adds a message to notificator and displays notificator if appropriate
Name Type Default Description
message string The message you want to display
type string INFO optional The type of the message, use WARN or INFO
anchorId string optional If given the message will contain a link to that anchor)

displayNotificationBar()

widget/notification/notificationsWidgetPackage.js, line 107
displays notification bar rendering messages in the queue

hideNotificationBar()

widget/notification/notificationsWidgetPackage.js, line 146
hides notification bar

removeAllMessages()

widget/notification/notificationsWidgetPackage.js, line 99
removes all messages and hides notification window

showNotificationBar()

widget/notification/notificationsWidgetPackage.js, line 153
shows notification bar