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

editor_events.md: Add code formatting to titles

Browse Source
This commit is contained in:
Karol Lewandowski 2024-04-08 12:46:55 +02:00
parent 86f9c1a2c8
commit 4aea627c48
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
topics/tutorials/editor_basics/editor_events.md
View File

@ -1,4 +1,4 @@
<!-- Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. --> <!-- Copyright 2000-2024 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
# 3. Handling Editor Events # 3. Handling Editor Events
@ -11,7 +11,7 @@ Two classes from the [editor_basics](%gh-sdk-samples%/editor_basics) code sample
* Using an IntelliJ Platform [`EditorActionHandler`](%gh-ic%/platform/platform-api/src/com/intellij/openapi/editor/actionSystem/EditorActionHandler.java) to manipulate a caret. * Using an IntelliJ Platform [`EditorActionHandler`](%gh-ic%/platform/platform-api/src/com/intellij/openapi/editor/actionSystem/EditorActionHandler.java) to manipulate a caret.
* Creating and registering a custom [`TypedActionHandler`](%gh-ic%/platform/platform-api/src/com/intellij/openapi/editor/actionSystem/TypedActionHandler.java) to intercept keystrokes and change the document. * Creating and registering a custom [`TypedActionHandler`](%gh-ic%/platform/platform-api/src/com/intellij/openapi/editor/actionSystem/TypedActionHandler.java) to intercept keystrokes and change the document.
## Using an IntelliJ Platform EditorActionHandler ## Using an IntelliJ Platform `EditorActionHandler`
In this portion of the tutorial, the [editor_basics](%gh-sdk-samples%/editor_basics) code sample is used to demonstrate cloning an existing caret. In this portion of the tutorial, the [editor_basics](%gh-sdk-samples%/editor_basics) code sample is used to demonstrate cloning an existing caret.
A custom action class will use `EditorActionManager` to access a specific `EditorActionHandler` for caret cloning. A custom action class will use `EditorActionManager` to access a specific `EditorActionHandler` for caret cloning.
@ -68,7 +68,7 @@ public class EditorHandlerIllustration extends AnAction {
} }
``` ```
### Acquiring the Correct EditorActionHandler ### Acquiring the Correct `EditorActionHandler`
When the `EditorHandlerIllustration.actionPerformed()` method clones the caret, it should use the appropriate IntelliJ Platform [`EditorActionHandler`](%gh-ic%/platform/platform-api/src/com/intellij/openapi/editor/actionSystem/EditorActionHandler.java). When the `EditorHandlerIllustration.actionPerformed()` method clones the caret, it should use the appropriate IntelliJ Platform [`EditorActionHandler`](%gh-ic%/platform/platform-api/src/com/intellij/openapi/editor/actionSystem/EditorActionHandler.java).
An instance of [`EditorActionManager`](%gh-ic%/platform/platform-api/src/com/intellij/openapi/editor/actionSystem/EditorActionManager.java) is required to obtain the correct `EditorActionHandler`. An instance of [`EditorActionManager`](%gh-ic%/platform/platform-api/src/com/intellij/openapi/editor/actionSystem/EditorActionManager.java) is required to obtain the correct `EditorActionHandler`.
@ -85,7 +85,7 @@ EditorActionHandler actionHandler =
actionManager.getActionHandler(IdeActions.ACTION_EDITOR_CLONE_CARET_BELOW); actionManager.getActionHandler(IdeActions.ACTION_EDITOR_CLONE_CARET_BELOW);
``` ```
### Using an EditorActionHandler to Clone the Caret ### Using an `EditorActionHandler` to Clone the Caret
To clone the caret requires only calling the `EditorActionHandler.execute()` method and passing in the appropriate context. To clone the caret requires only calling the `EditorActionHandler.execute()` method and passing in the appropriate context.
@ -103,13 +103,13 @@ public class EditorHandlerIllustration extends AnAction {
} }
``` ```
## Creating a Custom TypedActionHandler ## Creating a Custom `TypedActionHandler`
The [`TypedActionHandler`](%gh-ic%/platform/platform-api/src/com/intellij/openapi/editor/actionSystem/TypedActionHandler.java) interface is the basis for classes that handle keystroke events from the editor. The [`TypedActionHandler`](%gh-ic%/platform/platform-api/src/com/intellij/openapi/editor/actionSystem/TypedActionHandler.java) interface is the basis for classes that handle keystroke events from the editor.
Custom implementations of the class are registered to handle editor keystroke events, and receive a callback for each keystroke. Custom implementations of the class are registered to handle editor keystroke events, and receive a callback for each keystroke.
The steps below explain how to use `TypedActionHandler` to customize the behavior of the editor when keystroke events are received. The steps below explain how to use `TypedActionHandler` to customize the behavior of the editor when keystroke events are received.
### Implementing a Custom TypedActionHandler Class ### Implementing a Custom `TypedActionHandler` Class
First, a subclass such as `MyTypedHandler` is created based on [`TypedActionHandler`](%gh-ic%/platform/platform-api/src/com/intellij/openapi/editor/actionSystem/TypedActionHandler.java). First, a subclass such as `MyTypedHandler` is created based on [`TypedActionHandler`](%gh-ic%/platform/platform-api/src/com/intellij/openapi/editor/actionSystem/TypedActionHandler.java).
The class overrides the method `TypedActionHandler.execute()`, which is the callback for editor keystroke events. The class overrides the method `TypedActionHandler.execute()`, which is the callback for editor keystroke events.
@ -137,7 +137,7 @@ final class MyTypedHandler implements TypedActionHandler {
} }
``` ```
### Registering a Custom TypedActionHandler ### Registering a Custom `TypedActionHandler`
A custom implementation of `TypedActionHandler` must be registered to replace the existing typing handler to receive editor keystroke events. A custom implementation of `TypedActionHandler` must be registered to replace the existing typing handler to receive editor keystroke events.
The registration is done through the [`TypedAction`](%gh-ic%/platform/platform-api/src/com/intellij/openapi/editor/actionSystem/TypedAction.java) class. The registration is done through the [`TypedAction`](%gh-ic%/platform/platform-api/src/com/intellij/openapi/editor/actionSystem/TypedAction.java) class.