DMDirc-Plugins/ui_swing/src/main/java/com/dmdirc/addons/ui_swing/components/statusbar/ErrorPanel.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.UIUtilities;
import com.dmdirc.addons.ui_swing.components.IconManager;
import com.dmdirc.addons.ui_swing.components.menubar.JMenuItemBuilder;
import com.dmdirc.addons.ui_swing.dialogs.errors.ErrorsDialog;
import com.dmdirc.addons.ui_swing.injection.DialogProvider;
import com.dmdirc.addons.ui_swing.injection.MainWindow;
import com.dmdirc.interfaces.ui.ErrorsDialogModel;
import com.dmdirc.interfaces.ui.ErrorsDialogModelListener;
import com.dmdirc.logger.ErrorLevel;
import com.dmdirc.ui.core.errors.DisplayableError;

import java.awt.Window;
import java.awt.event.MouseEvent;
import java.util.Optional;
import java.util.Set;

import javax.inject.Inject;
import javax.inject.Singleton;
import javax.swing.JLabel;
import javax.swing.JPopupMenu;

/**
 * Shows error status in the status bar.
 */
@Singleton
public class ErrorPanel extends StatusbarPopupPanel<JLabel> implements ErrorsDialogModelListener {

    /** Serial version UID. */
    private static final long serialVersionUID = 2;
    /** Parent window that will own popups. */
    private final Window parentWindow;
    /** The manager to use to retrieve icons. */
    private final IconManager iconManager;
    /** Error manager. */
    private final ErrorsDialogModel model;
    /** Dismiss menu. */
    private final JPopupMenu menu;
    /** Error list dialog provider. */
    private final DialogProvider<ErrorsDialog> errorListDialogProvider;

    /**
     * Creates a new ErrorPanel for the specified status bar.
     *
     * @param iconManager             The manager to use to retrieve icons.
     * @param parentWindow            Main frame
     * @param errorListDialogProvider Error list dialog provider.
     */
    @Inject
    public ErrorPanel(
            final IconManager iconManager,
            @MainWindow final Window parentWindow,
            final DialogProvider<ErrorsDialog> errorListDialogProvider,
            final ErrorsDialogModel model) {
        super(new JLabel());
        this.parentWindow = parentWindow;
        this.iconManager = iconManager;
        this.errorListDialogProvider = errorListDialogProvider;
        this.model = model;
        model.addListener(this);
        model.load();

        menu = new JPopupMenu();
        menu.add(JMenuItemBuilder.create().setText("Open")
                .addActionListener(e -> errorListDialogProvider.displayOrRequestFocus()).build());
        menu.add(JMenuItemBuilder.create()
                .setText("Clear All")
                .addActionListener(e -> model.deleteAllErrors())
                .build());
        checkErrors();
    }

    @Override
    protected StatusbarPopupWindow getWindow() {
        return new ErrorPopup(model, iconManager, this, parentWindow);
    }

    /** Checks all the errors for the most significant error. */
    private void checkErrors() {
        final Set<DisplayableError> errors = model.getErrors();
        label.setIcon(iconManager.getIcon(errors.stream().map(DisplayableError::getSeverity)
                .reduce(ErrorLevel.UNKNOWN, ErrorLevel::getMoreImportant).getIcon()));
        setVisible(!errors.isEmpty());
    }

    @Override
    public void mousePressed(final MouseEvent mouseEvent) {
        super.mousePressed(mouseEvent);
        checkMouseEvent(mouseEvent);
    }

    @Override
    public void mouseReleased(final MouseEvent mouseEvent) {
        super.mouseReleased(mouseEvent);
        if (mouseEvent.getButton() == MouseEvent.BUTTON1) {
            errorListDialogProvider.displayOrRequestFocus();
        }
        checkMouseEvent(mouseEvent);
    }

    @Override
    public void mouseEntered(final MouseEvent mouseEvent) {
        super.mouseEntered(mouseEvent);
        checkMouseEvent(mouseEvent);
    }

    @Override
    public void mouseExited(final MouseEvent mouseEvent) {
        super.mouseExited(mouseEvent);
        checkMouseEvent(mouseEvent);
    }

    @Override
    public void mouseClicked(final MouseEvent mouseEvent) {
        super.mouseClicked(mouseEvent);
        checkMouseEvent(mouseEvent);
    }

    /**
     * Checks a mouse event for a popup trigger.
     *
     * @param e Mouse event
     */
    private void checkMouseEvent(final MouseEvent e) {
        if (e.isPopupTrigger()) {
            menu.show(this, e.getX(), e.getY());
        }
    }

    @Override
    public void errorDeleted(final DisplayableError error) {
        UIUtilities.invokeLater(this::checkErrors);
    }

    @Override
    public void errorAdded(final DisplayableError error) {
        UIUtilities.invokeLater(this::checkErrors);
    }

    @Override
    public void selectedErrorChanged(final Optional<DisplayableError> selectedError) {
        //Ignore
    }

    @Override
    public void errorStatusChanged(final DisplayableError error) {
        //Ignore
    }
}