es.ree.eemws.kit.gui.applications.browser.Browser Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of eemws-kit Show documentation
Client implementation of IEC 62325-504 technical specification. eemws-kit includes command line utilities to invoke the eem web services, as well as several GUI applications (browser, editor, ...)
The newest version!
/*
 * Copyright 2024 Redeia.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 *  by the Free Software Foundation, version 3 of the license.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTIBIILTY or FITNESS FOR A PARTICULAR PURPOSE. See GNU Lesser General
 * Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this program. If not, see
 * http://www.gnu.org/licenses/.
 *
 * Any redistribution and/or modification of this program has to make
 * reference to Redeia as the copyright owner of the program.
 */

package es.ree.eemws.kit.gui.applications.browser;

import java.awt.BorderLayout;
import java.awt.Cursor;
import java.awt.GraphicsEnvironment;
import java.awt.Toolkit;
import java.awt.event.ComponentAdapter;
import java.awt.event.ComponentEvent;
import java.awt.event.WindowEvent;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.prefs.Preferences;

import javax.swing.JFrame;
import javax.swing.JLabel;
import javax.swing.JMenu;
import javax.swing.JMenuBar;
import javax.swing.JOptionPane;
import javax.swing.JPanel;
import javax.swing.UIManager;
import javax.swing.UnsupportedLookAndFeelException;
import javax.swing.WindowConstants;

import es.ree.eemws.core.utils.config.ConfigException;
import es.ree.eemws.kit.config.Configuration;
import es.ree.eemws.kit.gui.common.Constants;
import es.ree.eemws.kit.gui.common.LogHandle;
import es.ree.eemws.kit.gui.common.Logger;
import es.ree.eemws.kit.gui.common.ServiceMenuListener;

/**
 * Implements graphic interface for list and get.
 *
 * @author Redeia.
 * @version 2.1 01/01/2024
 *
 */
public final class Browser extends JFrame implements ServiceMenuListener {

	/** Class ID. */
	private static final long serialVersionUID = 519657632922916947L;

	/** Default window width. */
	private static final int DEFAULT_WINDOW_WIDTH = 520;

	/** Default window height. */
	private static final int DEFAULT_WINDOW_HEIGHT = 500;

	/** Key to store window height as preference. */
	private static final String WINDOW_HEIGHT_KEY = "WINDOW_HEIGHT_KEY"; //$NON-NLS-1$

	/** Key to store window width as preference. */
	private static final String WINDOW_WIDTH_KEY = "WINDOW_WIDTH_KEY"; //$NON-NLS-1$

	/** Key to store horizontal position of window preference. */
	private static final String WINDOW_LEFT_KEY = "WINDOW_LEFT_KEY"; //$NON-NLS-1$

	/** Key to store vertical position of window preference. */
	private static final String WINDOW_TOP_KEY = "WINDOW_TOP_KEY"; //$NON-NLS-1$

	/** Log window. */
	private Logger log;

	/** Log window manager. */
	private LogHandle logHandle = new LogHandle();

	/** File options manager. */
	private FileHandle fileHandle = null;

	/** Status bar. */
	private StatusBar status = new StatusBar();

	/** Filter area. */
	private Filter filter = null;

	/** Main menu. */
	private JMenuBar jmenuBar = new JMenuBar();

	/** Service end point. */
	private String endPoint;

	/** Listing class. */
	private ListMessageSender listSend = null;

	/** Request class. */
	private GetMessageSender requestSend = null;

	/** Data table. */
	private DataTable dataTable;

	/** Settings for this class. */
	private transient Preferences preferences;

	/**
	 * Main program, initializes application and display on screen.
	 *
	 * @param args Arguments -ignored-
	 */
	public static void main(final String[] args) {

		try {
			UIManager.setLookAndFeel(UIManager.getSystemLookAndFeelClassName());
			var b = new Browser();
			b.setVisible(true);
		} catch (ClassNotFoundException | InstantiationException | IllegalAccessException
		        | UnsupportedLookAndFeelException ex) {
			JOptionPane.showMessageDialog(null,
			        es.ree.eemws.kit.gui.applications.configuration.MessageCatalog.SETTINGS_NO_GUI.getMessage(),
			        es.ree.eemws.kit.gui.applications.configuration.MessageCatalog.SETTINGS_NO_GUI.getMessage(),
			        JOptionPane.ERROR_MESSAGE);
		}

	}

