/*

 * CDDL HEADER START

 *

 * The contents of this file are subject to the terms of the

 * Common Development and Distribution License (the "License").

 * You may not use this file except in compliance with the License.

 *

 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE

 * or http://www.opensolaris.org/os/licensing.

 * See the License for the specific language governing permissions

 * and limitations under the License.

 *

 * When distributing Covered Code, include this CDDL HEADER in each

 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.

 * If applicable, add the following below this CDDL HEADER, with the

 * fields enclosed by brackets "[]" replaced with your own identifying

 * information: Portions Copyright [yyyy] [name of copyright owner]

 *

 * CDDL HEADER END

 */

/*

 */

package org.opensolaris.os.vp.util.swing;

import java.awt.*;

import java.awt.event.*;

import java.io.IOException;

import java.lang.reflect.InvocationTargetException;

import java.util.*;

import java.util.List;

import javax.swing.*;

import javax.swing.border.Border;

import org.opensolaris.os.vp.util.misc.*;

import org.opensolaris.os.vp.util.misc.finder.Finder;

public class GUIUtil {

    //

    // Inner classes

    //

    public static interface HasMnemonic {

	String getText();

	void setMnemonic(int i);

	void setMnemonicIndex(int i);

	void setText(String text);

    }

    public static class MnemonicAction implements HasMnemonic {

	//

	// Instance data

	//

	private Action action;

	//

	// Constructors

	//

	public MnemonicAction(Action action) {

	    this.action = action;

	}

	//

	// HasMnemonic methods

	//

	@Override

	public String getText() {

	    Object text = action.getValue(Action.NAME);

	    return text == null ? null : text.toString();

	}

	@Override

	public void setMnemonic(int i) {

	    action.putValue(Action.MNEMONIC_KEY, i);

	}

	@Override

	public void setMnemonicIndex(int i) {

	    action.putValue(Action.DISPLAYED_MNEMONIC_INDEX_KEY, i);

	}

	@Override

	public void setText(String text) {

	    action.putValue(Action.NAME, text);

	}

	//

	// MnemonicAction methods

	//

	public Action getAction() {

	    return action;

	}

    }

    public static class MnemonicButton implements HasMnemonic {

	//

	// Instance data

	//

	private AbstractButton button;

	//

	// Constructors

	//

	public MnemonicButton(AbstractButton button) {

	    this.button = button;

	}

	//

	// HasMnemonic methods

	//

	@Override

	public String getText() {

	    return button.getText();

	}

	@Override

	public void setMnemonic(int i) {

	    button.setMnemonic(i);

	}

	@Override

	public void setMnemonicIndex(int i) {

	    button.setDisplayedMnemonicIndex(i);

	}

	@Override

	public void setText(String text) {

	    button.setText(text);

	}

	//

	// MnemonicButton methods

	//

	public AbstractButton getButton() {

	    return button;

	}

    }

    public static class MnemonicLabel implements HasMnemonic {

	//

	// Instance data

	//

	private JLabel label;

	//

	// Constructors

	//

	public MnemonicLabel(JLabel label) {

	    this.label = label;

	}

	//

	// HasMnemonic methods

	//

	@Override

	public String getText() {

	    return label.getText();

	}

	@Override

	public void setMnemonic(int i) {

	    label.setDisplayedMnemonic(i);

	}

	@Override

	public void setMnemonicIndex(int i) {

	    label.setDisplayedMnemonicIndex(i);

	}

	@Override

	public void setText(String text) {

	    label.setText(text);

	}

	//

	// MnemonicLabel methods

	//

	public JLabel getLabel() {

	    return label;

	}

    }

    //

    // Static data

    //

    public static final Border BORDER_LINE =

	BorderFactory.createLineBorder(Color.GRAY, 1);

    public static final String PROPERTY_COMPONENT_SPACING =

	"toolkit.component.spacing";

    public static final String PROPERTY_BUTTON_SPACING =

	"toolkit.button.spacing";

    public static final TypedPropertiesWrapper prefs =

	new TypedPropertiesWrapper();

