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

background_processes.md: Add a tip for running backgroundable tasks under a custom progress indicator

Browse Source
This commit is contained in:
Karol Lewandowski 2025-01-14 12:24:39 +01:00
parent 20cac10a3a
commit 429e9698b5
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
topics/basics/architectural_overview/background_processes.md
View File

@ -43,7 +43,7 @@ The key classes are:
### Starting ### Starting
Background processes encapsulated within `Task` should be run with queueing them. Background processes encapsulated within `Task` can be run with queueing them.
Example: Example:
<tabs group="languages"> <tabs group="languages">
@ -73,6 +73,14 @@ new Task.Backgroundable(project, "Synchronizing data", true) {
</tab> </tab>
</tabs> </tabs>
> To run a backgroundable task under a custom progress indicator, for example, `EmptyProgressIndicator` to hide progress, use:
> ```kotlin
> ProgressManager.getInstance()
> .runProcessWithProgressAsynchronously(
> backgroundableTask, EmptyProgressIndicator())
> ```
> Note that hiding progress from users should be avoided as it may break the UX.
`ProgressManager` also allows running `Runnable` and `Computable` instances not wrapped within `Task` with several `run*()` methods. `ProgressManager` also allows running `Runnable` and `Computable` instances not wrapped within `Task` with several `run*()` methods.
Example: Example: