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

plugin_components.md: formatting

Browse Source
This commit is contained in:
Yann Cébron 2019-12-05 11:58:46 +01:00
parent 8870737301
commit 3e046167de
1 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
basics/plugin_structure/plugin_components.md
View File

@ -2,13 +2,14 @@
title: Plugin Components
---
> **WARNING** When writing new plugins, you should avoid creating components, and you should migrate existing components in your plugins to services, extensions or listeners (see below).
Plugin components are a legacy feature supported for compatibility with plugins created for older versions of the
IntelliJ Platform. Plugins using components do not support dynamic loading (the ability to install, update and
uninstall plugins without restarting the IDE). When writing new plugins, you should avoid creating components,
and you should migrate existing components in your plugins to services, extensions or listeners.
uninstall plugins without restarting the IDE).
Plugin components are defined using `<application-components>`, `<project-components>` and `<module-components>`
tags in a plugin.xml file.
tags in a `plugin.xml` file.
To migrate your code from components to more modern APIs, please use the following guidelines:
@ -16,11 +17,11 @@ To migrate your code from components to more modern APIs, please use the followi
use a [Service](plugin_services.md).
* To store the state of your plugin at the application or project level, use a [Service](plugin_services.md)
and implement the `PersistentStateComponent` interface. See [Persisting State of Components](/basics/persisting_state_of_components.md) for details.
* To subscribe to events, use a [listener](plugin_listeners.md) or create an [extension](plugin_extensions.md) for a dedicated extension point (for example, `<editorFactoryListener>`) if one exists for the event you need to subscribe to.
* Executing code on application startup should be avoided whenever possible, because it slows down startup.
* To subscribe to events, use a [listener](plugin_listeners.md) or create an [extension](plugin_extensions.md) for a dedicated extension point (for example, `com.intellij.editorFactoryListener`) if one exists for the event you need to subscribe to.
* Executing code on application startup should be avoided whenever possible because it slows down startup.
Plugin code should only be executed when projects are opened or when the user invokes an action of your plugin. If you can't avoid this, create
an [extension](plugin_extensions.md) for the `<appLifecycleListener>` extension point.
* To execute code when a project is being opened, create an [extension](plugin_extensions.md) for the `<postStartupActivity>` or `<backgroundPostStartupActivity>` extension point (the latter is supported starting with version 2019.3 of the platform).
an [extension](plugin_extensions.md) for the `com.intellij.appLifecycleListener` extension point.
* To execute code when a project is being opened, provide [StartupActivity](upsource:///platform/core-api/src/com/intellij/openapi/startup/StartupActivity.java) implementation and register an [extension](plugin_extensions.md) for the `com.intellij.postStartupActivity` or `com.intellij.backgroundPostStartupActivity` extension point (the latter is supported starting with version 2019.3 of the platform).
* To execute code on project closing or application shutdown, implement the `Disposable` interface in a [Service](plugin_services.md)
and place the code in the `dispose` method, or use `Disposer.register` passing a `Project` or `Application` instance
and place the code in the `dispose()` method, or use `Disposer.register()` passing a `Project` or `Application` instance
as the `parent` argument.