Home | Trees | Indices | Help |
|
---|
|
object --+ | Notification
A notification message, used to display temporary messages to the user - for example "Document saved", or "Save failed".
The notification message can consist of several parts: caption, description and icon. It is usually used with only caption - one should be wary of filling the notification with too much information.
The notification message tries to be as unobtrusive as possible, while still drawing needed attention. There are several basic types of messages that can be used in different situations:
In addition to the basic pre-configured types, a Notification can also be configured to show up in a custom position, for a specified time (or until clicked), and with a custom stylename. An icon can also be added.
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
Inherited from |
|
|||
Inherited from |
|
Creates a notification message. Care should be taken to to avoid XSS vulnerabilities as the caption and description are by default rendered as html.
|
Gets the caption part of the notification message.
|
Sets the caption part of the notification message
|
Deprecated: Use getDescription instead. |
Deprecated: Use setDescription instead. |
Gets the description part of the notification message.
|
Gets the position of the notification message.
|
Sets the position of the notification message.
|
Gets the icon part of the notification message.
|
Sets the icon part of the notification message.
|
Gets the delay before the notification disappears.
|
Sets the delay before the notification disappears.
|
Sets the style name for the notification message.
|
Sets whether html is allowed in the caption and description. If set to true, the texts are passed to the browser as html and the developer is responsible for ensuring no harmful html is used. If set to false, the texts are passed to the browser as plain text.
|
Checks whether caption and description are interpreted as html or plain text.
See Also: setHtmlContentAllowed |
Home | Trees | Indices | Help |
|
---|
Generated by Epydoc 3.0.1 on Wed Jun 10 22:40:28 2015 | http://epydoc.sourceforge.net |