coveragetab.java

The ElectricTM VLSI Design System is an open-source Electronic Design Automation (EDA) system that c

/* -*- tab-width: 4 -*-
 *
 * Electric(tm) VLSI Design System
 *
 * File: NewArcsTab.java
 *
 * Copyright (c) 2004 Sun Microsystems and Static Free Software
 *
 * Electric(tm) 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.
 *
 * Electric(tm) 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 Electric(tm); see the file COPYING.  If not, write to
 * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
 * Boston, Mass 02111-1307, USA.
 */
package com.sun.electric.tool.user.dialogs.options;

import com.sun.electric.database.geometry.GenMath;
import com.sun.electric.database.text.TextUtils;
import com.sun.electric.technology.Layer;
import com.sun.electric.technology.Technology;
import com.sun.electric.tool.extract.LayerCoverageTool;
import com.sun.electric.tool.user.dialogs.EDialog;
import com.sun.electric.tool.user.ui.TopLevel;

import java.awt.Frame;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.event.MouseAdapter;
import java.awt.event.MouseEvent;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;

import javax.swing.DefaultListModel;
import javax.swing.JList;
import javax.swing.JOptionPane;
import javax.swing.JPanel;
import javax.swing.JTextField;
import javax.swing.ListSelectionModel;
import javax.swing.SwingUtilities;
import javax.swing.event.DocumentEvent;
import javax.swing.event.DocumentListener;

/**
 * Class to handle the "New Arcs" tab of the Preferences dialog.
 */
public class CoverageTab extends PreferencePanel
{
	/** Creates new form CoverageTab */
	public CoverageTab(Frame parent, boolean modal)
	{
		super(parent, modal);
		initComponents();

		// make all text fields select-all when entered
	    EDialog.makeTextFieldSelectAllOnTab(layerAreaField);
	    EDialog.makeTextFieldSelectAllOnTab(widthField);
	    EDialog.makeTextFieldSelectAllOnTab(heightField);
	    EDialog.makeTextFieldSelectAllOnTab(deltaXField);
	    EDialog.makeTextFieldSelectAllOnTab(deltaYField);
	}

	/** return the panel to use for this preferences tab. */
	public JPanel getPanel() { return layerCoverage; }

	/** return the name of this preferences tab. */
	public String getName() { return "Coverage"; }

	private boolean layerDataChanging = false;
	private Map<Layer,GenMath.MutableDouble> layerAreaMap;
	private DefaultListModel layerListModel;
	private JList layerJList;

	/**
	 * Method called at the start of the dialog.
	 * Caches current values and displays them in the New Arcs tab.
	 */
	public void init()
	{
		layerAreaMap = new HashMap<Layer,GenMath.MutableDouble>();
		layerListModel = new DefaultListModel();
		layerJList = new JList(layerListModel);
		layerJList.setSelectionMode(ListSelectionModel.SINGLE_SELECTION);
		listScrollList.setViewportView(layerJList);

		for(Iterator<Technology> tIt = Technology.getTechnologies(); tIt.hasNext(); )
		{
			Technology tech = tIt.next();
			technologySelection.addItem(tech.getTechName());

			for(Iterator<Layer> it = tech.getLayers(); it.hasNext(); )
			{
				Layer layer = it.next();
				double val = layer.getAreaCoverage();
				layerAreaMap.put(layer, new GenMath.MutableDouble(val));
			}
		}
		layerDataChanging = false;
		layerAreaField.getDocument().addDocumentListener(new CoverageDocumentListener(this));
		
		technologySelection.addActionListener(new ActionListener()
		{
			public void actionPerformed(ActionEvent evt) { newTechSelected(); }
		});
		layerJList.addMouseListener(new MouseAdapter()
		{
			public void mouseClicked(MouseEvent evt) { layerValueChanged(false); }
		});
		technologySelection.setSelectedItem(Technology.getCurrent().getTechName());
	}

