package nl.tudelft.simulation.dsol.swing.gui;

import java.awt.BorderLayout;
import java.rmi.RemoteException;

import javax.swing.JPanel;
import javax.swing.JScrollPane;
import javax.swing.SwingConstants;

import nl.tudelft.simulation.dsol.SimRuntimeException;
import nl.tudelft.simulation.dsol.logger.SimLogger;
import nl.tudelft.simulation.dsol.model.DSOLModel;
import nl.tudelft.simulation.dsol.simtime.SimTime;
import nl.tudelft.simulation.dsol.simulators.SimulatorInterface;

/**
 * <p>
 * Copyright (c) 2002-2019 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved. See
 * for project information <a href="https://simulation.tudelft.nl/" target="_blank"> https://simulation.tudelft.nl</a>. The DSOL
 * project is distributed under a three-clause BSD-style license, which can be found at
 * <a href="https://simulation.tudelft.nl/dsol/3.0/license.html" target="_blank">
 * https://simulation.tudelft.nl/dsol/3.0/license.html</a>.
 * </p>
 * @author <a href="http://www.tbm.tudelft.nl/mzhang">Mingxin Zhang </a>
 * @author <a href="https://www.tudelft.nl/averbraeck">Alexander Verbraeck </a>
 * @param <A> the absolute storage type for the simulation time, e.g. Calendar, UnitTimeDouble, or Double.
 * @param <R> the relative type for time storage, e.g. Long for the Calendar. For most non-calendar types, the absolute and
 *            relative types are the same.
 * @param <T> the extended type itself to be able to implement a comparator on the simulation time.
 */
public class DSOLPanel<A extends Comparable<A>, R extends Number & Comparable<R>, T extends SimTime<A, R, T>> extends JPanel
{
    /** */
    private static final long serialVersionUID = 1L;

    /** the simulator. */
    protected final SimulatorInterface<A, R, T> simulator;

    /** */
    protected Console console = new Console();

    /** the model. */
    private final DSOLModel<A, R, T, ? extends SimulatorInterface<A, R, T>> model;

    /** */
    protected SimulatorControlPanel simulatorControlPanel;

    /** */
    protected TabbedContentPane tabbedPane = new TabbedContentPane(SwingConstants.BOTTOM);

    /** */
    protected StatusBar statusBar;

    /**
     * @param model DSOLModel&lt;A, R, T, S&gt;; the model to run in this panel
     * @param simulator S; the simulator to use for the model
     */
    public <S extends SimulatorInterface<A, R, T>> DSOLPanel(final DSOLModel<A, R, T, S> model, final S simulator)
    {
        this.model = model;
        this.simulator = simulator;

        try
        {
            this.initialize();
        }
        catch (Exception exception)
        {
            SimLogger.always().error(exception, "DSOLPanel");
        }
    }

    /**
     * initialize the panel and the simulator.
     * @throws RemoteException when simulator cannot be found
     * @throws SimRuntimeException when model cannot be constructed
     */
    public void initialize() throws RemoteException, SimRuntimeException
    {
        this.createContentPane();
        // XXX: needed or not? this.model.constructModel(this.simulator);
    }

    /**
     * Method createContentPane.
     * @throws RemoteException on error
     */
    protected void createContentPane() throws RemoteException
    {
        this.setLayout(new BorderLayout());

        // Let's add our simulationControl
        this.simulatorControlPanel = new SimulatorControlPanel(this.simulator);
        this.add(this.simulatorControlPanel, BorderLayout.NORTH);

        // Let's add our console to our tabbed pane
        this.tabbedPane.addTab("console", new JScrollPane(this.console));

        // Let's display our tabbed contentPane
        this.add(this.tabbedPane, BorderLayout.CENTER);

        // put a status bar at the bottom
        this.statusBar = new StatusBar(this.simulator);
        this.add(this.statusBar, BorderLayout.SOUTH);
    }

    /**
     * @return tabbedPane
     */
    public TabbedContentPane getTabbedPane()
    {
        return this.tabbedPane;
    }

    /**
     * @return console
     */
    public final Console getConsole()
    {
        return this.console;
    }

    /**
     * @param console Console; set console
     */
    public final void setConsole(Console console)
    {
        this.console = console;
    }

}