ModernDocking.internal.ActiveDockableHighlighter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of modern-docking-api Show documentation
Modern docking library for Java Swing
There is a newer version: 0.11.6
/*
Copyright (c) 2022 Andrew Auclair

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
 */
package ModernDocking.internal;

import ModernDocking.Dockable;
import ModernDocking.api.DockingAPI;
import ModernDocking.api.RootDockingPanelAPI;
import ModernDocking.exception.DockableRegistrationFailureException;
import ModernDocking.ui.DockingSettings;

import javax.swing.*;
import java.awt.*;
import java.awt.event.MouseEvent;

/**
 * This class is responsible for adding a selected border around the dockable at the current mouse position.
 * 
 * Using an AWT Event Listener we can listen for global MOUSE_ENTERED and MOUSE_EXITED to add/remove the border.
 */
public class ActiveDockableHighlighter {
	// the current active panel
	private DockingPanel activePanel = null;

	/**
	 * Default constructor to create the highlighter
	 */
	public ActiveDockableHighlighter(DockingAPI docking) {
		// use an AWT event listener to set a border around the dockable that the mouse is currently over
		Toolkit.getDefaultToolkit().addAWTEventListener(e -> {
			if (e.getID() == MouseEvent.MOUSE_ENTERED || e.getID() == MouseEvent.MOUSE_EXITED) {
				DockingPanel dockable = DockingComponentUtils.findDockingPanelAtScreenPos(docking, ((MouseEvent) e).getLocationOnScreen());

				if (activePanel != null && dockable == null) {
					setNotSelectedBorder(activePanel);
					activePanel = null;
				}

				if (activePanel != dockable && (dockable instanceof DockedSimplePanel || dockable instanceof DockedTabbedPanel)) {
					if (activePanel != null) {
						setNotSelectedBorder(activePanel);
					}
					activePanel = dockable;
					setSelectedBorder();
				}

			}
			else if (e.getID() == MouseEvent.MOUSE_PRESSED) {
				Dockable dockable = DockingComponentUtils.findDockableAtScreenPos(docking, ((MouseEvent) e).getLocationOnScreen());

				if (dockable != null) {
					Window window = DockingComponentUtils.findWindowForDockable(docking, dockable);

					if (!DockingInternal.get(docking).getWrapper(dockable).isUnpinned()) {
						try {
							RootDockingPanelAPI root = DockingComponentUtils.rootForWindow(docking, window);
							root.hideUnpinnedPanels();
						}
						catch (DockableRegistrationFailureException ignore) {
						}
					}
				}
			}
		}, AWTEvent.MOUSE_EVENT_MASK);

		UIManager.addPropertyChangeListener(e -> {
			if ("lookAndFeel".equals(e.getPropertyName())) {
				SwingUtilities.invokeLater(() -> {
					if (activePanel != null) {
						setSelectedBorder();
					}
				});

			}
		});
	}

	private void setSelectedBorder() {
		Color color = DockingSettings.getHighlighterSelectedBorder();
		activePanel.setBorder(BorderFactory.createLineBorder(color, 2));
	}

	public static void setNotSelectedBorder(DockingPanel panel) {
		Color color = DockingSettings.getHighlighterNotSelectedBorder();

		panel.setBorder(
				BorderFactory.createCompoundBorder(
						BorderFactory.createEmptyBorder(1, 1, 1, 1),
						BorderFactory.createLineBorder(color, 1)
				)
		);
	}
}