gadgets.MiniMessage

 SUMMARY     DETAIL

Class gadgets.MiniMessage

MiniMessage class.

Constructor Summary

gadgets.MiniMessage(opt_moduleId, opt_container)

Used to create messages that will appear to the user within the gadget.

 

Method Summary

 Element createDismissibleMessage(message, opt_callback)

Creates a dismissible message with an [x] icon that allows users to dismiss the message.

 Element createStaticMessage(message)

Creates a static message that can only be dismissed programmatically (by calling dismissMessage()).

 Element createTimerMessage(message, seconds, opt_callback)

Creates a message that displays for the specified number of seconds.

dismissMessage(message)

Dismisses the specified message.

 

Constructor Detail

gadgets.MiniMessage

gadgets.MiniMessage(opt_moduleId, opt_container)

Used to create messages that will appear to the user within the gadget.

Parameters:
String opt_moduleId - Optional module Id
Element opt_container - Optional HTML container element where mini-messages will appear.

Method Detail

createDismissibleMessage

Element createDismissibleMessage(message, opt_callback)

Creates a dismissible message with an [x] icon that allows users to dismiss the message. When the message is dismissed, it is removed from the DOM and the optional callback function, if defined, is called.

Parameters:
String, Object message - The message as an HTML string or DOM element
Function opt_callback - Optional callback function to be called when the message is dismissed

Returns:
Element HTML element of the created message

createStaticMessage

Element createStaticMessage(message)

Creates a static message that can only be dismissed programmatically (by calling dismissMessage()).

Parameters:
String, Object message - The message as an HTML string or DOM element

Returns:
Element HTML element of the created message

createTimerMessage

Element createTimerMessage(message, seconds, opt_callback)

Creates a message that displays for the specified number of seconds. When the timer expires, the message is dismissed and the optional callback function is executed.

Parameters:
String, Object message - The message as an HTML string or DOM element
number seconds - Number of seconds to wait before dismissing the message
Function opt_callback - Optional callback function to be called when the message is dismissed

Returns:
Element HTML element of the created message

dismissMessage

dismissMessage(message)

Dismisses the specified message.

Parameters:
Element message - HTML element of the message to remove

---