hxuanyu/intellij-sdk-code-samples
1
0
Fork 0
mirror of https://github.com/JetBrains/intellij-sdk-code-samples.git synced 2025-07-29 17:57:53 +08:00
Code Issues Packages Projects Releases Wiki Activity

plugin_listeners.md: cleanup, mention inspection

Browse Source
This commit is contained in:
Yann Cébron 2023-09-18 11:39:34 +02:00
parent 706d7a0c53
commit 0a387a24d1
1 changed files with 6 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
topics/basics/plugin_structure/plugin_listeners.md
View File

@ -4,21 +4,19 @@
<link-summary>Listeners allow subscription to application and project events.</link-summary> <link-summary>Listeners allow subscription to application and project events.</link-summary>
_Listeners_ allow plugins to declaratively subscribe to events delivered through the message bus (see [Messaging infrastructure](messaging_infrastructure.md) for details). _Listeners_ allow plugins to subscribe to events delivered through the message bus (see [Messaging infrastructure](messaging_infrastructure.md) for details).
Listener implementations must be stateless and may not implement life-cycle (e.g., `Disposable`).
You can define both application- and project-level listeners. Listeners are defined at application (global) or [project](project.md) level.
> All available listeners/topics are listed on [](extension_point_list.md) under _Listeners_ sections. > All available listeners/topics are listed on [](extension_point_list.md) under _Listeners_ sections.
> Browse usages inside existing implementations of open-source IntelliJ Platform plugins via [IntelliJ Platform Explorer](https://jb.gg/ipe). > Browse usages inside existing implementations of open-source IntelliJ Platform plugins via [IntelliJ Platform Explorer](https://jb.gg/ipe).
> >
Declarative registration of listeners allows you to achieve better performance than registering listeners from code. Listener implementations must be stateless and may not implement life-cycle (e.g., `Disposable`).
The advantage is because listener instances get created lazily — the first time an event is sent to the topic — and not during application startup or project opening. Use inspection <control>Plugin DevKit | Code | Listener implementation implements 'Disposable'</control> to verify (2023.3).
> Defining listeners in <path>plugin.xml</path> is supported starting with version 2019.3 of the platform. Declarative registration of listeners (2019.3 and later) allows you to achieve better performance than registering listeners from code.
> The advantage is because listener instances get created lazily — the first time an event is sent to the topic — and not during application startup or project opening.
{style="note"}
## Defining Application-Level Listeners ## Defining Application-Level Listeners