Package com.intellij.notification

Class Notification

java.lang.Object

com.intellij.notification.Notification

Direct Known Subclasses:

ExecutableValidator.ExecutableNotValidNotification, ProjectManagerImpl.UnableToSaveProjectNotification, UnknownMacroNotification

public class Notification
extends java.lang.Object

Notification bean class contains title:subtitle, content (plain text or HTML) and actions.

The notifications, generally, are shown in the balloons that appear on the screen when the corresponding events take place.
Notification balloon is of two types: two or three lines.
Two lines: title and content line; title and actions; content line and actions; contents on two lines.
Three lines: title and content line and actions; contents on two lines and actions; contents on three lines or more; etc.

Warning: be careful not to use the links in HTML content, use addAction(AnAction)

See Also:

NotificationAction, com.intellij.notification.SingletonNotificationManager

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Notification.CollapseActionsDirection Which actions to keep and which to show under the "Actions" dropdown link if actions do not fit horizontally into the width of the notification.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	id

Constructor Summary

Constructors

Constructor and Description
Notification(java.lang.String groupDisplayId, javax.swing.Icon icon, NotificationType type)
Notification(java.lang.String groupDisplayId, javax.swing.Icon icon, java.lang.String title, java.lang.String subtitle, java.lang.String content, NotificationType type, NotificationListener listener)
Notification(java.lang.String groupDisplayId, java.lang.String title, java.lang.String content, NotificationType type)
Notification(java.lang.String groupDisplayId, java.lang.String title, java.lang.String content, NotificationType type, NotificationListener listener)

Method Summary

Modifier and Type	Method and Description
Notification	addAction(AnAction action)
void	assertHasTitleOrContent()
void	expire()
static void	fire(Notification notification, AnAction action)
static void	fire(Notification notification, AnAction action, DataContext context)
static Notification	get(AnActionEvent e)
java.util.List<AnAction>	getActions()
Balloon	getBalloon()
Notification.CollapseActionsDirection	getCollapseActionsDirection()
java.lang.String	getContent()
AnAction	getContextHelpAction()
java.lang.String	getDropDownText()
java.lang.String	getGroupId()
javax.swing.Icon	getIcon()
NotificationListener	getListener()
java.lang.String	getSubtitle()
long	getTimestamp() Returns the time (in milliseconds since Jan 1, 1970) when the notification was created.
java.lang.String	getTitle()
NotificationType	getType()
boolean	hasContent()
boolean	hasTitle()
void	hideBalloon()
boolean	isExpired()
boolean	isImportant()
void	notify(Project project)
void	setBalloon(Balloon balloon)
void	setCollapseActionsDirection(Notification.CollapseActionsDirection collapseActionsDirection)
Notification	setContent(java.lang.String content)
Notification	setContextHelpAction(AnAction action)
static void	setDataProvider(Notification notification, javax.swing.JComponent component)
Notification	setDropDownText(java.lang.String dropDownText)
Notification	setIcon(javax.swing.Icon icon)
Notification	setImportant(boolean important)
Notification	setListener(NotificationListener listener)
Notification	setSubtitle(java.lang.String subtitle)
Notification	setTitle(java.lang.String title)
Notification	setTitle(java.lang.String title, java.lang.String subtitle)
java.lang.String	toString()
Notification	whenExpired(java.lang.Runnable whenExpired)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

id

public final java.lang.String id

Constructor Detail

Notification

public Notification(java.lang.String groupDisplayId,
                    javax.swing.Icon icon,
                    NotificationType type)

Notification

public Notification(java.lang.String groupDisplayId,
                    javax.swing.Icon icon,
                    java.lang.String title,
                    java.lang.String subtitle,
                    java.lang.String content,
                    NotificationType type,
                    NotificationListener listener)

Parameters:

groupDisplayId - this should be a human-readable, capitalized string like "Facet Detector". It will appear in "Notifications" configurable.

icon - notification icon, if null used icon from type

title - notification title

subtitle - notification subtitle

content - notification content

type - notification type

listener - notification lifecycle listener

Notification

public Notification(java.lang.String groupDisplayId,
                    java.lang.String title,
                    java.lang.String content,
                    NotificationType type)

Notification

public Notification(java.lang.String groupDisplayId,
                    java.lang.String title,
                    java.lang.String content,
                    NotificationType type,
                    NotificationListener listener)

Parameters:

groupDisplayId - this should be a human-readable, capitalized string like "Facet Detector". It will appear in "Notifications" configurable.

title - notification title

content - notification content

type - notification type

listener - notification lifecycle listener

Method Detail

getTimestamp

public long getTimestamp()

Returns the time (in milliseconds since Jan 1, 1970) when the notification was created.

getIcon

public javax.swing.Icon getIcon()

setIcon

public Notification setIcon(javax.swing.Icon icon)

getGroupId

public java.lang.String getGroupId()

hasTitle

public boolean hasTitle()

getTitle

public java.lang.String getTitle()

setTitle

public Notification setTitle(java.lang.String title)

setTitle

public Notification setTitle(java.lang.String title,
                             java.lang.String subtitle)

getSubtitle

public java.lang.String getSubtitle()

setSubtitle

public Notification setSubtitle(java.lang.String subtitle)

hasContent

public boolean hasContent()

getContent

public java.lang.String getContent()

setContent

public Notification setContent(java.lang.String content)

getListener

public NotificationListener getListener()

setListener

public Notification setListener(NotificationListener listener)

getActions

public java.util.List<AnAction> getActions()

get

public static Notification get(AnActionEvent e)

fire

public static void fire(Notification notification,
                        AnAction action)

fire

public static void fire(Notification notification,
                        AnAction action,
                        DataContext context)

setDataProvider

public static void setDataProvider(Notification notification,
                                   javax.swing.JComponent component)

getDropDownText

public java.lang.String getDropDownText()

setDropDownText

public Notification setDropDownText(java.lang.String dropDownText)

Parameters:

dropDownText - text for popup when all actions collapsed (when all actions width more notification width)

getCollapseActionsDirection

public Notification.CollapseActionsDirection getCollapseActionsDirection()

setCollapseActionsDirection

public void setCollapseActionsDirection(Notification.CollapseActionsDirection collapseActionsDirection)

addAction

public Notification addAction(AnAction action)

See Also:

NotificationAction

setContextHelpAction

public Notification setContextHelpAction(AnAction action)

getContextHelpAction

public AnAction getContextHelpAction()

getType

public NotificationType getType()

isExpired

public boolean isExpired()

expire

public void expire()

whenExpired

public Notification whenExpired(java.lang.Runnable whenExpired)

hideBalloon

public void hideBalloon()

setBalloon

public void setBalloon(Balloon balloon)

getBalloon

public Balloon getBalloon()

notify

public void notify(Project project)

setImportant

public Notification setImportant(boolean important)

isImportant

public boolean isImportant()

assertHasTitleOrContent

public final void assertHasTitleOrContent()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object