PluginPanel.java

/*******************************************************************************
 * gMix open source project - https://svs.informatik.uni-hamburg.de/gmix/
 * Copyright (C) 2014  SVS
 *
 * 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 staticContent.evaluation.simulator.gui.customElements;

import java.awt.Component;
import java.awt.GridBagConstraints;
import java.awt.GridBagLayout;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;
import java.util.TreeMap;

import javax.swing.JComboBox;
import javax.swing.JPanel;
import javax.swing.JScrollPane;
import javax.swing.SwingUtilities;
import javax.swing.border.TitledBorder;

import org.apache.log4j.Level;
import org.apache.log4j.Logger;

import staticContent.evaluation.simulator.gui.customElements.accordion.AccordionEntry;
import staticContent.evaluation.simulator.gui.helper.ValueComparator;
import staticContent.evaluation.simulator.gui.pluginRegistry.SimPropRegistry;

/**
 * {@link JPanel} containing the whole plugin configuration and property
 * configuration. Has the ability to seperate from main window.
 * 
 * @author nachkonvention
 * 
 */
public class PluginPanel extends JScrollPane {

	private static final long serialVersionUID = -4731643475635433884L;

	private static Logger logger = Logger.getLogger(PluginPanel.class);

	private JPanel panel;
	private JPanel pluginSelectionPanel;
	private JPanel propertiesToVaryPanel;
	private JPanel generalPreferencesPanel;
	HashMap<String, JComboBox<String>> pluginListsMap = new HashMap<String, JComboBox<String>>();

	SimPropRegistry simPropRegistry;

	/**
	 * Constructor
	 */
	public PluginPanel() {
		this.initPanel();
	}

