|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.vaadin.ui.Notification
public class 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.
Field Summary | |
---|---|
static int |
DELAY_FOREVER
|
static int |
DELAY_NONE
|
static int |
POSITION_BOTTOM_LEFT
|
static int |
POSITION_BOTTOM_RIGHT
|
static int |
POSITION_CENTERED
|
static int |
POSITION_CENTERED_BOTTOM
|
static int |
POSITION_CENTERED_TOP
|
static int |
POSITION_TOP_LEFT
|
static int |
POSITION_TOP_RIGHT
|
static int |
TYPE_ERROR_MESSAGE
|
static int |
TYPE_HUMANIZED_MESSAGE
|
static int |
TYPE_TRAY_NOTIFICATION
|
static int |
TYPE_WARNING_MESSAGE
|
Constructor Summary | |
---|---|
Notification(String caption)
Creates a "humanized" notification message. |
|
Notification(String caption,
int type)
Creates a notification message of the specified type. |
|
Notification(String caption,
String description)
Creates a "humanized" notification message with a bigger caption and smaller description. |
|
Notification(String caption,
String description,
int type)
Creates a notification message of the specified type, with a bigger caption and smaller description. |
|
Notification(String caption,
String description,
int type,
boolean htmlContentAllowed)
Creates a notification message of the specified type, with a bigger caption and smaller description. |
Method Summary | |
---|---|
String |
getCaption()
Gets the caption part of the notification message. |
int |
getDelayMsec()
Gets the delay before the notification disappears. |
String |
getDescription()
Gets the description part of the notification message. |
Resource |
getIcon()
Gets the icon part of the notification message. |
int |
getPosition()
Gets the position of the notification message. |
String |
getStyleName()
Gets the style name for the notification message. |
boolean |
isHtmlContentAllowed()
Checks whether caption and description are interpreted as html or plain text. |
void |
setCaption(String caption)
Sets the caption part of the notification message |
void |
setDelayMsec(int delayMsec)
Sets the delay before the notification disappears. |
void |
setDescription(String description)
Sets the description part of the notification message. |
void |
setHtmlContentAllowed(boolean htmlContentAllowed)
Sets whether html is allowed in the caption and description. |
void |
setIcon(Resource icon)
Sets the icon part of the notification message. |
void |
setPosition(int position)
Sets the position of the notification message. |
void |
setStyleName(String styleName)
Sets the style name for the notification message. |
void |
show(Page page)
Shows this notification on a Page. |
static void |
show(String caption)
Shows a notification message on the middle of the current page. |
static void |
show(String caption,
int type)
Shows a notification message the current page. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int TYPE_HUMANIZED_MESSAGE
public static final int TYPE_WARNING_MESSAGE
public static final int TYPE_ERROR_MESSAGE
public static final int TYPE_TRAY_NOTIFICATION
public static final int POSITION_CENTERED
public static final int POSITION_CENTERED_TOP
public static final int POSITION_CENTERED_BOTTOM
public static final int POSITION_TOP_LEFT
public static final int POSITION_TOP_RIGHT
public static final int POSITION_BOTTOM_LEFT
public static final int POSITION_BOTTOM_RIGHT
public static final int DELAY_FOREVER
public static final int DELAY_NONE
Constructor Detail |
---|
public Notification(String caption)
caption
- The message to showpublic Notification(String caption, int type)
caption
- The message to showtype
- The type of messagepublic Notification(String caption, String description)
caption
- The message captiondescription
- The message descriptionpublic Notification(String caption, String description, int type)
caption
- The message captiondescription
- The message descriptiontype
- The type of messagepublic Notification(String caption, String description, int type, boolean htmlContentAllowed)
caption
- The message captiondescription
- The message descriptiontype
- The type of messagehtmlContentAllowed
- Whether html in the caption and description should be
displayed as html or as plain textMethod Detail |
---|
public String getCaption()
public void setCaption(String caption)
caption
- The message captionpublic String getDescription()
public void setDescription(String description)
description
- public int getPosition()
public void setPosition(int position)
position
- The desired notification positionpublic Resource getIcon()
public void setIcon(Resource icon)
icon
- The desired message iconpublic int getDelayMsec()
public void setDelayMsec(int delayMsec)
delayMsec
- the desired delay in msec, -1 to require the user to click the
messagepublic void setStyleName(String styleName)
styleName
- The desired style name.public String getStyleName()
public void setHtmlContentAllowed(boolean htmlContentAllowed)
htmlContentAllowed
- true if the texts are used as html, false if used as plain
textpublic boolean isHtmlContentAllowed()
setHtmlContentAllowed(boolean)
public void show(Page page)
page
- The page on which the notification should be shownpublic static void show(String caption)
caption
- The messageNotification(String)
,
show(Page)
public static void show(String caption, int type)
Notification
, for instance
Notification.TYPE_WARNING_MESSAGE.
The caption is rendered as plain text with HTML automatically escaped.
caption
- The messagetype
- The message typeNotification(String, int)
,
show(Page)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |