Allowing "CopyToClipboard" action in custom DiffRequestPanel

IntelliJ Platform
1

I’m currently embedding a customized DiffRequestPanel (with my own DiffRequestProcessor) within an Inlay Component.

Unfortunately, I’m unable to enable to user to use the Cmd+C shortcut to copy the displayed code they select within that panel.

I tried using this, but haven’t succeeded so far:

/** A JComponent in an Inlay Component does not properly capture Key Events. This fixes that. */
interface KeyboardAwareInlayComponent : KeyboardAwareFocusOwner {
  override fun skipKeyEventDispatcher(ke: KeyEvent): Boolean = true
}

Is there something special I need to do for a DiffRequestPanel in this case?

3

Hi @jeremibg! What is the component you are trying to copy text from?

Just in case, there is a handy tool for UI exploring - Internal Actions – UI Inspector | IntelliJ Platform Plugin SDK

4

Hard to know which one it is that I should try to apply this interface on.
The deepest child which seems to be where the text is living is the EditorComponentImpl that sits inside a JBScrollPane:

image
image1630×1630 474 KB

If it’s that component that is supposed to implement the interface, what is the suggested way to apply such a chance given how deeply ingrained this is?

5

@jeremibg you are right, the interface should be implemented by the component. Could you please try to apply it to the component returned by DiffRequestPanel#getComponent?

If it might be useful - here is the logic of KeyboardAwareFocusOwner processing - intellij-community/platform/platform-impl/src/com/intellij/openapi/keymap/impl/IdeKeyEventDispatcher.kt at 4134398009db5de8c37cdf0ae8e30f1b783f7862 · JetBrains/intellij-community · GitHub

6

I’ve already tried making this myPanel anonymous class to implement KeyboardAwareInlayComponent:

It didn’t fix the issue :frowning:

7

Hi @jeremibg

If I understand your original question (diff panel as an editor inlay) correctly, then you need something like this:

val diffRequestPanel = DiffManager.getInstance().createRequestPanel(project, newDisposable, null)
val content1 = DiffContentFactoryEx.getInstanceEx().create("1111")
val content2 = DiffContentFactoryEx.getInstanceEx().create("2222")
val simpleDiffRequest = SimpleDiffRequest("title", content1, content2, "1", "2")
diffRequestPanel.setRequest(simpleDiffRequest)

val properties = InlayProperties().showAbove(true)
editor.addComponentInlay(offset, properties, diffRequestPanel.component, ComponentInlayAlignment.STRETCH_TO_CONTENT_WIDTH)

Please, give us more details if it doesn’t solve your case

8

Hi @akrasilnikov,

The precision about the diff panel being a component inlay was mostly to point out why I have to resort to using that KeyboardAwareFocusOwner interface, and why I’m unable to get it to work as expected to allow copying the content of the DiffPanel.

I already have my component added as a component inlay in the editor: that is not my issue.

I’m trying to understand on which of the components that compose a DiffRequestPanel I need to apply the KeyboardAwareFocusOwner interface to allow my users to copy-paste the displayed content.

InlayComponent

In case that can help, this is how I create and insert it:

    val properties =
        EditorEmbeddedComponentManager.Properties(
            EditorEmbeddedComponentManager.ResizePolicy.any(),
            null,
            false,
            true,
            true,
            true,
            0,
            editorContext.selectedOffsetStart) // always appear at top of selected context
    val inlay = EditorEmbeddedComponentManager.getInstance().addComponent(editor, panel, properties)

The panel that is inserted is a JPanel which contains DiffRequestPanel#getComponent.

You can try yourself: you’ll see that even if the JComponent returned by DiffRequestPanel#getComponent implements KeyboardAwareFocusOwner correctly, the copy commands (Cmd+C) will not be registered appropriately.

9

@jeremibg I tried the following snippet, but in my case copying works out-of-the-box for the inlay editor

val properties =
  EditorEmbeddedComponentManager.Properties(
    EditorEmbeddedComponentManager.ResizePolicy.any(),
    null,
    false,
    true,
    true,
    true,
    0,
    0)

val request = SimpleDiffRequest("Demo", DiffContentFactory.getInstance().create("test"), DiffContentFactory.getInstance().create("tes2"),
                                "1", "2")
val requestPanel = DiffManager.getInstance().createRequestPanel(null, Disposable {}, null)
requestPanel.setRequest(request)
val wrapper = JPanel()
wrapper.add(requestPanel.component)
EditorEmbeddedComponentManager.getInstance().addComponent(editor, wrapper, properties)
10

@ilia.shulgin I tried using the exact example code snippet you used, and I personally still get the clipboard issue.

I wonder if it’s an IDE version issue.
Could you try to repro on:

Android Studio Koala | 2024.1.1
Build #AI-241.15989.150.2411.11948838, built on June 10, 2024
Runtime version: 17.0.11+1-b1207.24 aarch64
VM: OpenJDK 64-Bit Server VM by JetBrains s.r.o.
macOS 15.3.2
Kotlin analyzer version: 2.0.0-ij241.15989-9
GC: G1 Young Generation, G1 Old Generation
Memory: 16384M
Cores: 16
Metal Rendering is ON
Registry:
  ide.browser.jcef.osr.enabled=false
  ide.browser.jcef.markdownView.osr.enabled=false
  ide.browser.jcef.sandbox.enable=false
  debugger.enable.memory.view=false
  debugger.enable.overhead.monitor=false
  projectView.showHierarchyErrors=false
  performance.watcher.unresponsive.interval.ms=1000
  idea.invalidate.caches.invalidates.vfs=true
  light.edit.file.open.enabled=false
  ide.experimental.ui=true
  ide.slow.operations.assertion=false
  ide.background.save.settings=false

Double-check

But just to make sure we’re aligned on the issue:

  1. Insert a DiffRequestPanel inline as an inlay in an editor with EditorEmbeddedComponentManager#addComponent
  2. Select the code that is displayed inside the DiffRequestPanel and try to copy it
  3. In my case, what happens is that the copy command is not issued to the appropriate editor: it is the code in the original editor in which the inlay is embedded that gets highlighted and copied, not the code within the DiffRequest
11

Hi @jeremibg

Would you mind recording some screen cast to demonstrate what happens with the editor and diff in your case? I hope it helps us understand the issue better

if you don’t like to share it publicly here, please try the JetBrains Upload Service https://uploads.jetbrains.com/ and provide the Upload ID

12

Hi @akrasilnikov , here is a recording:

Upload id: 2025_03_27_SSpyUNfitWEcgvGabHJNEA (file: bug_demo_jetbrains.mov)

After selecting text within the diff view, I press Cmd+C. This ends up selecting L46 (and copying it) in the original Editor because that is where my caret was when I inserted the Inlay.
I then place my caret focus back into the original Editor and press Cmd+V to show that the clipboard content is indeed L46, instead of being the text which I had selected and intended to copy from within the diff view.

(P.S. It seems like there isn’t a way to upload or embed a *.mov directly in here. I was essentially forced to go through https://uploads.jetbrains.com/)

13

Hi @akrasilnikov, I’m noticing the same clipboard issue using DiffRequestPanel on version AI-241. Interestingly, my custom plugin in AI-243, using the same exact plugin code for AI-241, does not have the same clipboard issues. Cmd+C will simply work in AI-243 without any changes. Are you aware of any changes made to DiffRequestPanel that could be causing these inconsistencies? I’ve looked though the commit history between idea/241.15989.150 to idea/243.22562.218 but have not seen anything that stands out. I’m hoping to fix this for AI-241 specifically since my team is not migrated over to the latest IDE version yet.