    static {

	try {

	    Properties defaultPrefs = new Properties();

	    defaultPrefs.load(

		Finder.getResource("runtime.properties").openStream());

	    prefs.getPropertiesList().add(defaultPrefs);

	} catch (IOException e) {

	    // Unlikely -- the resource should always exist and be accessible

	}

    }

    //

    // Static methods

    //

    /**

     * Adds the given {@code AWTKeyStroke}s to the given {@code Component}'s

     * list of focus traversal keys.

     *

     * @param	    comp

     *		    the {@code Component}

     *

     * @param	    forward

     *		    {@code true} to make {@code keyStrokes} traverse forward,

     *		    {@code false} to traverse backward

     *

     * @param	    keyStrokes

     *		    the {@code AWTKeyStroke}s

     */

    public static void addFocusTraversalKeys(Component comp, boolean forward,

	AWTKeyStroke... keyStrokes) {

	modifyFocusTraversalKeys(comp, forward, true, keyStrokes);

    }

    public static void adjustForMnemonic(HasMnemonic obj) {

	String text = obj.getText();

	String[] groups = TextUtil.match(text, "(.*?)_(([a-zA-Z0-9]).*)");

	if (groups != null) {

	    obj.setText(groups[1] + groups[2]);

	    String mnemonic = groups[3].toUpperCase();

	    KeyStroke mnemonicKey = KeyStroke.getKeyStroke(mnemonic);

	    if (mnemonicKey != null) {

		int mnemonicKeyCode = mnemonicKey.getKeyCode();

		obj.setMnemonic(mnemonicKeyCode);

		obj.setMnemonicIndex(groups[1].length());

	    }

	}

    }

    public static void adjustForMnemonic(Action action) {

	adjustForMnemonic(new MnemonicAction(action));

    }

    public static void adjustForMnemonic(AbstractButton button) {

	adjustForMnemonic(new MnemonicButton(button));

    }

    public static void adjustForMnemonic(JLabel label) {

	adjustForMnemonic(new MnemonicLabel(label));

    }

    public static Border createCompoundBorder(Border... borders) {

	Border border = null;

	for (int i = 0; i < borders.length; i++) {

	    border = i == 0 ? borders[i] :

		BorderFactory.createCompoundBorder(border, borders[i]);

	}

	return border;

    }

    /**

     * Creates and returns a JTextField of the {@link #getTextFieldWidth default

     * width}.

     */

    public static JTextField createTextField() {

	return new JTextField(getTextFieldWidth());

    }

    /**

     * Get the default spacing between buttons, as on a toolbar.

     */

    public static int getButtonGap() {

	return prefs.getInt("toolkit.button.spacing");

    }

    /**

     * Get the default height for button icons.

     */

    public static int getButtonIconHeight() {

	return prefs.getInt("toolkit.button.icon.height");

    }

    public static String getClippedString(

	String text, FontMetrics metrics, int width) {

	if (text == null) {

	    return text;

	}

	int sWidth = metrics.stringWidth(text);

	if (sWidth <= width) {

	    return text;

	}

	String ellipsis = "...";

	width -= metrics.stringWidth(ellipsis);

	char[] chars = text.toCharArray();

	int i;

	for (i = chars.length - 1; i >= 0 && sWidth > width; i--) {

	    sWidth -= metrics.charWidth(chars[i]);

	}

	return text.substring(0, i + 1) + ellipsis;

    }

    public static Border getEmptyBorder() {

	int gap = getGap();

	return BorderFactory.createEmptyBorder(gap, gap, gap, gap);

    }

    public static Border getEmptyHalfBorder() {

	int gap = getHalfGap();

	return BorderFactory.createEmptyBorder(gap, gap, gap, gap);

    }

    /**

     * Gets an icon for the given message type.  An attempt will first be made

     * to retrieve a look-and-feel-specific icon from the {@code JOptionPane}

     * class.  However, some looks and feels (like GTK) don't expose these icons

     * via the API; in this case local defaults will be returned.

     *

     * @param	    messageType

     *

     * @return	    an {@code Icon}, or {@code null} if no icon could be found

     *		    for the given message type

     */

