XUL:NotificationBox

<notificationbox>

<notificationbox> is used to display notifications above an element. Typically the element will be a browser, but any element may be used. The <notification> element is used for each notification, and will be created automatically for each item. Each notification will slide in and out as needed.

The notification box is a vertical box which may have children. The notifications appear at the top of the box. The notifications may be placed at the bottom by setting the dir attribute to "reverse".

XUL Syntax

<notificationbox flex="1">
  <browser src="http://www.mozilla.org"/>
</notificationbox>

Properties

currentNotification

The currently displayed notification. (Needs a more elaborate description.)

allNotifications

readonly NodeList of all notifications

notificationsHidden

boolean indicating whether the notification area should be hidden

Methods

appendNotification( label , value , image , priority , buttons )

Create a new notification and display it. If another notification is already present with a higher priority, the new notification will be added behind it. This method returns the notification.

Arguments:

• label - label to appear on the notification
• value - value used to identify the notification
• image - URL of image to appear on the notification
• priority - notification priority, see Priority Levels.
• buttons - array of button descriptions to appear on the notification, see below for details.

getNotificationWithValue ( value )

Retrieve the notification with a particular value. The value is specified when adding the notification with appendNotification.

removeAllNotifications ( immediate )

Remove all notifications. If immediate is true, the messages are removed immediately. If immediate is false, the notification is slid away.

removeCurrentNotification ( )

Remove the current notification

removeNotification( item )

Remove a notification, displaying the next one if the removed item is the current one

Button Descriptions

The buttons argument to appendNotification is an array of button descriptions. Each description is an object with the following properties:

• accesskey - the accesskey to appear on the button
• callback - function to be called when the button is activated. This function is passed two arguments:
  • the <notification> the button is associated with
  • the button description as passed to appendNotification.
• label - the label to appear on the button
• popup - the id of a popup for the button. If null, the button is a button popup.

<notification>

<notification> is used to display an informative message. It will normally be used as part of a <notificationbox>.

XUL Syntax

<notification label="This is a warning"/>

Properties

accessible

Returns the accessibility object for the notification.

control

The enclosing <notificationbox> if any.

image

URL of an image to appear on the notification.

label

The label displayed on the notification.

priority

The message priority, used by the enclosing <notificationbox>. See Priority Levels.

type

Notification type (string). There are three types, which specify the importance of the notification.

• "info" - informative message
• "warning" - warning message
• "critical" - critical message

value

A value associated with the notification.

Methods

close ( )

Closes the notification and removes it from its enclosing <notificationbox>

Priority Levels

Notifications with higher priority levels appear above those with lower priorities. These constants are defined on the notificationbox binding and can be obtained from any <notificationbox> element.

PRIORITY_INFO_LOW

PRIORITY_INFO_MEDIUM

PRIORITY_INFO_HIGH

PRIORITY_WARNING_LOW

PRIORITY_WARNING_MEDIUM

PRIORITY_WARNING_HIGH

PRIORITY_CRITICAL_LOW

PRIORITY_CRITICAL_MEDIUM

PRIORITY_CRITICAL_HIGH

PRIORITY_CRITICAL_BLOCK