Class Index | File Index

Classes


Class mindmaps.Notification


Defined in: Notification.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
mindmaps.Notification(targetSelector, options)
Creates a new notification and attaches it to the target selector.
Field Summary
Field Attributes Field Name and Description
<static>  
mindmaps.Notification.Defaults
The default options.
<inner>  
Return unfinished, invisible notification if selector didn't match.
Method Summary
Method Attributes Method Name and Description
 
$()
Returns the element as a jQuery object.
 
Removes the notification.
 
Returns whether the notification is still on screen.
Class Detail
mindmaps.Notification(targetSelector, options)
Creates a new notification and attaches it to the target selector. If the selector matches more than one element, the first one is taken.
Parameters:
{String} targetSelector
options Optional
the options
{String} options.title Optional
the title of the notification
{String} options.content Optional
the content
{String} options.position Optional
possible values: topLeft, topMiddle, topRight, rightTop, rightMiddle, rightBottom, bottomLeft, bottomMiddle, bottomRight, leftTop, leftMiddle, leftBottom
{Integer} options.padding Optional
{Integer} options.expires Optional
{Boolean} options.closeButton Optional
{Integer} options.maxWidth Optional
{String} options.type Optional
possible values: info, warn, error
Field Detail
<static> mindmaps.Notification.Defaults
The default options.

<inner> offset
Return unfinished, invisible notification if selector didn't match. It will simply not show up, and does not have to be handled specially by the caller.
Method Detail
{jQuery} $()
Returns the element as a jQuery object.
Returns:
{jQuery}

close()
Removes the notification.

{Boolean} isVisible()
Returns whether the notification is still on screen.
Returns:
{Boolean}

Documentation generated by JsDoc Toolkit 2.4.0 on Mon Jul 18 2011 18:03:15 GMT+0000 (WEST)