edialog.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: EDialog.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;

import com.sun.electric.tool.Job;
import com.sun.electric.tool.user.User;
import com.sun.electric.tool.user.ui.TopLevel;

import java.awt.Component;
import java.awt.Container;
import java.awt.Dimension;
import java.awt.Frame;
import java.awt.Point;
import java.awt.Rectangle;
import java.awt.event.ActionEvent;
import java.awt.event.ComponentEvent;
import java.awt.event.ComponentListener;
import java.awt.event.FocusEvent;
import java.awt.event.FocusListener;
import java.awt.event.KeyEvent;
import java.awt.event.MouseEvent;
import java.awt.event.MouseListener;
import java.util.HashMap;
import java.util.Map;

import javax.swing.AbstractAction;
import javax.swing.JComboBox;
import javax.swing.JComponent;
import javax.swing.JDialog;
import javax.swing.JList;
import javax.swing.JTextField;
import javax.swing.JTree;
import javax.swing.KeyStroke;
import javax.swing.text.JTextComponent;
import javax.swing.tree.DefaultMutableTreeNode;
import javax.swing.tree.TreePath;

/**
 * Superclass for all dialogs that handles remembering the last location.
 */
public class EDialog extends JDialog
{
	private static Map<Class,Point> locations = new HashMap<Class,Point>();
	private static Map<Class,Dimension> sizes = new HashMap<Class,Dimension>();
	private static TextBoxFocusListener textBoxFocusListener = new TextBoxFocusListener();
	private static TextBoxMouseListener textBoxMouseListener = new TextBoxMouseListener();
	private static JTextField justMoused = null;

	/** Creates new form */
	protected EDialog(Frame parent, boolean modal)
	{
		// in multi-headed displays, display dialog on head with windowframe
		super(parent, "", modal, (parent == null) ?
			(TopLevel.getCurrentJFrame() == null ? null : TopLevel.getCurrentJFrame().getGraphicsConfiguration()) :
				parent.getGraphicsConfiguration());

		assert !Job.BATCHMODE;

		Point pt = getDialogLocation(getClass());
		setLocation(pt.x, pt.y);

		addComponentListener(new MoveComponentListener());

		final String CANCEL_DIALOG = "cancel-dialog";
		KeyStroke accel = KeyStroke.getKeyStroke(KeyEvent.VK_ESCAPE, 0);
		getRootPane().getInputMap(JComponent.WHEN_IN_FOCUSED_WINDOW).put(accel, CANCEL_DIALOG);
		getRootPane().getActionMap().put(CANCEL_DIALOG, new AbstractAction()
		{
			public void actionPerformed(ActionEvent event) { escapePressed(); }
		});

//		// add a focus listener for SDI mode so dialogs are always on top
//		if (parent == null && !TopLevel.isMDIMode())
//		{
//			dialogFocusHandler.addEDialog(this);
//		}
	}

	public static Point getDialogLocation(Class clz)
	{
		Point pt = locations.get(clz);
		if (pt == null)
		{
			pt = User.getDefaultWindowPos();
			pt.x += 100;
			pt.y += 50;
		}
		return pt;
	}

	public static Dimension getDialogSize(Class clz)
	{
		Dimension sz = sizes.get(clz);
		return sz;
	}

	/**
	 * Method to complete initialization of a dialog.
	 * Restores the size from last time.
	 */
	protected void finishInitialization()
	{
		Dimension sz = getDialogSize(getClass());
		if (sz != null)
			setSize(sz);
	}

	/**
	 * Method to ensure that the dialog is at least as large as the user-specified size.
	 */
	protected void ensureMinimumSize()
	{
		Dimension sz = getDialogSize(getClass());
		if (sz == null) return;
		Dimension curSz = getSize();
		if (curSz.width < sz.width || curSz.height < sz.height)
			setSize(sz);
	}

	/**
	 * Method called when the ESCAPE key is pressed.
	 * Override it to cancel the dialog.
	 */
	protected void escapePressed() {}

	protected void closeDialog()
	{
		setVisible(false);
	}

	/**
	 * Method to ensure that a JComboBox of font names contains a given name.
	 * @param fontBox the JComboBox with font names.
	 * @param font the name of the font.
	 * If the name is not in the JComboBox, it is added.
	 */
	public static void ensureComboBoxFont(JComboBox fontBox, String font)
	{
		int totFonts = fontBox.getItemCount();
		boolean found = false;
		for(int i=0; i<totFonts; i++)
		{
			if (font.equals(fontBox.getItemAt(i))) { found = true;   break; }
		}
		if (!found)
			fontBox.addItem(font);
	}

