Karol Lewandowski 5a256a5e9a Settings tutorial: Change the implementation to follow the recommended approach (a separate state class)
Also:
- remove unnecessary screenshot
- change labels to follow UX guidelines
2024-06-20 12:42:04 +02:00

27 lines
1.6 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Settings Example [![JetBrains IntelliJ Platform SDK Docs](https://jb.gg/badges/docs.svg)][docs]
*Reference: [Settings Tutorial in IntelliJ SDK Docs][docs:settings_tutorial]*
## Quickstart
This project illustrates a custom Application-level Settings through the implementation of:
- `AppSettingsConfigurable` is analogous to a Controller in the MVC model it interacts with the other two Settings classes and the IntelliJ Platform,
- `AppSettings` is like a Model because it stores the Settings persistently,
- `AppSettingsComponent` is similar to a View because it displays and captures edits to the values of the Settings.
### Extension Points
| Name | Implementation | Extension Point Class |
|----------------------------------------|---------------------------------------------------------|----------------------------|
| `com.intellij.applicationConfigurable` | [AppSettingsConfigurable][file:AppSettingsConfigurable] | `Configurable` |
| `com.intellij.applicationService` | [AppSettings][file:AppSettings] | `PersistentStateComponent` |
*Reference: [Plugin Extension Points in IntelliJ SDK Docs][docs:ep]*
[docs]: https://plugins.jetbrains.com/docs/intellij/
[docs:settings_tutorial]: https://plugins.jetbrains.com/docs/intellij/settings-tutorial.html
[docs:ep]: https://plugins.jetbrains.com/docs/intellij/plugin-extensions.html
[file:AppSettingsConfigurable]: ./src/main/java/org/intellij/sdk/settings/AppSettingsConfigurable.java
[file:AppSettings]: ./src/main/java/org/intellij/sdk/settings/AppSettings.java