    public static Icon getIcon(int messageType) {

	Icon icon = null;

	switch (messageType) {

	    case JOptionPane.ERROR_MESSAGE:

		icon = UIManager.getIcon("OptionPane.errorIcon");

		if (icon == null) {

		    icon = Finder.getIcon("images/dialog/dialog-error.png");

		}

		break;

	    case JOptionPane.INFORMATION_MESSAGE:

		icon = UIManager.getIcon("OptionPane.informationIcon");

		if (icon == null) {

		    icon = Finder.getIcon(

			"images/dialog/dialog-information.png");

		}

		break;

	    case JOptionPane.WARNING_MESSAGE:

		icon = UIManager.getIcon("OptionPane.warningIcon");

		if (icon == null) {

		    icon = Finder.getIcon(

			"images/dialog/dialog-warning.png");

		}

		break;

	    case JOptionPane.QUESTION_MESSAGE:

		icon = UIManager.getIcon("OptionPane.questionIcon");

		if (icon == null) {

		    icon = Finder.getIcon(

			"images/dialog/dialog-question.png");

		}

		break;

	}

	return icon;

    }

    /**

     * Get the default spacing between components.

     */

    public static int getGap() {

	return prefs.getInt("toolkit.component.spacing");

    }

    public static int getHalfGap() {

	return getGap() / 2;

    }

    /**

     * Get the default height for menu icons.

     */

    public static int getMenuIconHeight() {

	return prefs.getInt("toolkit.menu.icon.height");

    }

    /**

     * Gets the preferred size of the given {@code Window}.  If the given {@code

     * Window} is a {@code JFrame} or a {@code JDialog}, and its glass pane is

     * visible, the glass pane's preferred size will be accounted for as well

     * ({@code Window.getPreferredSize} does not take the glass pane into

     * consideration).

     */

    public static Dimension getPreferredSize(Window window) {

	Dimension pSize = window.getPreferredSize();

	Component glass = null;

	Component content = null;

	if (window instanceof JFrame) {

	    JFrame frame = (JFrame)window;

	    glass = frame.getGlassPane();

	    content = frame.getContentPane();

	} else if (window instanceof JDialog) {

	    JDialog dialog = (JDialog)window;

	    glass = dialog.getGlassPane();

	    content = dialog.getContentPane();

	}

	if (glass != null && glass.isVisible()) {

	    Dimension cpSize = content.getPreferredSize();

	    content.setPreferredSize(glass.getPreferredSize());

	    Dimension newPSize = window.getPreferredSize();

	    pSize.width = Math.max(pSize.width, newPSize.width);

	    pSize.height = Math.max(pSize.height, newPSize.height);

	    // Restore previous preferred size, if any

	    content.setPreferredSize(cpSize);

	}

	return pSize;

    }

    /**

     * Get the default scroll unit increment.

     */

    public static int getScrollableUnitIncrement() {

	return prefs.getInt("toolkit.scroll.increment.unit");

    }

    /**

     * Get the default width for a textfield.

     */

    public static int getTextFieldWidth() {

	return prefs.getInt("toolkit.textfield.width");

    }

    public static int getTextXOffset(AbstractButton c) {

	int xoffset = c.getPreferredSize().width;

	Border b = c.getBorder();

	if (b != null) {

	    xoffset -= b.getBorderInsets(c).right;

	}

//	Insets m = c.getMargin();

//	if (m != null) {

//	    xoffset -= m.right;

//	}

	String text = c.getText();

	if (text != null) {

	    xoffset -= c.getFontMetrics(c.getFont()).stringWidth(text);

	}

	return xoffset;

    }

    public static Border getTitledBorder(String title) {

	return BorderFactory.createCompoundBorder(

	    BorderFactory.createTitledBorder(

	    BorderFactory.createEtchedBorder(), title), getEmptyBorder());

    }

    /**

     * Get the default margin for toolbar buttons.

     */

    public static int getToolBarButtonMargin() {

	return prefs.getInt("toolkit.toolbar.button.margin");

    }

    public static TypedPropertiesWrapper getUIPreferences() {

	return prefs;

    }