	private void newTechSelected()
	{
		String techName = (String)technologySelection.getSelectedItem();
		Technology tech = Technology.findTechnology(techName);
		if (tech == null) return;
		layerDataChanging = true;
		layerListModel.clear();
		for(Iterator<Layer> it = tech.getLayers(); it.hasNext(); )
		{
			Layer layer = it.next();
			GenMath.MutableDouble val = layerAreaMap.get(layer);
			if (val == null) continue;
			layerListModel.addElement(getLineString(layer, val.doubleValue()));
		}
		layerJList.setSelectedIndex(0);
		widthField.setText(Double.toString(LayerCoverageTool.getWidth(tech)));
		heightField.setText(Double.toString(LayerCoverageTool.getHeight(tech)));
		deltaXField.setText(Double.toString(LayerCoverageTool.getDeltaX(tech)));
		deltaYField.setText(Double.toString(LayerCoverageTool.getDeltaY(tech)));
		layerDataChanging = false;

		layerValueChanged(false);
	}

	private static String getLineString(Layer layer, double value)
	{
		return layer.getName() + " (" + value + ")";
	}

	/**
	 * Class to handle changes to the area.
	 */
	private static class CoverageDocumentListener implements DocumentListener
	{
		CoverageTab dialog;

		CoverageDocumentListener(CoverageTab dialog) { this.dialog = dialog; }

		public void changedUpdate(DocumentEvent e) { dialog.layerValueChanged(true); }
		public void insertUpdate(DocumentEvent e) { dialog.layerValueChanged(true);}
		public void removeUpdate(DocumentEvent e) { dialog.layerValueChanged(true); }
	}

	private static class SetOriginalValue implements Runnable
	{
		javax.swing.JTextField field;
		double origValue;

		public SetOriginalValue(JTextField field, double value)
		{
			this.field = field;
			this.origValue = value;
		}
		public void run()
		{
			field.setText(TextUtils.formatDouble(origValue));
		}
	}

	/**
	 * Method called when the layer popup is changed. Return false
	 * if there was an error and need to reset back to original value
	 * @param set true if the value has been changed
	 */
	private void layerValueChanged(boolean set)
	{
		if (layerDataChanging) return;
		String techName = (String)technologySelection.getSelectedItem();
		Technology tech = Technology.findTechnology(techName);
		if (tech == null) return;
		
		String primName = (String)layerJList.getSelectedValue();
		int spacePos = primName.indexOf(' ');
		if (spacePos >= 0) primName = primName.substring(0, spacePos);
		Layer layer = tech.findLayer(primName);
		Object obj = layerAreaMap.get(layer);
		if (obj == null) return;  // it should not happen though
		GenMath.MutableDouble value = (GenMath.MutableDouble)obj;
		double origValue = value.doubleValue();
		if (set)
		{
			double val = 0;
			boolean foundError = false;
			String text = layerAreaField.getText();

			try
			{
				if (text.equals("")) return;  // ignore this case
				val = Double.parseDouble(text);
				foundError = (val < 0 || val > 100);
			}
			catch (NumberFormatException e)
			{
				foundError = true;
			}
			if (foundError)
			{
				// set back to original value
				JOptionPane.showMessageDialog(TopLevel.getCurrentJFrame(),
					text + " is out of range area value xfor layer '" + layer.getName() + "' (valid range 0 -> 100).");
				SwingUtilities.invokeLater(new SetOriginalValue(layerAreaField, origValue));
				return;
			}
			value.setValue(val);
			int lineNo = layerJList.getSelectedIndex();
			layerListModel.setElementAt(getLineString(layer, val), lineNo);
		}
		else
			layerAreaField.setText(TextUtils.formatDouble(value.doubleValue()));
	}

	/**
	 * Method called when the "OK" panel is hit.
	 * Updates any changed fields in the New Arcs tab.
	 */
	public void term()
	{
		// Default values are 50mm x 50 mm
		String techName = (String)technologySelection.getSelectedItem();
		Technology tech = Technology.findTechnology(techName);
		if (tech != null)
		{
			double val = TextUtils.atof(widthField.getText());
			if (val != LayerCoverageTool.getWidth(tech)) LayerCoverageTool.setWidth(val, tech);
			val = TextUtils.atof(heightField.getText());
			if (val != LayerCoverageTool.getHeight(tech)) LayerCoverageTool.setHeight(val, tech);
			val = TextUtils.atof(deltaXField.getText());
			if (val != LayerCoverageTool.getDeltaX(tech)) LayerCoverageTool.setDeltaX(val, tech);
			val = TextUtils.atof(deltaYField.getText());
			if (val != LayerCoverageTool.getDeltaY(tech)) LayerCoverageTool.setDeltaY(val, tech);
		}

		for(Iterator<Technology> tIt = Technology.getTechnologies(); tIt.hasNext(); )
		{
			tech = tIt.next();