	private void initPanel() {
		// Start Layout

		this.setAutoscrolls(false);
		this.setHorizontalScrollBarPolicy(JScrollPane.HORIZONTAL_SCROLLBAR_AS_NEEDED);
		this.setVerticalScrollBarPolicy(JScrollPane.VERTICAL_SCROLLBAR_ALWAYS);
		this.getVerticalScrollBar().setUnitIncrement(16);

		this.pluginSelectionPanel = new JPanel();
		this.pluginSelectionPanel.setBorder(new TitledBorder(null, "Plugin Configuration", TitledBorder.LEADING,
				TitledBorder.TOP, null, null));

		this.propertiesToVaryPanel = new JPanel();
		this.propertiesToVaryPanel.setBorder(new TitledBorder(null, "Properties To Vary", TitledBorder.LEADING,
				TitledBorder.TOP, null, null));

		this.generalPreferencesPanel = new JPanel();
		this.generalPreferencesPanel.setBorder(new TitledBorder(null, "General Configuration", TitledBorder.LEADING,
				TitledBorder.TOP, null, null));

		this.panel = new JPanel();

		// GridBagLayout for plugin configuration
		GridBagLayout gridBagLayoutPlugins = new GridBagLayout();
		GridBagConstraints gridBagConstraintsPlugins = new GridBagConstraints();
		gridBagConstraintsPlugins.fill = GridBagConstraints.HORIZONTAL;
		gridBagConstraintsPlugins.anchor = GridBagConstraints.NORTH;
		gridBagConstraintsPlugins.weightx = 1;
		gridBagConstraintsPlugins.weighty = 1;
		gridBagConstraintsPlugins.gridx = GridBagConstraints.RELATIVE;
		gridBagConstraintsPlugins.gridwidth = GridBagConstraints.REMAINDER;
		gridBagLayoutPlugins.setConstraints(this.pluginSelectionPanel, gridBagConstraintsPlugins);
		this.pluginSelectionPanel.setLayout(gridBagLayoutPlugins);

		// GridBagLayout for properties to vary configuration
		GridBagLayout gridBagLayoutPropertiesToVary = new GridBagLayout();
		GridBagConstraints gridBagContraintsPropertiesToVary = new GridBagConstraints();
		gridBagContraintsPropertiesToVary.fill = GridBagConstraints.HORIZONTAL;
		gridBagContraintsPropertiesToVary.anchor = GridBagConstraints.NORTH;
		gridBagContraintsPropertiesToVary.weightx = 1;
		gridBagContraintsPropertiesToVary.weighty = 1;
		gridBagContraintsPropertiesToVary.gridx = gridBagConstraintsPlugins.gridx;
		gridBagContraintsPropertiesToVary.gridwidth = GridBagConstraints.REMAINDER;
		gridBagLayoutPropertiesToVary.setConstraints(this.propertiesToVaryPanel, gridBagConstraintsPlugins);
		this.propertiesToVaryPanel.setLayout(gridBagLayoutPropertiesToVary);

		// GridBagLayout for general configuration
		GridBagLayout gridBagLayoutGeneral = new GridBagLayout();
		GridBagConstraints gridBagConstraintsGeneral = new GridBagConstraints();
		gridBagConstraintsGeneral.fill = GridBagConstraints.HORIZONTAL;
		gridBagConstraintsGeneral.anchor = GridBagConstraints.CENTER;
		gridBagConstraintsGeneral.weightx = 1;
		gridBagConstraintsGeneral.weighty = 1;
		gridBagConstraintsGeneral.gridx = gridBagConstraintsPlugins.gridx;
		gridBagConstraintsGeneral.gridwidth = GridBagConstraints.REMAINDER;
		gridBagLayoutGeneral.setConstraints(this.generalPreferencesPanel, gridBagConstraintsGeneral);
		this.generalPreferencesPanel.setLayout(gridBagLayoutGeneral);

		// GridBagLayout for overall configuration-panel
		GridBagLayout gridBagLayout = new GridBagLayout();
		GridBagConstraints gridBagConstraints = new GridBagConstraints();
		gridBagConstraints.fill = GridBagConstraints.HORIZONTAL;
		gridBagConstraints.anchor = GridBagConstraints.CENTER;
		gridBagConstraints.weightx = 1;
		gridBagConstraints.weighty = 0;
		gridBagConstraints.gridwidth = GridBagConstraints.REMAINDER;
		gridBagLayout.setConstraints(this.panel, gridBagConstraints);
		this.panel.setLayout(gridBagLayout);

		this.setViewportView(this.panel);

		// End Layout

		this.simPropRegistry = SimPropRegistry.getInstance();

		Map<String, Integer> layerMap = this.simPropRegistry.getLayerMapDisplayNameToOrder();
		// Sort the map by value (first) and key (second)
		ValueComparator comperatorLayer = new ValueComparator(layerMap);
		TreeMap<String, Integer> sortedLayerMap = new TreeMap<String, Integer>(comperatorLayer);
		sortedLayerMap.putAll(layerMap);

		// Sort the static configurations by value
		Map<String, Integer> staticMap = this.simPropRegistry.getStaticConfigurationDisplay();
		ValueComparator comperatorStatic = new ValueComparator(staticMap);
		TreeMap<String, Integer> sortedStaticMap = new TreeMap<String, Integer>(comperatorStatic);
		Map<String, Boolean> isStaticLayerMap = SimPropRegistry.getInstance().getIsStaticLayerMap();
		sortedStaticMap.putAll(staticMap);

		String[] levelStrings[] = new String[sortedLayerMap.size()][];
		AccordionEntry accordionElement;

		int i = 0;
		for (String layer : sortedLayerMap.keySet()) {
			if ((isStaticLayerMap.get(layer) == null) || !isStaticLayerMap.get(layer)) {
				levelStrings[i] = SimPropRegistry.getInstance().getPluginsInLayer(layer).keySet()
						.toArray(new String[0]);
				
				String key = layer;
				
				String[] tmp = levelStrings[i];
				Arrays.sort(tmp);
				
				this.pluginListsMap.put(key, new JComboBox<String>(tmp));
				this.pluginListsMap.get(key).insertItemAt("Choose your " + key + " plugin", 0);
				this.pluginListsMap.get(key).setSelectedIndex(0);
				logger.log(Level.DEBUG, "New Accordion Entry for " + key);
				accordionElement = new AccordionEntry(key, this.pluginListsMap.get(key), SimPropRegistry.getInstance()
						.getPluginsInLayer(layer));
				this.pluginSelectionPanel.add(accordionElement, gridBagConstraintsPlugins);

				i++;
			} else {
				levelStrings[i] = SimPropRegistry.getInstance().getPluginsInLayer(layer).keySet()
						.toArray(new String[0]);
				String key = layer;
				
				String[] tmp = levelStrings[i];
				Arrays.sort(tmp);
				
				this.pluginListsMap.put(key, new JComboBox<String>(tmp));
				this.pluginListsMap.get(key).insertItemAt("Choose your " + key + " plugin", 0);
				this.pluginListsMap.get(key).setSelectedIndex(0);
				logger.log(Level.DEBUG, "New Accordion Entry for " + key);
				accordionElement = new AccordionEntry(key, this.pluginListsMap.get(key), SimPropRegistry.getInstance()
						.getPluginsInLayer(layer));
				this.generalPreferencesPanel.add(accordionElement, gridBagConstraintsPlugins);

				i++;
			}
		}

		this.propertiesToVaryPanel.add(new PropVaryElement(), gridBagContraintsPropertiesToVary);

		gridBagConstraints.gridx = 0;
		gridBagConstraints.gridy = 0;
		this.panel.add(this.pluginSelectionPanel, gridBagConstraints);
		gridBagConstraints.gridx = 0;
		gridBagConstraints.gridy = 1;
		this.panel.add(this.propertiesToVaryPanel, gridBagConstraints);
		gridBagConstraints.gridx = 0;
		gridBagConstraints.gridy = 2;
		this.panel.add(this.generalPreferencesPanel, gridBagConstraints);
		gridBagConstraints.gridx = 0;
		gridBagConstraints.gridy = 3;
		// Spring element to push all other elements to the top
		// needed for alignment
		gridBagConstraints.weighty = 1;
		gridBagConstraints.fill = GridBagConstraints.VERTICAL;
		JPanel jp = new JPanel();
		this.panel.add(jp, gridBagConstraints);

		this.setVisible(true);
	}

