DMDirc-Plugins/ui_swing/src/main/java/com/dmdirc/addons/ui_swing/components/statusbar/StatusbarPopupWindow.java

/*
 * Copyright (c) 2006-2017 DMDirc Developers
 *
 * 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 NONINFRINGEMENT. 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 com.dmdirc.addons.ui_swing.components.statusbar;

import com.dmdirc.addons.ui_swing.dialogs.StandardDialog;

import java.awt.Point;
import java.awt.Window;

import javax.swing.JDialog;
import javax.swing.JPanel;
import javax.swing.UIManager;

import net.miginfocom.swing.MigLayout;

/**
 * A popup window which is shown above a status bar component to provide more detailed information.
 *
 * @since 0.6.3m1
 */
public abstract class StatusbarPopupWindow extends StandardDialog {

    /** A version number for this class. */
    private static final long serialVersionUID = 1;
    /** The parent JPanel. */
    private final JPanel parent;
    /** Parent window. */
    private final Window parentWindow;

    /**
     * Creates a new status bar popup window.
     *
     * @param parent       The {@link JPanel} to use for positioning
     * @param parentWindow Parent window
     */
    public StatusbarPopupWindow(
            final JPanel parent,
            final Window parentWindow) {
        super(parentWindow, ModalityType.MODELESS);

        this.parent = parent;
        this.parentWindow = parentWindow;

        setDefaultCloseOperation(JDialog.DISPOSE_ON_CLOSE);
    }

    @Override
    public void setVisible(final boolean b) {
        if (b && parent.isVisible()) {
            final JPanel panel = new JPanel();

            initPanel(panel);
            initContent(panel);

            add(panel);

            setUndecorated(true);
            setFocusableWindowState(false);
            setFocusable(false);
            setResizable(false);

            pack();
            setLocation(getPopupLocation());
        }

        super.setVisible(b);
    }

    /**
     * Returns the location the popup window should appear at.
     *
     * @return Point for popup to appear
     */
    protected Point getPopupLocation() {
        final Point point = parent.getLocationOnScreen();
        point.translate(parent.getWidth() / 2 - getWidth() / 2,
                -getHeight());
        final int maxX = Math.max(parentWindow.getLocationOnScreen().x
                + parentWindow.getWidth() - 10 - getWidth(),
                parent.getLocationOnScreen().x + parent.getWidth() - 1
                - getWidth());
        point.x = Math.min(maxX, point.x);
        return point;
    }

    /**
     * Returns the parent panel for this popup window.
     *
     * @return Parent panel
     */
    public JPanel getParentPanel() {
        return parent;
    }

    /**
     * Initialises the panel used in the popup window.
     *
     * @param panel The {@link JPanel} to be initialised
     */
    protected void initPanel(final JPanel panel) {
        panel.setLayout(new MigLayout("ins 3 5 6 10, gap 10 5"));
        panel.setBackground(UIManager.getColor("ToolTip.background"));
        panel.setForeground(UIManager.getColor("ToolTip.foreground"));
        panel.setBorder(new GappedEtchedBorder(this));
    }

    /**
     * Initialises the content of the popup window.
     *
     * @param panel The {@link JPanel} to which content should be added
     */
    protected abstract void initContent(final JPanel panel);

}