message_popup/notification_area_content_area

Description:

  • Controls the content area of the notification area on the notification page.

Source:
Copyright:
  • 2016 Ryan Wyllie
License:
  • http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Controls the content area of the notification area on the notification page.

Methods

(inner) getContainer() → {object}

Description:

  • Get the container element (which the content area is within).

Source:
Returns:

jQuery element

Type
object

(inner) getContent() → {object}

Description:

  • Get the content area content element.

Source:
Returns:

jQuery element

Type
object

(inner) getFooter() → {object}

Description:

  • Get the content area footer element.

Source:
Returns:

jQuery element

Type
object

(inner) getHeader() → {object}

Description:

  • Get the content area header element.

Source:
Returns:

jQuery element

Type
object

(inner) getRoot() → {object}

Description:

  • Get the root element.

Source:
Returns:

jQuery element

Type
object

(inner) getUserId() → {int}

Description:

  • Get the user id.

Source:
Returns:
Type
int

(inner) hide()

Description:

  • Hide the content area. Typically used with responsive styling on smaller screens.

Source:

(inner) registerEventListeners()

Description:

  • Create the event listeners for the content area.

Source:

(inner) setContentHMTL(html)

Description:

  • Change the HTML in the content area content element.

Source:
Parameters:
Name Type Description
html string

The HTML to be set.

(inner) setFooterHTML(html)

Description:

  • Change the HTML in the content area footer element.

Source:
Parameters:
Name Type Description
html string

The HTML to be set.

(inner) setHeaderHTML(html)

Description:

  • Change the HTML in the content area header element.

Source:
Parameters:
Name Type Description
html string

The HTML to be set

(inner) show()

Description:

  • Display the content area. Typically used with responsive styling on smaller screens.

Source:

(inner) showNotification(notification) → {object}

Description:

  • Render the given notification context in the content area.

Source:
Parameters:
Name Type Description
notification object

The notification context (from a webservice)
Returns:

jQuery promise

Type
object