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

jcef.md: link upsource links not working in headings

Browse Source
This commit is contained in:
Yann Cébron 2021-07-13 17:55:08 +02:00
parent 4de35357b8
commit 46c9c35e34
1 changed files with 11 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
topics/reference_guide/jcef.md
View File

@ -55,7 +55,9 @@ Or in order to just open it in a separate window:
## API ## API
### [`JBCefApp`](upsource:///platform/platform-api/src/com/intellij/ui/jcef/JBCefApp.java) ### JBCefApp
[`JBCefApp`](upsource:///platform/platform-api/src/com/intellij/ui/jcef/JBCefApp.java)
Performs JCEF auto-initialization, manages its lifecycle, and provides `JBCefClient` instances. Performs JCEF auto-initialization, manages its lifecycle, and provides `JBCefClient` instances.
Before using JCEF, `JBCefApp.isSupported()` check must be called: Before using JCEF, `JBCefApp.isSupported()` check must be called:
@ -75,14 +77,18 @@ JCEF can be unsupported when:
To avoid the above problems, the IDE should be run with the bundled JBR. To avoid the above problems, the IDE should be run with the bundled JBR.
### [`JBCefClient`](upsource:///platform/platform-api/src/com/intellij/ui/jcef/JBCefClient.java) ### JBCefClient
[`JBCefClient`](upsource:///platform/platform-api/src/com/intellij/ui/jcef/JBCefClient.java)
Is tied to every browser component explicitly or implicitly. Is tied to every browser component explicitly or implicitly.
Used for adding handlers to the associated browser. Used for adding handlers to the associated browser.
The same instance can be shared among multiple browsers. The same instance can be shared among multiple browsers.
It is up to the developer to use a shared or per-browser instance, depending on the handlers' logic. It is up to the developer to use a shared or per-browser instance, depending on the handlers' logic.
If a client was created explicitly, it should be [disposed](disposers.md) by the developer; otherwise, it is disposed automatically following the associated browser instance disposal. If a client was created explicitly, it should be [disposed](disposers.md) by the developer; otherwise, it is disposed automatically following the associated browser instance disposal.
### [`JBCefBrowser`](upsource:///platform/platform-api/src/com/intellij/ui/jcef/JBCefBrowser.java) ### JBCefBrowser
[`JBCefBrowser`](upsource:///platform/platform-api/src/com/intellij/ui/jcef/JBCefBrowser.java)
Provides the browser UI component: Provides the browser UI component:
```java ```java
@ -118,7 +124,8 @@ The simplest way to add a browser component to your UI:
myPanel.add(new JBCefBrowser("https://www.jetbrains.com").getComponent()); myPanel.add(new JBCefBrowser("https://www.jetbrains.com").getComponent());
``` ```
### [`JBCefJSQuery`](upsource:///platform/platform-api/src/com/intellij/ui/jcef/JBCefJSQuery.java) ### JBCefJSQuery
[`JBCefJSQuery`](upsource:///platform/platform-api/src/com/intellij/ui/jcef/JBCefJSQuery.java)
Provides JS query callback mechanism. Provides JS query callback mechanism.