	void setPlugin(String configName, String selectedPlugin) {

		String pluginLevel = SimPropRegistry.getInstance().configNameToDisplayName(configName);

		logger.log(Level.DEBUG, "Loaded pluginLevel " + pluginLevel + " to " + selectedPlugin);

		this.pluginListsMap.get(pluginLevel).setSelectedItem(selectedPlugin);
	}

	public void toggleFoldAccordions() {
		for (Component component : this.pluginSelectionPanel.getComponents()) {
			if (component.getClass().equals(AccordionEntry.class)) {
				AccordionEntry accordianEntry = (AccordionEntry) (component);
				accordianEntry.setVibility(false);
			}
		}

		for (Component component : this.generalPreferencesPanel.getComponents()) {
			if (component.getClass().equals(AccordionEntry.class)) {
				AccordionEntry accordianEntry = (AccordionEntry) (component);
				accordianEntry.setVibility(false);
			}
		}
	}

	public void toggleUnfoldAccordions() {
		for (Component component : this.pluginSelectionPanel.getComponents()) {
			if (component.getClass().equals(AccordionEntry.class)) {
				AccordionEntry accordianEntry = (AccordionEntry) (component);
				accordianEntry.setVibility(true);
			}
		}

		for (Component component : this.generalPreferencesPanel.getComponents()) {
			if (component.getClass().equals(AccordionEntry.class)) {
				AccordionEntry accordianEntry = (AccordionEntry) (component);
				accordianEntry.setVibility(true);
			}
		}
	}

	/**
	 * updates all components in the plugin selection and takes effect on the
	 * {@link AccordionEntry}
	 */
	public void update() {

		for (Component component : this.pluginSelectionPanel.getComponents()) {
			if (component.getClass().equals(AccordionEntry.class)) {
				AccordionEntry accordianEntry = (AccordionEntry) (component);
				accordianEntry.setVibility(true);
			}
		}

		for (Component component : this.propertiesToVaryPanel.getComponents()) {
			if (component.getClass().equals(PropVaryElement.class)) {
				PropVaryElement propVaryElement = (PropVaryElement) (component);
				propVaryElement.update();
				propVaryElement.repaint();
			}
		}

		for (Component component : this.generalPreferencesPanel.getComponents()) {
			if (component.getClass().equals(AccordionEntry.class)) {
				AccordionEntry accordianEntry = (AccordionEntry) (component);
				accordianEntry.setVibility(true);
			}
		}

		final Map<String, String> activePlugins = this.simPropRegistry.getActivePlugins(true);

		for (final String pluginLevel : activePlugins.keySet()) {

			SwingUtilities.invokeLater(new Runnable() {
				@Override
				public void run() {
					String pluginDisplayName = SimPropRegistry.getInstance().getPluginDisplayName(
							activePlugins.get(pluginLevel));
					PluginPanel.this.setPlugin(pluginLevel, pluginDisplayName);
				}
			});
		}
	}
}