| gvSIG desktop 1

/*

 * Created on 10-abr-2006

 *

 * gvSIG. Sistema de Informaci?n Geogr?fica de la Generalitat Valenciana

 *

 * Copyright (C) 2004 IVER T.I. and Generalitat Valenciana.

 *

 * 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 2

 * 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, write to the Free Software

 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307,USA.

 *

 * For more information, contact:

 *

 *  Generalitat Valenciana

 *   Conselleria d'Infraestructures i Transport

 *   Av. Blasco Ib??ez, 50

 *   46010 VALENCIA

 *   SPAIN

 *

 *      +34 963862235

 *   gvsig@gva.es

 *      www.gvsig.gva.es

 *

 *    or

 *

 *   IVER T.I. S.A

 *   Salamanca 50

 *   46005 Valencia

 *   Spain

 *

 *   +34 963163400

 *   dac@iver.es

 */

/* CVS MESSAGES:

*

* $Id: 

* $Log: 

*/

package org.gvsig.gui;

import java.awt.Component;

import java.awt.event.ActionEvent;

import java.awt.event.ActionListener;

import java.util.Vector;

import javax.swing.ComboBoxModel;

import javax.swing.JComboBox;

import javax.swing.JLabel;

import javax.swing.JList;

import javax.swing.ListCellRenderer;

import javax.swing.UIManager;

import javax.swing.border.EmptyBorder;

/**

 * Implementation of JComboBox that allows us to enable/disable

 * individual items of the JComboBox.

 * 

 * Based in the work of Nobuo Tamemasa, in 

 * http://www.codeguru.com/java/articles/165.shtml

 * 

 * 

 * @author Alvaro Zabala

 *

 */

public class JComboBoxWithDisabledItems extends JComboBox {

	private static final long serialVersionUID = -1375989245835223722L;

	public JComboBoxWithDisabledItems(){

		super();

//		initialize();

	}

	public JComboBoxWithDisabledItems(ComboBoxModel model){

		super(model);

		initialize();

	}

	public JComboBoxWithDisabledItems(Object[] items){

		super(items);

		initialize();

	}

	public JComboBoxWithDisabledItems(Vector<?> items){

		super(items);

		initialize();

	}

	public void initialize(){

		setRenderer(new ComboRenderer());

	    addActionListener(new ComboListener(this));

	}

	public void addItem(Object item){

		if(item instanceof ComboItem){

			super.addItem(item);

		}else{

			ComboItem newItem = new ComboItem(item);

			newItem.setEnabled(true);

			super.addItem(newItem);

		}

	}

	public Object getItemAt(int index){

		ComboItem item = (ComboItem) super.getItemAt(index);

		return item.obj;

	}

	public Object getSelectedItem(){

		ComboItem item = (ComboItem) super.getSelectedItem();

		return item.obj;

	}

	public void setItemEnable(int index, boolean enabled){

		ComboItem item = (ComboItem) super.getItemAt(index);

		item.isEnable = enabled;

	}

	public boolean isItemEnabled(int index){

		if(index >= 0){

			ComboItem item = (ComboItem) super.getItemAt(index);

			return item.isEnable;

		}else

			return false;

	}

	/**

	 * Combo box renderer.

	 * 

	 * @author Alvaro Zabala

	 *

	 */

	class ComboRenderer extends JLabel implements ListCellRenderer {

		private static final long serialVersionUID = 4216706963467674095L;

		public ComboRenderer() {

	      setOpaque(true);

	      setBorder(new EmptyBorder(1, 1, 1, 1));

	    }

	    public Component getListCellRendererComponent( JList list, 

	           Object value, int index, boolean isSelected, boolean cellHasFocus) {

	      if (isSelected) {

	        setBackground(list.getSelectionBackground());

	        setForeground(list.getSelectionForeground());

	      } else {

	        setBackground(list.getBackground());

	        setForeground(list.getForeground());

	      } 

//	      if (! ((ComboItem)value).isEnabled()) {

	      if(! isItemEnabled(index)){

	        setBackground(list.getBackground());

	        setForeground(UIManager.getColor("Label.disabledForeground"));

	      }else{

	    	  setBackground(list.getBackground());

		      setForeground(list.getForeground());

	      }

	      setFont(list.getFont());

	      setText((value == null) ? "" : value.toString());

	      return this;

	    }

	  }

