IntelliJ Platform SDK DevGuide

Edit page

Notifications

Notifications

One of the leading design principles is avoiding the use of modal message boxes for notifying the user about errors and other situations that may warrant the user’s attention. As a replacement, the IntelliJ Platform provides multiple non-modal notification UI options.

Dialogs

When working in a modal dialog, instead of checking the validity of the input when the OK button is pressed and notifying the user about invalid data with a modal dialog, the recommended approach is to use DialogBuilder.doValidate(), which was described previously.

Editor Hints

For actions invoked from the editor (such as refactorings, navigation actions and different code insight features), the best way to notify the user about the inability to perform an action is to use the HintManager class. Its method showErrorHint() displays a floating popup above the editor which is automatically hidden when the user starts performing another action in the editor. Other HintManager methods can be used for displaying other kinds of non-modal notification hints over an editor.

Top-Level Notifications

The most general way to display non-modal notifications is to use the Notifications class.

It has two main advantages:

  • The user can control the way each notification type is displayed under Settings | Appearance & Behavior | Notifications

  • All displayed notifications are gathered in the Event Log tool window and can be reviewed later

The specific method used to display a notification is Notifications.Bus.notify(). If the current Project is known, please use overload with Project parameter, so the notification is shown in its associated frame.

The text of the notification can include HTML tags.

Use Notification#addAction(AnAction) to add links below the content, use NotificationAction for convenience.

The groupDisplayId parameter of the Notification constructor specifies a notification type. The user can choose the display type corresponding to each notification type under Settings | Appearance and Behavior | Notifications. To specify the preferred display type, you need to call Notifications.Bus.register() before displaying any notifications.

Last modified: 2 December 2019