SystemTray/src/dorkbox/systemTray/swing/SwingSystemTrayLinuxMenuPopup.java

/*
 * Copyright 2014 dorkbox, llc
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package dorkbox.systemTray.swing;

import java.awt.Dimension;
import java.awt.MouseInfo;
import java.awt.Point;
import java.awt.event.MouseAdapter;
import java.awt.event.MouseEvent;
import java.util.ArrayList;
import java.util.List;

import javax.swing.JPopupMenu;
import javax.swing.border.EmptyBorder;

import dorkbox.util.DelayTimer;
import dorkbox.util.Property;
import dorkbox.util.SwingUtil;

/**
 * This custom popup is required, because we cannot close this popup by clicking OUTSIDE the popup. For whatever reason, that does not
 * work, so we must implement an "auto-hide" feature that checks if our mouse is still inside a menu every POPUP_HIDE_DELAY seconds
 */
public
class SwingSystemTrayLinuxMenuPopup extends JPopupMenu {
    private static final long serialVersionUID = 1L;

    @Property
    /** Customize the delay (for hiding the popup) when the cursor is "moused out" of the popup menu */
    public static long POPUP_HIDE_DELAY = 1000L;

    @Property
    /** Customize the minimum amount of movement needed to cause the popup-delay to hide the popup */
    public static int MOVEMENT_DELTA = 20;

    private DelayTimer timer;

    protected volatile Point mouseClickLocation = null;

    // keep track of what popup is showing so we can check mouse bounds on that popup
    private final List<JPopupMenu> trackedMenus = new ArrayList<JPopupMenu>(4);

    // NOTE: we can use the "hidden dialog" focus window trick... only on windows and mac
    // private JDialog hiddenDialog;

    SwingSystemTrayLinuxMenuPopup() {
        super();
        setFocusable(true);
//        setBorder(new BorderUIResource.EmptyBorderUIResource(0, 0, 0, 0)); // borderUI resource border type will get changed!
        setBorder(new EmptyBorder(1, 1, 1, 1));
        trackedMenus.add(this);

        this.timer = new DelayTimer("PopupMenuHider", true, new Runnable() {
            @Override
            public
            void run() {
                SwingUtil.invokeLater(new Runnable() {
                    @Override
                    public
                    void run() {
                        if (!isVisible()) {
                            return;
                        }

                        Point location = MouseInfo.getPointerInfo()
                                                  .getLocation();

                        // are we inside one of our tracked menus (the root menu is included)
                        synchronized (trackedMenus) {
                            for (JPopupMenu trackedMenu : trackedMenus) {
                                Point menuLocation = trackedMenu.getLocationOnScreen();
                                Dimension size = trackedMenu.getSize();

                                if (location.x >= menuLocation.x && location.x < menuLocation.x + size.width &&
                                    location.y >= menuLocation.y && location.y < menuLocation.y + size.height
                                   ) {

                                    // restart the timer
                                    SwingSystemTrayLinuxMenuPopup.this.timer.delay(POPUP_HIDE_DELAY);
                                    return;
                                }
                            }
                        }


                        // has the mouse pointer moved > delta pixels from it's original location (when the tray icon was clicked)?
                        if (mouseClickLocation != null &&
                            location.x >= mouseClickLocation.x - MOVEMENT_DELTA && location.x < mouseClickLocation.x + MOVEMENT_DELTA &&
                            location.y >= mouseClickLocation.y - MOVEMENT_DELTA && location.y < mouseClickLocation.y + MOVEMENT_DELTA
                            ) {

                            // restart the timer
                            SwingSystemTrayLinuxMenuPopup.this.timer.delay(POPUP_HIDE_DELAY);
                            return;
                        }

                        // else, we hide it
                        setVisible(false);
                    }
                });
            }
        });

        addMouseListener(new MouseAdapter() {
            @Override
            public
            void mouseExited(MouseEvent event) {
                // wait before checking if mouse is still on the menu
                SwingSystemTrayLinuxMenuPopup.this.timer.delay(SwingSystemTrayLinuxMenuPopup.this.timer.getDelay());
            }
        });
    }

    @Override
    public
    void setVisible(boolean makeVisible) {
        // only allow java to close this popup if our timer closed it
        this.timer.cancel();

        if (makeVisible) {
            mouseClickLocation = MouseInfo.getPointerInfo().getLocation();

            // if the mouse isn't inside the popup in x seconds, close the popup
            this.timer.delay(POPUP_HIDE_DELAY);
        }

        super.setVisible(makeVisible);
    }


    public
    void track(final JPopupMenu menu, final boolean visible) {
        if (visible) {
            synchronized (trackedMenus) {
                trackedMenus.add(menu);
            }
        } else {
            synchronized (trackedMenus) {
                trackedMenus.remove(menu);
            }
        }

        // restart the timer
        SwingSystemTrayLinuxMenuPopup.this.timer.delay(POPUP_HIDE_DELAY);
    }

    public
    void close() {
        this.timer.cancel();
    }
}