NavigationWindow.java

/* The MIT License (MIT)
 *
 * Copyright (c) 2015 Reinventing Geospatial, Inc.
 *
 * 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.rgi.suite.uielements.windows;

import java.awt.BorderLayout;
import java.awt.GridBagConstraints;
import java.awt.GridBagLayout;
import java.awt.Insets;
import java.awt.event.WindowEvent;

import javax.swing.JButton;
import javax.swing.JFrame;
import javax.swing.JOptionPane;
import javax.swing.JPanel;

import com.rgi.common.util.ThrowableUtility;

/**
 * Abstract base window with a simple content panel, and OK/Cancel buttons
 *
 * @author Luke Lambert
 *
 */
public abstract class NavigationWindow extends JFrame
{
    private static final long serialVersionUID = 8504437764097328769L;

    protected final JPanel contentPanel = new JPanel();

    // Navigation stuff
    protected final JPanel  navigationPanel = new JPanel(new GridBagLayout());
    protected final JButton okButton        = new JButton("OK");
    protected final JButton cancelButton    = new JButton("Cancel");

    /**
     * Constructor
     *
     * Constructs the basic window layout, and OK/Cancel buttons
     */
    public NavigationWindow()
    {
        this.setLayout(new BorderLayout());

        this.add(this.contentPanel,    BorderLayout.CENTER);
        this.add(this.navigationPanel, BorderLayout.SOUTH);

        this.cancelButton.addActionListener(e -> { this.closeFrame(); });

        this.okButton.addActionListener(e -> { try
                                               {
                                                   if(this.execute())
                                                   {
                                                       this.closeFrame();
                                                   }
                                               }
                                               catch(final Throwable th)
                                               {
                                                   th.printStackTrace();
                                                   this.error(th);
                                               }
                                             });

        // Add buttons to pane
        final Insets insets = new Insets(10, 10, 10, 10);
        final int    fill   = GridBagConstraints.NONE;

        this.navigationPanel.add(this.okButton,     new GridBagConstraints(0, 0, 1, 1, 0, 0, GridBagConstraints.EAST, fill, insets, 0, 0));
        this.navigationPanel.add(this.cancelButton, new GridBagConstraints(1, 0, 1, 1, 0, 0, GridBagConstraints.EAST, fill, insets, 0, 0));
    }

    protected abstract boolean execute() throws Exception;

    protected abstract String processName();

    protected void warn(final String message)
    {
        JOptionPane.showMessageDialog(this,
                                      message,
                                      this.processName(),
                                      JOptionPane.WARNING_MESSAGE);
    }

    protected void error(final String message)
    {
        JOptionPane.showMessageDialog(this,
                                      message,
                                      this.processName(),
                                      JOptionPane.ERROR_MESSAGE);
    }

    protected void error(final Throwable th)
    {
        if (th == null)
        {
           throw new IllegalArgumentException("Throwable cannot be null.");
        }

        this.error("An error has occurred: " + ThrowableUtility.getRoot(th).getMessage());
    }

    protected void closeFrame()
    {
        this.dispatchEvent(new WindowEvent(this, WindowEvent.WINDOW_CLOSING));
    }
}