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.
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
which was described previously.
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
showErrorHint() displays a floating popup above the editor which is automatically hidden when the user starts performing another action in the editor.
methods can be used for displaying other kinds of non-modal notification hints over an editor.
The most general way to display non-modal notifications is to use the
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
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.
Notification#addAction(AnAction) to add links below the content, use
NotificationAction for convenience.
groupDisplayId parameter of the
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
before displaying any notifications.