	/**
	 * Method to highlight a node in a tree.
	 * @param tree the tree to highlight.
	 * @param curNode the current node of the tree.
	 * @param objWanted the node that is to be highlighted.
	 * @param topPath current path in the tree.
	 * @return true if highlighted, false if not.
	 */
	public static boolean recursivelyHighlight(JTree tree, DefaultMutableTreeNode curNode,
		DefaultMutableTreeNode objWanted, TreePath topPath)
	{
		for(int i=0; i<curNode.getChildCount(); i++)
		{
			DefaultMutableTreeNode node = (DefaultMutableTreeNode)curNode.getChildAt(i);
			if (node == objWanted)
			{
				TreePath lowerPath = topPath.pathByAddingChild(node);
				tree.setSelectionPath(lowerPath);
				tree.scrollPathToVisible(lowerPath);
				return true;
			}
			TreePath lowerPath = topPath.pathByAddingChild(node);
			if (recursivelyHighlight(tree, node, objWanted, lowerPath)) return true;
		}
		return false;
	}

	/**
	 * Sets the cursor to have focus in the specified textComponent, and
	 * highlights any text in that text field.
	 * @param textComponent the text field
	 */
	public static void focusOnTextField(JTextComponent textComponent)
	{
		textComponent.selectAll();
	}

	/**
	 * Unselect the text in the specified textComponebnt.
	 * @param textComponent
	 */
	public static void focusClearOnTextField(JTextComponent textComponent)
	{
		textComponent.select(0, 0);
	}

	/**
	 * Method to make text fields select all when tabbed into.
	 * @param textField the text field to alter.
	 */
	public static void makeTextFieldSelectAllOnTab(JTextField textField)
	{
		textField.addFocusListener(textBoxFocusListener);
		textField.addMouseListener(textBoxMouseListener);
	}

	/**
	 * Class for detecting mouse motion in text fields to implement full-selection when tabbing.
	 */
	private static class TextBoxMouseListener implements MouseListener
	{
		public void mousePressed(MouseEvent evt)
		{
			Component source = evt.getComponent();
			if (source instanceof JTextField)
			{
				JTextField textField = (JTextField)source;
				if (textField.isEnabled() && textField.isEditable())
					justMoused = textField;
			}
		}
		public void mouseReleased(MouseEvent evt) {}
		public void mouseClicked(MouseEvent evt) {}
		public void mouseEntered(MouseEvent evt) {}
		public void mouseExited(MouseEvent evt) {}
	}

	/**
	 * Class for detecting focus switching into text fields to implement full-selection when tabbing.
	 */
	private static class TextBoxFocusListener implements FocusListener
	{
		public void focusGained(FocusEvent evt)
		{
			Component source = evt.getComponent();
			if (source instanceof JTextField)
			{
				JTextField textField = (JTextField)source;
				if (textField.isEnabled() && textField.isEditable())
				{
					if (textField != justMoused) textField.selectAll();
				}
			}
		}
		public void focusLost(FocusEvent e) {}
	}

	/**
	 * Method to ensure that the selected item in a list is
	 * shown in the center of the list.
	 * The Java method "ensureIndexIsVisible" only makes sure it is visible,
	 * but it may be at the bottom of the list.
	 * This method centers the selected item nicely.
	 * @param list the JList with a selected item to center.
	 */
	public static void centerSelection(JList list)
	{
		int curIndex = list.getSelectedIndex();
		int listSize = list.getLastVisibleIndex() - list.getFirstVisibleIndex();

		int lowIndexToEnsure = curIndex - listSize/2 + 1;
		if (lowIndexToEnsure < 0) lowIndexToEnsure = 0;
		list.ensureIndexIsVisible(lowIndexToEnsure);

		int highIndexToEnsure = curIndex + listSize/2 - 1;
		if (highIndexToEnsure >= list.getModel().getSize())
			highIndexToEnsure = list.getModel().getSize() - 1;
		list.ensureIndexIsVisible(highIndexToEnsure);
	}

	public static class MoveComponentListener implements ComponentListener
	{
		public void componentHidden(ComponentEvent e) {}
		public void componentShown(ComponentEvent e) {}

		public void componentResized(ComponentEvent e)
		{
			Class cls = e.getSource().getClass();
			Rectangle bound = ((Container)e.getSource()).getBounds();
			sizes.put(cls, new Dimension(bound.width, bound.height));
		}

		public void componentMoved(ComponentEvent e)
		{
			Class cls = e.getSource().getClass();
			Rectangle bound = ((Container)e.getSource()).getBounds();
			int x = (int)bound.getMinX();
			int y = (int)bound.getMinY();
			locations.put(cls, new Point(x, y));
		}
	}

	// this seems to be causing problems on windows platforms
//	private static DialogFocusHandler dialogFocusHandler = new DialogFocusHandler();
//
//	private static class DialogFocusHandler implements WindowFocusListener {
//
//		private List<EDialog> dialogs;
//
//		private DialogFocusHandler() { dialogs = new ArrayList<EDialog>(); }
//
//		public synchronized void addEDialog(EDialog dialog) { dialogs.add(dialog); }
//
//		public synchronized void windowGainedFocus(WindowEvent e)
//		{
//			for (int i=0; i<dialogs.size(); i++)
//				dialogs.get(i).toFront();
//		}
//
//		public void windowLostFocus(WindowEvent e) {}
//	}
}