message_popup/notification_area_content_area

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

Methods

(inner) getContainer() → {object}

Source:

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

Returns:

jQuery element

Type
object

(inner) getContent() → {object}

Source:

Get the content area content element.

Returns:

jQuery element

Type
object

(inner) getFooter() → {object}

Source:

Get the content area footer element.

Returns:

jQuery element

Type
object

(inner) getHeader() → {object}

Source:

Get the content area header element.

Returns:

jQuery element

Type
object

(inner) getRoot() → {object}

Source:

Get the root element.

Returns:

jQuery element

Type
object

(inner) getUserId() → {int}

Source:

Get the user id.

Returns:
Type
int

(inner) hide()

Source:

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

(inner) registerEventListeners()

Source:

Create the event listeners for the content area.

(inner) setContentHMTL(html)

Source:

Change the HTML in the content area content element.

Parameters:
Name Type Description
html string

The HTML to be set.

(inner) setFooterHTML(html)

Source:

Change the HTML in the content area footer element.

Parameters:
Name Type Description
html string

The HTML to be set.

(inner) setHeaderHTML(html)

Source:

Change the HTML in the content area header element.

Parameters:
Name Type Description
html string

The HTML to be set

(inner) show()

Source:

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

(inner) showNotification(notification) → {object}

Source:

Render the given notification context in the content area.

Parameters:
Name Type Description
notification object

The notification context (from a webservice)
Returns:

jQuery promise

Type
object