CKEditor Ecosystem Documentation
Search
Report an issue
Home/CKEditor 4/API
Class

CKEDITOR.plugins.notification.area

class since 4.5.0 private
See source

Notification area is an area where all notifications are put. The area is laid out dynamically. When the first notification is added, the area is shown and all listeners are added. When the last notification is removed, the area is hidden and all listeners are removed.

Filtering

Properties

  • readonly

    editor : editor

    See source

    The editor instance.

  • readonly

    element : element

    See source

    Notification area DOM element. This element is created when the area object is created. It will be attached to the document when the first notification is added and removed when the last notification is removed.

  • readonly

    notifications : Array

    See source

    The array of added notifications.

  • private

    _changeBuffer : Object

    See source

    Event buffer object for editor change events to optimize performance.

  • private

    _notificationMargin : element

    See source

    Notification margin. Cached for performance reasons.

  • private

    _notificationWidth : element

    See source

    Notification width. Cached for performance reasons.

  • private

    _uiBuffer : Object

    See source

    Event buffer object for UI events to optimize performance.

Methods

  • constructor( editor ) → area

    See source

    Parameters

    editor : editor

    The editor instance.

    Returns

    area

  • add( notification )

    See source

    Adds the notification to the notification area. If it is the first notification, the area will also be attached to the document and listeners will be attached.

    Note that the proper way to show a notification is to call the CKEDITOR.plugins.notification.show method.

    Parameters

    notification : notification

    Notification to add.

  • remove( notification )

    See source

    Removes the notification from the notification area. If it is the last notification, the area will also be detached from the document and listeners will be detached.

    Note that the proper way to hide a notification is to call the CKEDITOR.plugins.notification.hide method.

    Parameters

    notification : notification

    Notification to remove.

  • private

    _attachListeners()

    See source

    Attaches listeners to the notification area.

  • private

    _createElement() → element

    See source

    Creates the notification area element.

    Returns

    element

    Notification area element.

  • private

    _layout()

    See source

    Sets the position of the notification area based on the editor content, toolbar as well as viewport position and dimensions.

  • private

    _removeListeners()

    See source

    Detaches listeners from the notification area.