/*
 * This file is a part of EpnTAPClient.
 * This program aims to provide EPN-TAP support for software clients, like CASSIS spectrum analyzer.
 * See draft specifications: https://voparis-confluence.obspm.fr/pages/viewpage.action?pageId=559861
 * Copyright (C) 2016 Institut de Recherche en Astrophysique et Planétologie.
 * 
 * This program is free software: you can
 * redistribute it and/or modify it under the terms of the GNU General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or (at your option) any later
 * version. This program is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
 * PURPOSE. See the GNU General Public License for more details. You should have received a copy of
 * the GNU General Public License along with this program. If not, see
 * <http://www.gnu.org/licenses/>.
 */

package eu.omp.irap.vespa.epntapclient.view;

import java.awt.BorderLayout;
import java.util.logging.Logger;

import javax.swing.JOptionPane;
import javax.swing.JPanel;
import javax.swing.JSplitPane;

import eu.omp.irap.vespa.epntapclient.view.panels.BottomBarPanel;
import eu.omp.irap.vespa.epntapclient.view.panels.RequestPanel;
import eu.omp.irap.vespa.epntapclient.view.panels.ResultsPanel;
import eu.omp.irap.vespa.epntapclient.view.panels.ServicesPanel;
import eu.omp.irap.vespa.epntapclient.votable.view.VOTableView;

/**
 * The main view of the application, which manage all the other views.
 * 
 * @author N. Jourdane
 */
public class EpnTapMainView extends JPanel {
	/** The logger for the class EpnTapMainView. */
	@SuppressWarnings("unused")
	private static final Logger logger = Logger.getLogger(EpnTapMainView.class.getName());

	/** The serial version UID (affected with a random number). */
	private static final long serialVersionUID = -1233290271099283814L;

	/** The JPanel where the VOTable results is displayed. */
	private ResultsPanel resultsPanel;

	/** The JPanel where the list of services is displayed. */
	private ServicesPanel servicesPanel;

	/** The JPanel where the user build the query. */
	private RequestPanel requestPanel;

	/** The status bar. */
	private BottomBarPanel bottomBarPanel;

	/** The listener of the EpnTapMainView (usually the main controller) */
	private MainViewListener mainViewListener;

	/**
	 * The interface for the main view listener, which listen for events.
	 * 
	 * @author N. Jourdane
	 */
	public interface MainViewListener {

		/**
		 * When an event is detected on the main view.
		 * 
		 * @param event The event type. @see Event
		 * @param args The possible arguments which comes with the event (ie. a row number).
		 */
		void event(Event event, Object... args);
	}

	/**
	 * The main view constructor, which create all the panels.
	 * 
	 * @param voTableServicesView The view to put in the services panel, built by ServicesController
	 * @param voTableResultsView The view to put in the results panel, built by ResultsController.
	 */

	public EpnTapMainView(VOTableView voTableServicesView, VOTableView voTableResultsView) {
		this.servicesPanel = new ServicesPanel(this, voTableServicesView);
		this.resultsPanel = new ResultsPanel(this, voTableResultsView);
		this.requestPanel = new RequestPanel(this);
		this.bottomBarPanel = new BottomBarPanel(this);
		buildWindow();
	}

	/**
	 * Add a listener for the main view.
	 * 
	 * @param listener A MainViewListener.
	 */
	public void addMainViewListener(MainViewListener listener) {
		mainViewListener = listener;
	}

	/**
	 * @return The JPanel where the VOTable result is displayed.
	 */
	public ResultsPanel getResultsPanel() {
		return resultsPanel;
	}

	/**
	 * @return The JPanel containing the GUI elements to build the query.
	 */
	public RequestPanel getRequestPanel() {
		return requestPanel;
	}

	/**
	 * @return The JPanel where the list of services is displayed.
	 */
	public ServicesPanel getServicesPanel() {
		return servicesPanel;
	}

	/**
	 * @return The status bar.
	 */
	public BottomBarPanel getBottomBarPanel() {
		return bottomBarPanel;
	}

	/**
	 * Build and fill the GUI.
	 */
	public void buildWindow() {
		setLayout(new BorderLayout());

		JSplitPane northPanel = new JSplitPane(JSplitPane.HORIZONTAL_SPLIT, servicesPanel,
				requestPanel);

		JSplitPane mainPanel = new JSplitPane(JSplitPane.VERTICAL_SPLIT, northPanel, resultsPanel);
		add(mainPanel, BorderLayout.CENTER);
		add(bottomBarPanel, BorderLayout.SOUTH);
	}

	/**
	 * Display an error message. Usually used each time an error happens.
	 *
	 * @param title The title of the error.
	 * @param message The message of the error.
	 */
	public void displayError(String title, String message) {
		JOptionPane.showMessageDialog(this, message, title,
				JOptionPane.ERROR_MESSAGE);
	}

	/**
	 * Get an event and send it to the listener of the main view.
	 * 
	 * @param event The event type. @see Event
	 * @param args The possible arguments which comes with the event (ie. a row number).
	 */
	public void event(Event event, Object... args) {
		mainViewListener.event(event, args);
	}

}