	/**
	 * Constructor. Reads settings and invoke the method which arranges graphic
	 * elements. Important: If object cannot be created application will
	 * exit.
	 */
	public Browser() {
		super(MessageCatalog.BROWSER_MAIN_WINDOW_TITLE.getMessage());

		try {
			preferences = Preferences.userNodeForPackage(getClass());
			var cf = new Configuration();
			cf.readConfiguration();
			if (!cf.hasMinimumConfiguration()) {
				throw new ConfigException(
				        es.ree.eemws.kit.gui.applications.configuration.MessageCatalog.SETTINGS_NO_CONFIGURATION
				                .getMessage());
			}
			endPoint = cf.getUrlEndPoint().toString();
			requestSend = new GetMessageSender(cf.getUrlEndPoint(), this);
			listSend = new ListMessageSender(cf.getUrlEndPoint(), this);
			jbInit();

		} catch (ConfigException ex) {
			JOptionPane.showMessageDialog(null, ex.getMessage(),
			        es.ree.eemws.kit.gui.applications.configuration.MessageCatalog.SETTINGS_NO_CONFIGURATION
			                .getMessage(),
			        JOptionPane.ERROR_MESSAGE);
			System.exit(1); // NOSONAR We want to force application to exit.
		}
	}

	/**
	 * Configures and creates application graphic elements.
	 */
	private void jbInit() {

		fileHandle = new FileHandle(this);
		dataTable = new DataTable(this);
		var columnVisibilityHandler = new ColumnVisibilityHandle(dataTable.getModel());
		filter = new Filter(this);

		log = logHandle.getLog();

		setIconImage(Toolkit.getDefaultToolkit().getImage(getClass().getResource(Constants.ICON_PATH)));

		var mnView = new JMenu(MessageCatalog.BROWSER_VIEW_MENU_ITEM.getMessage());
		mnView.setMnemonic(MessageCatalog.BROWSER_VIEW_MENU_ITEM_HK.getChar());
		columnVisibilityHandler.getMenu(mnView);
		filter.getMenu(mnView);

		jmenuBar.add(fileHandle.getMenu());
		jmenuBar.add(mnView);
		jmenuBar.add(dataTable.getSelectionMenu());
		jmenuBar.add(logHandle.getMenu());

		var lblLeftMargin = new JLabel("  "); //$NON-NLS-1$
		var lblRightMargin = new JLabel("  "); //$NON-NLS-1$

		var pnlCenterPanel = new JPanel();
		pnlCenterPanel.setLayout(null);
		pnlCenterPanel.add(filter.getFilterCanvas());
		pnlCenterPanel.add(dataTable.getPanelScroll());

		getContentPane().setLayout(new BorderLayout());
		getContentPane().add(jmenuBar, BorderLayout.NORTH);
		getContentPane().add(lblRightMargin, BorderLayout.EAST);
		getContentPane().add(lblLeftMargin, BorderLayout.WEST);
		getContentPane().add(status.getPanel(), BorderLayout.SOUTH);
		getContentPane().add(pnlCenterPanel, BorderLayout.CENTER);

		setDefaultCloseOperation(WindowConstants.DO_NOTHING_ON_CLOSE);
		setResizable(true);

		addWindowListener(new java.awt.event.WindowAdapter() {
			@Override
			public void windowClosing(final WindowEvent e) { // NOSONAR event is not used.
				fileHandle.exitApplication();
			}
		});

		addComponentListener(new ComponentAdapter() {
			@Override
			public void componentResized(final ComponentEvent e) { // NOSONAR event is not used.
				modifySize();
			}
		});

		var ge = GraphicsEnvironment.getLocalGraphicsEnvironment();
		var maxSize = ge.getMaximumWindowBounds();
		setMaximizedBounds(maxSize);

		var width = preferences.getInt(WINDOW_WIDTH_KEY, DEFAULT_WINDOW_WIDTH);
		var height = preferences.getInt(WINDOW_HEIGHT_KEY, DEFAULT_WINDOW_HEIGHT);
		setSize(width, height);

		var top = preferences.getInt(WINDOW_TOP_KEY, (maxSize.width - width) / 2);
		var left = preferences.getInt(WINDOW_LEFT_KEY, (maxSize.width - width) / 2);
		setLocation(top, left);
	}

