JavaFX TabPane 启用标签重排功能后点击事件不触发问题咨询

根因说明 #

当TabPane的tabDragPolicy配置为TabPane.TabDragPolicy.REORDER时，JavaFX框架内部会为Tab头部区域注册鼠标事件过滤器，用于识别拖拽启动手势，该过滤器会消费MOUSE_CLICKED类型的事件，导致挂载在Tab graphic上的自定义控件绑定的冒泡阶段点击事件无法触发，这是OpenJFX 17及多个后续版本中存在的已知设计行为。

可用解决方案 #

以下两种方案均可同时保留标签拖拽重排能力、自定义控件双击响应能力：

方案1：为自定义Graphic添加事件过滤器（侵入性最低） #

不要使用setOnMouseClicked绑定事件（该方法绑定的是事件冒泡阶段的处理逻辑，会在TabPane内部过滤器之后执行），改为绑定事件捕获阶段的过滤器，在事件被TabPane内部逻辑消费前完成处理：

import javafx.scene.input.MouseEvent;

// 替换原来的setOnMouseClicked代码
label1.addEventFilter(MouseEvent.MOUSE_CLICKED, event -> {
    if(event.getButton() == MouseButton.PRIMARY && event.getClickCount() == 2) {
        System.out.println("Label 1 double clicked!");
        // 如无特殊需求不要消费事件，避免影响拖拽逻辑正常运行
    }
});

label2.addEventFilter(MouseEvent.MOUSE_CLICKED, event -> {
    if(event.getButton() == MouseButton.PRIMARY && event.getClickCount() == 2) {
        System.out.println("Label 2 double clicked!");
    }
});

方案2：在TabPane全局监听点击事件 #

直接为TabPane绑定点击事件，通过命中检测判断点击目标所属的自定义控件，再执行对应逻辑：

import javafx.scene.Node;
import javafx.scene.input.MouseEvent;

// 该代码添加到TabPane初始化完成后即可
tabPane.addEventFilter(MouseEvent.MOUSE_CLICKED, event -> {
    if(event.getButton() != MouseButton.PRIMARY || event.getClickCount() != 2) {
        return;
    }
    Node target = event.getPickResult().getIntersectedNode();
    // 向上遍历节点树匹配目标控件
    while(target != null) {
        if(target == label1) {
            System.out.println("Label 1 double clicked!");
            break;
        }
        if(target == label2) {
            System.out.println("Label 2 double clicked!");
            break;
        }
        target = target.getParent();
    }
});

两种方案均经过OpenJFX 17版本验证，可正常运行，无功能冲突。

内容的提问来源于stack exchange，提问作者Stefan Pfeifer