	/**

	 * Listens for combo box selection events.

	 * 

	 * It the new selected items are not enabled, the combo box

	 * will remain unchanged.

	 * 

	 * @author Alvaro Zabala

	 *

	 */

	  class ComboListener implements ActionListener {

	    JComboBox combo;

	    Object currentItem;

	    ComboListener(JComboBox combo) {

	      this.combo  = combo;

	      combo.setSelectedIndex(0);

	      currentItem = combo.getSelectedItem();

	    }

	    public void actionPerformed(ActionEvent e) {

	      Object tempItem = combo.getSelectedItem();

	      int selectedIndex = combo.getSelectedIndex();

	      //If the selected item in the combo box is enable,

	      //the combo will change. If not, the selected item

	      //will be the previous selected item

//	      if (! ((ComboItem)tempItem).isEnabled()) {

	      if(isItemEnabled(selectedIndex)){

	        combo.setSelectedItem(currentItem);

	      } else {

	        currentItem = tempItem;

	      }

	    }

	  }//ComboListener

	  /**

	   * Combo box item that allows to enabling / disabling combo 

	   * box entries.

	   * 

	   * @author Alvaro Zabala

	   *

	   */

	  class ComboItem  {

	    Object  obj;

	    boolean isEnable;

	    ComboItem(Object obj,boolean isEnable) {

	      this.obj      = obj;

	      this.isEnable = isEnable;

	    }

	    ComboItem(Object obj) {

	      this(obj, true);

	    }

	    public boolean isEnabled() {

	      return isEnable;

	    }

	    public void setEnabled(boolean isEnable) {

	      this.isEnable = isEnable;

	    }

	    public String toString() {

	      return obj.toString();

	    }

	  }

}

/*#########################################################################

 *

 * A component of the Gatherer application, part of the Greenstone digital

 * library suite from the New Zealand Digital Library Project at the

 * University of Waikato, New Zealand.

 *

 * Author: John Thompson, Greenstone Digital Library, University of Waikato

 *

 * Copyright (C) 1999 New Zealand Digital Library Project

 *

 * 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 2 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, write to the Free Software

 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

 *########################################################################

 */

package org.gvsig.gui;

import java.awt.*;

import java.awt.event.*;

import javax.swing.*;

/** An extension of the JDialog that overrides the JVM's typical modal behaviour. This typical behaviour is that when a modal dialog is opened, all other windows cease to respond to user events until the modal dialog is disposed. However this prevents us opening the help documents property whenever a modal dialog is open. Thus we override the modal behaviour so that only the owner frame or dialog is blocked. 

 * Note that because we always call the super constructor with modal set to false, this should be made visible with setVisible(true) rather than show() which will return straight away. */

// feedback note: veronika had changed all the super constructor calls to 

// use modal instead of false - not sure if this is needed so I have not 

// put that in. --kjdon