	/**
	 * Modifies size of filter panel and table to fit in the main window when it is
	 * resized. This method is also invoked in case of modifying visibility status
	 * of panel to rearrange the size of the data grid.
	 */
	public void modifySize() {
		var width = getWidth();
		var height = getHeight();

		filter.setSize(width);
		dataTable.adjustTableSize(width, height, filter.isVisible());

		preferences.putInt(WINDOW_WIDTH_KEY, width);
		preferences.putInt(WINDOW_HEIGHT_KEY, height);

		var p = getLocation();
		preferences.putInt(WINDOW_TOP_KEY, p.x);
		preferences.putInt(WINDOW_LEFT_KEY, p.y);
	}

	/**
	 * Sets the application end point.
	 *
	 * @param endp point to which messages are sent (environment + service).
	 */
	@Override
	public void setEndPoint(final String endp) {

		try {
			listSend.setEndPoint(new URL(endp));
			requestSend.setEndPoint(new URL(endp));
			endPoint = endp;
			log.logMessage("Target service set to: " + endPoint); //$NON-NLS-1$

		} catch (MalformedURLException mue) {
			JOptionPane.showMessageDialog(null, es.ree.eemws.kit.cmd.MessageCatalog.INVALID_URL.getMessage(endp),
			        es.ree.eemws.kit.gui.common.MessageCatalog.MSG_ERROR_TITLE.getMessage(), JOptionPane.ERROR_MESSAGE);
		}
	}

	/**
	 * Enables / disables elements on screen.
	 *
	 * @param enableValue true enable, false disable.
	 */
	public void enableScreen(final boolean enableValue) {
		filter.enable(enableValue);
		enableMenu(enableValue);
		dataTable.setEnabled(enableValue);
		if (enableValue) {
			setCursor(Cursor.getPredefinedCursor(Cursor.DEFAULT_CURSOR));
		} else {
			setCursor(Cursor.getPredefinedCursor(Cursor.WAIT_CURSOR));
		}
		update(getGraphics());
	}

	/**
	 * Enables / Disables main menu elements.
	 *
	 * @param enableValue true enable, false disable.
	 */
	private void enableMenu(final boolean enableValue) {
		var me = jmenuBar.getSubElements();
		var len = me.length;

		for (var cont = 0; cont < len; cont++) {
			me[cont].getComponent().setEnabled(enableValue);
		}
	}

	/**
	 * Gets data table.
	 *
	 * @return Data table.
	 */
	public DataTable getDataTable() {
		return dataTable;
	}

	/**
	 * Gets File handler.
	 *
	 * @return File handler.
	 */
	public FileHandle getFileHandle() {
		return fileHandle;
	}

	/**
	 * Gets Filter elements.
	 *
	 * @return Filter elements.
	 */
	public Filter getFilter() {
		return filter;
	}

	/**
	 * Gets status bar.
	 *
	 * @return Status bar.
	 */
	public StatusBar getStatusBar() {
		return status;
	}

	/**
	 * Gets Log window.
	 *
	 * @return Log window.
	 */
	public LogHandle getLogHandle() {
		return logHandle;
	}

	/**
	 * Gets message request object.
	 *
	 * @return Message request object.
	 */
	public GetMessageSender getRequestSend() {
		return requestSend;
	}

	/**
	 * Returns List message sender object.
	 *
	 * @return list List message sender object.
	 */
	public ListMessageSender getListSend() {
		return listSend;
	}
}