Attaching MouseListener to DefaultHeaderUI

[southafricansoftwaredeveloper]

I would like to attach a mouse listener to the DefaultHeaderUI to I am able to either maximize or minimize the DockingPanel depending on its current state.

[andrewauclair]

You can extend DefaultHeaderUI and add your own code to it. Then return an instance of your custom version in your Dockables createHeaderUI method. If you're using docking-ui, you'll want to extend FlatLafHeaderUI. You can also implement the DockingHeaderUI interface to create a completely custom header.

Note that the maximize/minimize feature appears to be broken based on some quick tests. At least it's not working in the demos.

[southafricansoftwaredeveloper]

Hi Andrew,

So I have tried both approaches, i.e both extending DefaultHeaderUI and implementing DockingHeaderUI.

The minimize and maximize works on my end still, so no worries there!

When implementing the DockingHeaderUI, I do get the mouse listener to work on the HeaderModels' dockable as expected, it's just the header which proves problematic, I reckon I'm probably missing something stupid, when I do get it working, I'll post it here for what it's worth

[southafricansoftwaredeveloper]

As promised, here is my implementation on minimizing and maximizing a dockable when double clicking. I have a class called DockingMouseListener, much like the Benoker docking frames global mouse listener which works great.

`
public class DockingMouseListener {

private static final Logger log = Logger.getLogger(DockingMouseListener.class);
private final Collection<DockingPanel> dockingPanels;
private Point mousePoint;
private String dockableId;

/**
 * Constructs a DockingMouseListener that listens for mouse events on the AWT event queue.
 *
 * @param dockingPanels The collection of DockingPanel instances to manage.
 */
public DockingMouseListener(Collection<DockingPanel> dockingPanels) {
    this.dockingPanels = dockingPanels;
    Toolkit.getDefaultToolkit().addAWTEventListener(this::handleMouseEvent, AWTEvent.MOUSE_EVENT_MASK);
}

/**
 * Handles mouse events, specifically double-clicks on tabs within a CustomTabbedPane.
 * If a double-click occurs on a tab, it retrieves the associated Dockable's ID and
 * toggles the maximize/minimize state of the corresponding DockingPanel.
 *
 * @param event The AWTEvent representing the mouse event.
 */
public void handleMouseEvent(AWTEvent event) {
    if (event instanceof MouseEvent mouseEvent &&
            mouseEvent.getID() == MouseEvent.MOUSE_CLICKED &&
            mouseEvent.getButton() == MouseEvent.BUTTON1 &&
            mouseEvent.getClickCount() == 2 &&
            mouseEvent.getSource() instanceof CustomTabbedPane tabbedPane) {

        mousePoint = mouseEvent.getLocationOnScreen();

        getSelectedTabFromTabbedPane(tabbedPane);

        dockingPanels.stream()
                .filter(panel -> panel.getPersistentID().equals(dockableId))
                .findFirst()
                .ifPresent(this::toggleMaximizeMinimize);
    }

}

/**
 * Retrieves the selected tab index from the given CustomTabbedPane based on the mouse point.
 * If a valid tab index is found, it extracts the Dockable's persistent ID from the DisplayPanel
 * within the selected tab.
 *
 * @param tabbedPane The CustomTabbedPane containing the tab that was clicked.
 */
public void getSelectedTabFromTabbedPane(CustomTabbedPane tabbedPane) {

    var tabIndex = tabbedPane.getTargetTabIndex(mousePoint, false);

    if (tabIndex == -1) {
        log.info("No target tab selected");
        dockableId = null;
        return;
    }

    var tabbedPanel = (DisplayPanel) tabbedPane.getComponentAt(tabIndex);

    if(tabbedPanel == null) {
        log.warn("No DisplayPanel found at selected tab index");
        dockableId = null;
        return;
    }

    dockableId = tabbedPanel.getWrapper().getDockable().getPersistentID();
}

/**
 * Toggles the maximize/minimize state of the specified DockingPanel.
 * If the panel is currently maximized, it will be minimized; otherwise, it will be maximized.
 *
 * @param dockingPanel The DockingPanel whose state will be updated.
 */
public void toggleMaximizeMinimize(DockingPanel dockingPanel) {

    log.info("Handling dockable " + dockableId);

    var headerController = dockingPanel.getHeaderController();

    if (dockingPanel.getHeaderModel().isMaximized()) {
        headerController.minimize();
    } else {
        headerController.maximize();
    }

    dockableId = "";
}

public String getDockableId(){
    return dockableId;
}

}
`