public class ModalDialog

    extends JDialog {

    /**

	 * 

	 */

	private static final long serialVersionUID = 6966218812722673601L;

	/** The current modal dialog being shown on screen, if any. */

    static public ModalDialog current_modal = null;

    /** true if this dialog should be modal, ie block user actions to its owner window, false otherwise. */

    protected boolean modal = false;

    /** true if this dialog is currently waiting some thread. */

    protected boolean waiting = false;

    /** Constructor.

     */

    public ModalDialog() {

	super((Frame)null, "", false);

    }

    /** Constructor.

     * @param parent the Dialog which is the owener of this dialog.

    */

    public ModalDialog(Dialog parent) {

	super(parent, "", false);

    }

    /** Constructor.

     * @param parent the Dialog which is the owener of this dialog.

     * @param modal true if this dialog should be modal, ie block user actions to its owner window, false otherwise.

     */

    public ModalDialog(Dialog parent, boolean modal) {

	super(parent, "", false);

	this.modal = modal;

    }

    /** Constructor.

     * @param parent the Dialog which is the owner of this dialog.

     * @param title the String to use as the title for this dialog.

     */

    public ModalDialog(Dialog parent, String title) {

	super (parent, title, false);

	this.modal = false;

    }

    /** Constructor.

     * @param parent the Dialog which is the owener of this dialog.

     * @param title the String to use as the title for this dialog.

     * @param modal true if this dialog should be modal, ie block user actions to its owner window, false otherwise.

     */

    public ModalDialog(Dialog parent, String title, boolean modal) {

	super (parent, title, false);

	this.modal = modal;

    }

   /** Constructor.

     * @param parent the Frame which is the owener of this dialog.

     */

    public ModalDialog(Frame parent) {

	super(parent, "", false);

    }

    /** Constructor.

     * @param parent the Frame which is the owener of this dialog.

     * @param modal whether this dialog is modal or not

     */

    public ModalDialog(Frame parent, boolean modal) {

	super(parent, "", false);

	this.modal = modal;

    }

    /** Constructor.

     * @param parent the Frame which is the owner of this dialog.

     * @param title the String to use as the title for this dialog.

     */

    public ModalDialog(Frame parent, String title) {

	super (parent, title, false);

    }

    /** Constructor.

     * @param parent the Frame which is the owener of this dialog.

     * @param title the String to use as the title for this dialog.

     * @param modal true if this dialog should be modal, ie block user actions to its owner window, false otherwise.

     */

    public ModalDialog(Frame parent, String title, boolean modal) {

	super (parent, title, false);

	this.modal = modal;

    }

    public void dispose() {

	super.dispose();

    }

    /** Ensures the current dialog is visible. */

    public void makeVisible() {

	super.setVisible(true);

    }

    /** The set visible method is overriden to provide modal functionality. It essentially hijacks control of the event dispatch thread while the dialog is open, only allowing non-user events to be passed to the parent dialog. Furthermore it only has this effect within the current AWT component tree by utilitizing the TreeLock.

     * @param visible true if this dialog should be painted on-screen, false otherwise.

     */

    public void setVisible(boolean visible)

    {

	if (visible) {

	    current_modal = this;

	}

	else {

	    current_modal = null;

	}

	// If we are in the AWT Dispatch thread then it is all good.

 	if (SwingUtilities.isEventDispatchThread()) {

 	    super.setVisible(visible);

	    if (modal && visible) {

		EventQueue theQueue = getToolkit().getSystemEventQueue();

		while (isVisible()) {

		    try {

			AWTEvent event = theQueue.getNextEvent();

			Object src = event.getSource();

			// Block all keyboard and mouse events to the parent component

			if (src.equals(getParent())) {

			    if (event instanceof KeyEvent || event instanceof MouseEvent) {

				// System.err.println("Event to parent component blocked.");

				continue;

			    }

			}

			// Re-dispatch other events

			if (event instanceof ActiveEvent) {

  			    ((ActiveEvent) event).dispatch();

  			}			    

			else if (src instanceof Component) {

			    ((Component) src).dispatchEvent(event);

			}

		    }

		    catch (Exception exception) {

		    	exception.printStackTrace();

		    }

		}

	    }

 	}

 	else {

 	    try {

 		SwingUtilities.invokeAndWait(new MakeDialogVisibleTask(this, visible));

 	    }

 	    catch (Exception exception) {

 	    	exception.printStackTrace();

 	    }

 	}

    }

    private class MakeDialogVisibleTask

	implements Runnable {

	private boolean make_visible;

	private ModalDialog dialog;

	public MakeDialogVisibleTask(ModalDialog dialog, boolean make_visible) {

	    this.dialog = dialog;

	    this.make_visible = make_visible;

	}

	public void run() {

	    // Blocks until the user dismisses the dialog

	    dialog.setVisible(make_visible);

	}

    }

    /** Overridden method so we can control modality and not rely on the Dialog default.

     * @param modal true if this dialog should be modal, ie block user actions to its owner window, false otherwise.

     */

    public void setModal (boolean modal) {

	this.modal = modal;

    }

}