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

dialog_wrapper.md: format

Browse Source
This commit is contained in:
Yann Cébron 2021-05-20 11:49:32 +02:00
parent d8b05679d4
commit a6378d5d70
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
topics/user_interface_components/dialog_wrapper.md
View File

@ -8,15 +8,15 @@ The [`DialogWrapper`](upsource:///platform/platform-api/src/com/intellij/openapi
It provides the following features: It provides the following features:
* Button layout (platform-specific order of _OK_/_Cancel_ buttons, macOS-specific `Help` button) * Button layout (platform-specific order of <control>OK</control>/<control>Cancel</control> buttons, macOS-specific <control>Help</control> button)
* Context help * Context help
* Remembering the size of the dialog * Remembering the size of the dialog
* Non-modal validation (displaying an error message text when the data entered into the dialog is not valid) * Non-modal validation (displaying an error message text when the data entered into the dialog is not valid)
* Keyboard shortcuts: * Keyboard shortcuts:
* <shortcut>Esc</shortcut> for closing the dialog * <shortcut>Esc</shortcut> for closing the dialog
* <shortcut>Left/Right</shortcut> for switching between buttons * <shortcut>Left/Right</shortcut> for switching between buttons
* <shortcut>Y</shortcut>/<shortcut>N</shortcut> for _Yes_/_No_ actions if they exist in the dialog * <shortcut>Y</shortcut>/<shortcut>N</shortcut> for <control>Yes</control>/<control>No</control> actions if they exist in the dialog
* Optional _Do not ask again_ checkbox * Optional <control>Do not ask again</control> checkbox
When using the [`DialogWrapper`](upsource:///platform/platform-api/src/com/intellij/openapi/ui/DialogWrapper.java) class for a dialog, follow these steps: When using the [`DialogWrapper`](upsource:///platform/platform-api/src/com/intellij/openapi/ui/DialogWrapper.java) class for a dialog, follow these steps:
@ -40,7 +40,7 @@ When using Kotlin, use [Kotlin UI DSL](kotlin_ui_dsl.md) to provide the dialog's
To display the dialog, call the `show()` method and then use the `getExitCode()` method to check how the dialog was closed. To display the dialog, call the `show()` method and then use the `getExitCode()` method to check how the dialog was closed.
The `showAndGet()` method can be used to combine these two calls. The `showAndGet()` method can be used to combine these two calls.
To customize the buttons displayed in the dialog (replacing the standard _OK_/_Cancel_/_Help_ set of buttons), override either the `createActions()` or `createLeftActions()` methods. To customize the buttons displayed in the dialog (replacing the standard <control>OK</control>/<control>Cancel</control>/<control>Help</control> set of buttons), override either the `createActions()` or `createLeftActions()` methods.
Both of these methods return an array of Swing Action objects. Both of these methods return an array of Swing Action objects.
If a button closes the dialog, use [`DialogWrapperExitAction`](upsource:///platform/platform-api/src/com/intellij/openapi/ui/DialogWrapper.java) as the base class for the action. If a button closes the dialog, use [`DialogWrapperExitAction`](upsource:///platform/platform-api/src/com/intellij/openapi/ui/DialogWrapper.java) as the base class for the action.
Use `action.putValue(DialogWrapper.DEFAULT_ACTION, true)` to set the default button. Use `action.putValue(DialogWrapper.DEFAULT_ACTION, true)` to set the default button.
@ -49,7 +49,7 @@ To validate the data entered into the dialog, override the `doValidate()` method
The method will be called automatically by timer. The method will be called automatically by timer.
If the currently entered data is valid, return `null`. If the currently entered data is valid, return `null`.
Otherwise, return a [`ValidationInfo`](upsource:///platform/platform-api/src/com/intellij/openapi/ui/ValidationInfo.java) object which encapsulates an error message, and an optional component associated with the invalid data. Otherwise, return a [`ValidationInfo`](upsource:///platform/platform-api/src/com/intellij/openapi/ui/ValidationInfo.java) object which encapsulates an error message, and an optional component associated with the invalid data.
When specifying a component, an error icon will be displayed next to it, and it will be focused when the user tries to invoke the _OK_ action. When specifying a component, an error icon will be displayed next to it, and it will be focused when the user tries to invoke the <control>OK</control> action.
## Example ## Example