diff --git a/topics/basics/ide_infrastructure.md b/topics/basics/ide_infrastructure.md index 464363d6b..bd3d46be6 100644 --- a/topics/basics/ide_infrastructure.md +++ b/topics/basics/ide_infrastructure.md @@ -92,3 +92,7 @@ NOTE: to restrict compatibility, declare [IDEs](plugin_compatibility.md) and [ve To obtain information about OS and Java VM, use [`SystemInfo`](upsource:///platform/util/src/com/intellij/openapi/util/SystemInfo.java). To access relevant configuration directories, see [`PathManager`](upsource:///platform/util/src/com/intellij/openapi/application/PathManager.java). + +## Context Help + +To show custom context web-based help for your plugin's functionality (e.g., for [dialogs](dialog_wrapper.md)), provide [`WebHelpProvider`](upsource:///platform/platform-api/src/com/intellij/openapi/help/WebHelpProvider.java) registered in `com.intellij.webHelpProvider` extension point. diff --git a/topics/user_interface_components/dialog_wrapper.md b/topics/user_interface_components/dialog_wrapper.md index 5bdc0b87a..81e7b4da9 100644 --- a/topics/user_interface_components/dialog_wrapper.md +++ b/topics/user_interface_components/dialog_wrapper.md @@ -17,7 +17,7 @@ It provides the following features: * Left/Right for switching between buttons * Y/N for Yes/No actions if they exist in the dialog * Optional Do not ask again checkbox - + ### Usage When using the [`DialogWrapper`](upsource:///platform/platform-api/src/com/intellij/openapi/ui/DialogWrapper.java) class for a dialog, follow these required steps: @@ -26,19 +26,19 @@ When using the [`DialogWrapper`](upsource:///platform/platform-api/src/com/intel * Call the `setTitle()` method to set the title for the dialog * Call the `init()` method from the constructor of the dialog class * Implement the `createCenterPanel()` method to return the component comprising the main contents of the dialog. - + Optionally: * Override the `getPreferredFocusedComponent()` method and return the component that should be focused when the dialog is first displayed. * Override the `getDimensionServiceKey()` method to return the identifier which will be used for persisting the dialog dimensions. -* Override the `getHelpId()` method to return the context help topic associated with the dialog. +* Override the `getHelpId()` method to return the context help topic associated with the dialog (see [Context Help](ide_infrastructure.md#context-help)). The `DialogWrapper` class is often used together with [GUI Designer forms](https://www.jetbrains.com/help/idea/gui-designer-basics.html). In this case, bind a GUI Designer form to the class extending `DialogWrapper`, bind the top-level panel of the form to a field and return that field from the `createCenterPanel()` method. When using Kotlin, use [Kotlin UI DSL](kotlin_ui_dsl.md) to provide the dialog's contents. - > See [Layout](https://jetbrains.design/intellij/principles/layout) topic in IntelliJ Platform UI Guidelines for recommendations on arranging UI controls in dialogs. - > + > See [Layout](https://jetbrains.design/intellij/principles/layout) topic in IntelliJ Platform UI Guidelines for recommendations on arranging UI controls in dialogs. + > > Existing dialogs can be inspected at runtime using [UI Inspector](internal_ui_inspector.md), e.g., to locate the underlying implementation of UI components. > {type="tip"} @@ -50,7 +50,7 @@ To customize the buttons displayed in the dialog (replacing the standard { // user pressed OK } }); -``` \ No newline at end of file +```