Skip to content

Commit

Permalink
Fix mouse input above interop view (#1119)
Browse files Browse the repository at this point in the history 
## Proposed Changes

- Add one more mouse listener for a case when AWT dispatches all events
only to interop view

## Testing

Test: try to click on the button above `SwingPanel` on macOS

## Issues Fixed

Fixes
#915 (comment)
  • Loading branch information
@MatkovIvan @igordmn
MatkovIvan authored and igordmn committed Feb 19, 2024
1 parent b1e41c8 commit c22ebd3
Show file tree
Hide file tree
Showing 2 changed files with 77 additions and 25 deletions.
10 changes: 9 additions & 1 deletion compose/ui/ui/src/desktopMain/kotlin/androidx/compose/ui/awt/SwingPanel.desktop.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,6 @@ import androidx.compose.ui.input.pointer.changedToDownIgnoreConsumed
import androidx.compose.ui.input.pointer.changedToUpIgnoreConsumed
import androidx.compose.ui.layout.Layout
import androidx.compose.ui.layout.boundsInRoot
import androidx.compose.ui.layout.boundsInWindow
import androidx.compose.ui.layout.onGloballyPositioned
import androidx.compose.ui.platform.LocalDensity
import androidx.compose.ui.platform.LocalFocusManager
Expand Down Expand Up @@ -348,6 +347,15 @@ private class InteropPointerInputModifier<T : Component>(

private fun dispatchToView(pointerEvent: PointerEvent) {
val e = pointerEvent.awtEventOrNull ?: return
when (e.id) {
// Do not redispatch Enter/Exit events since they are related exclusively
// to original component.
MouseEvent.MOUSE_ENTERED, MouseEvent.MOUSE_EXITED -> return
}
if (SwingUtilities.isDescendingFrom(e.component, componentInfo.container)) {
// Do not redispatch the event if it originally from this interop view.
return
}
val containerPoint = SwingUtilities.convertPoint(root, e.point, componentInfo.component)
val component = SwingUtilities.getDeepestComponentAt(
componentInfo.component,
Expand Down
92 changes: 68 additions & 24 deletions ...se/ui/ui/src/desktopMain/kotlin/androidx/compose/ui/scene/ComposeSceneMediator.desktop.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ import androidx.compose.ui.ComposeFeatureFlags
import androidx.compose.ui.focus.FocusDirection
import androidx.compose.ui.focus.FocusManager
import androidx.compose.ui.geometry.Offset
import androidx.compose.ui.geometry.Size
import androidx.compose.ui.graphics.asComposeCanvas
import androidx.compose.ui.input.pointer.*
import androidx.compose.ui.platform.*
Expand All @@ -47,7 +46,6 @@ import java.awt.event.KeyEvent
import java.awt.im.InputMethodRequests
import javax.accessibility.Accessible
import javax.swing.JLayeredPane
import javax.swing.RootPaneContainer
import javax.swing.SwingUtilities
import kotlin.coroutines.CoroutineContext
import org.jetbrains.skia.Canvas
Expand Down Expand Up @@ -93,17 +91,34 @@ internal class ComposeSceneMediator(
private val clipMap = mutableMapOf<Component, ClipComponent>()

override fun componentAdded(e: ContainerEvent) {
val component = e.child
if (useInteropBlending) {
return
// In case of interop blending, compose might draw content above this [component].
// But due to implementation of [JLayeredPane]'s lightweight/heavyweight mixing
// logic, it doesn't send mouse events to parents or another layers.
// In case if [component] is placed above [contentComponent] (see addToLayer),
// subscribe to mouse events from interop views to handle such input.
component.subscribeToMouseEvents(mouseListener)
} else {
// Without interop blending, just add clip region to make proper
// "interop always on top" behaviour.
addClipComponent(component)
}
}

override fun componentRemoved(e: ContainerEvent) {
val component = e.child
removeClipComponent(component)
component.unsubscribeFromMouseEvents(mouseListener)
}

private fun addClipComponent(component: Component) {
val clipRectangle = ClipComponent(component)
clipMap[component] = clipRectangle
skiaLayerComponent.clipComponents.add(clipRectangle)
}

override fun componentRemoved(e: ContainerEvent) {
val component = e.child
private fun removeClipComponent(component: Component) {
clipMap.remove(component)?.let {
skiaLayerComponent.clipComponents.remove(it)
}
Expand Down Expand Up @@ -143,17 +158,14 @@ internal class ComposeSceneMediator(
}
}
private val mouseListener = object : MouseAdapter() {
override fun mouseClicked(event: MouseEvent) = Unit
override fun mousePressed(event: MouseEvent) = onMouseEvent(event)
override fun mouseReleased(event: MouseEvent) = onMouseEvent(event)
override fun mouseEntered(event: MouseEvent) = onMouseEvent(event)
override fun mouseExited(event: MouseEvent) = onMouseEvent(event)
}
private val mouseMotionListener = object : MouseMotionAdapter() {
override fun mouseDragged(event: MouseEvent) = onMouseEvent(event)
override fun mouseMoved(event: MouseEvent) = onMouseEvent(event)
override fun mouseWheelMoved(event: MouseWheelEvent) = onMouseWheelEvent(event)
}
private val mouseWheelListener = MouseWheelListener { event -> onMouseWheelEvent(event) }
private val keyListener = object : KeyAdapter() {
override fun keyPressed(event: KeyEvent) = onKeyEvent(event)
override fun keyReleased(event: KeyEvent) = onKeyEvent(event)
Expand Down Expand Up @@ -228,15 +240,16 @@ internal class ComposeSceneMediator(
get() = if (useInteropBlending) 0 else 20

init {
/*
* Transparency is used during redrawer creation that triggered by [addNotify], so
* it must be set to correct value before adding to the hierarchy to handle cases
* when [container] is already [isDisplayable].
*/
// Transparency is used during redrawer creation that triggered by [addNotify], so
// it must be set to correct value before adding to the hierarchy to handle cases
// when [container] is already [isDisplayable].
skiaLayerComponent.transparency = useInteropBlending

container.addToLayer(invisibleComponent, contentLayer)
container.addToLayer(contentComponent, contentLayer)

// Adding a listener after adding [invisibleComponent] and [contentComponent]
// to react only on changes with [interopLayer].
container.addContainerListener(containerListener)

// It will be enabled dynamically. See DesktopPlatformComponent
Expand Down Expand Up @@ -264,19 +277,33 @@ internal class ComposeSceneMediator(
private fun subscribe(component: Component) {
component.addInputMethodListener(inputMethodListener)
component.addFocusListener(focusListener)
component.addMouseListener(mouseListener)
component.addMouseMotionListener(mouseMotionListener)
component.addMouseWheelListener(mouseWheelListener)
component.addKeyListener(keyListener)
component.subscribeToMouseEvents(mouseListener)
}

private fun unsubscribe(component: Component) {
component.removeInputMethodListener(inputMethodListener)
component.removeFocusListener(focusListener)
component.removeMouseListener(mouseListener)
component.removeMouseMotionListener(mouseMotionListener)
component.removeMouseWheelListener(mouseWheelListener)
component.removeKeyListener(keyListener)
component.unsubscribeFromMouseEvents(mouseListener)
}

private var isMouseEventProcessing = false
private inline fun processMouseEvent(block: () -> Unit) {
// Filter out mouse event if [ComposeScene] is already processing this mouse event
if (isMouseEventProcessing) {
return
}

// Track if [event] is currently processing to avoid recursion in case if [SwingPanel]
// manually spawns a new AWT event for interop view.
// See [InteropPointerInputModifier] for details.
isMouseEventProcessing = true
try {
block()
} finally {
isMouseEventProcessing = false
}
}

// Decides which AWT events should be delivered, and which should be filtered out
Expand All @@ -286,8 +313,9 @@ internal class ComposeSceneMediator(

fun shouldSendMouseEvent(event: MouseEvent): Boolean {
// AWT can send events after the window is disposed
if (isDisposed)
if (isDisposed) {
return false
}

// Filter out mouse events that report the primary button has changed state to pressed,
// but aren't themselves a mouse press event. This is needed because on macOS, AWT sends
Expand Down Expand Up @@ -317,7 +345,7 @@ internal class ComposeSceneMediator(

private val MouseEvent.position: Offset
get() {
val pointInContainer = SwingUtilities.convertPoint(contentComponent, point, container)
val pointInContainer = SwingUtilities.convertPoint(component, point, container)
val offset = sceneBoundsInPx?.topLeft?.toOffset() ?: Offset.Zero
val density = contentComponent.density
return Offset(pointInContainer.x.toFloat(), pointInContainer.y.toFloat()) * density.density - offset
Expand All @@ -331,14 +359,18 @@ internal class ComposeSceneMediator(
keyboardModifiersRequireUpdate = false
windowContext.setKeyboardModifiers(event.keyboardModifiers)
}
scene.onMouseEvent(event.position, event)
processMouseEvent {
scene.onMouseEvent(event.position, event)
}
}

private fun onMouseWheelEvent(event: MouseWheelEvent): Unit = catchExceptions {
if (!awtEventFilter.shouldSendMouseEvent(event)) {
return
}
scene.onMouseWheelEvent(event.position, event)
processMouseEvent {
scene.onMouseWheelEvent(event.position, event)
}
}

private fun onKeyEvent(event: KeyEvent) = catchExceptions {
Expand Down Expand Up @@ -701,6 +733,18 @@ private val MouseEvent.keyboardModifiers get() = PointerKeyboardModifiers(
isNumLockOn = getLockingKeyStateSafe(KeyEvent.VK_NUM_LOCK),
)

private fun Component.subscribeToMouseEvents(mouseAdapter: MouseAdapter) {
addMouseListener(mouseAdapter)
addMouseMotionListener(mouseAdapter)
addMouseWheelListener(mouseAdapter)
}

private fun Component.unsubscribeFromMouseEvents(mouseAdapter: MouseAdapter) {
removeMouseListener(mouseAdapter)
removeMouseMotionListener(mouseAdapter)
removeMouseWheelListener(mouseAdapter)
}

private fun getLockingKeyStateSafe(
mask: Int
): Boolean = try {
Expand Down

0 comments on commit c22ebd3

Please sign in to comment.