Application: gvSIG desktop

package org.gvsig.gui.beans.swing.jComboBoxItemsSeeker.services;

import java.awt.Dimension;

import javax.swing.JFrame;

import javax.swing.JOptionPane;

import org.gvsig.gui.beans.Messages;

import org.gvsig.gui.beans.swing.jComboBoxItemsSeeker.services.JComboBoxSearchURLOfServices;

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

 */

/**

 * Tests the classes JComboBoxItemsSeekerForServers

 * 

 * Notes:

 *    - MORE TESTS COULD BE ADDED!!!

 *    - DON'T REMOVE TEST COMMENTED!!!

 *

 * @author Pablo Piqueras Bartolom? (p_queras@hotmail.com)

 */

public class TestJComboBoxSearchURLOfServices {

	/**

	 * Test method for the TestJComboBoxSearchURLOfServices

	 * 

	 * @param args

	 */

	public static void main(String[] args) {

		int width = 300;

		int height = 60;

		try

		{

			// Objects creation

			JFrame jF = new JFrame();

			// Create a JComboBoxSearcheable, set behavior configuration and add Items

			// --- TESTS FOR THE JCOMBOBOXITEMSSEEKERFORURLOFSERVICES ---

			// Test the default behavior

			JComboBoxSearchURLOfServices jCBISFN = new JComboBoxSearchURLOfServices();

			// --- ADD ITEMS TO THE COMPONENT AND OTHER TESTS ---

			// Add some items to test if has too much delay with an average number of items

			jCBISFN.addItem("_fwAndami");

			jCBISFN.addItem("extAddEventTheme");

			jCBISFN.addItem("extJDBC");

			jCBISFN.addItem("extCAD");

			jCBISFN.addItem("libuiDownCase");

			jCBISFN.addItem("appgvSig");

			jCBISFN.addItem("extNomenclatorIGN");

			jCBISFN.addItem("extWMS");

			jCBISFN.addItem("LIBUI");

			jF.setSize(new Dimension(width, height));	    

		    jF.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);

		    jF.getContentPane().add(jCBISFN);

			// --- END ADD ITEMS TO THE COMPONENT AND OTHER TESTS ---

			// Test of no item default selection 

			// jCBISFN.setSelectedIndex(-1);

		    // Test the number of actions that can hold the UndoManager of the JComponent

			// jCBISFN.setUndoRedoLimitActions(5);

			// Configure the JFrame

			jF.setTitle("Test JComboBoxSearchURLOfServices");

			jF.setSize(new Dimension(width, height));	    

		    jF.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);

		    jF.getContentPane().add(jCBISFN);

		    jF.setVisible(true);	

		}

		catch(Exception e)

		{

			e.printStackTrace();

			JOptionPane.showMessageDialog(null, e.getMessage(), Messages.getText("error"), JOptionPane.ERROR_MESSAGE);

		}

	}

}

package org.gvsig.gui.beans.swing.jComboBoxItemsSeeker.services;

import java.awt.event.FocusAdapter;

import java.awt.event.FocusEvent;

import java.awt.event.FocusListener;

import java.awt.event.KeyAdapter;

import java.awt.event.KeyEvent;

import java.awt.event.KeyListener;

import java.awt.event.MouseAdapter;

import java.awt.event.MouseEvent;

import java.util.Vector;

import javax.accessibility.Accessible;

import javax.swing.ComboBoxEditor;

import javax.swing.ComboBoxModel;

import javax.swing.JComboBox;

import javax.swing.JList;

import javax.swing.event.PopupMenuListener;

import javax.swing.plaf.basic.BasicComboBoxUI;

import javax.swing.plaf.basic.ComboPopup;

import javax.swing.text.AttributeSet;

import javax.swing.text.BadLocationException;

import javax.swing.text.JTextComponent;

import javax.swing.text.PlainDocument;

import org.gvsig.gui.beans.swing.jComboBoxItemsSeeker.models.DefaultComboBoxModelOrderedSearch;

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

 */

/**

 * This class will have the necessary behavior for the combo box with URL of services:<br>

 * 

 * <ul>

 * <li>All items will be sorted</li>

 * <li>Allows repeated items</li>

 * <li>Finds all items that their first characters are the written by the user</li>

 * <li>If no item has its first characters as the written by the user -> don't show the popup</li>

 * <li>Similar behaviour as the Mozilla Firefox URL combo box</li>

 * </ul>

 * 

 * @author Pablo Piqueras Bartolom? (p_queras@hotmail.com)

 */

public class JComboBoxSearchURLOfServices extends JComboBox implements java.io.Serializable {

	private static final long serialVersionUID = -6928118339485676552L;

	// EDITOR DOCUMENT REFERENCE

	/**

	 * A reference to the document of this component 

	 */

	private PlainDocumentTextFormatter document;

	// END EDITOR DOCUMENT REFERENCE

	// NEW ATTRIBUTES 

	/**

	 * A reference to the model of this component (according to the MVC <i>(Model-View-Controller)</i> pattern)

	 */

	private DefaultComboBoxModelOrderedSearch model;

	/**

	 * Has or not to hide the popup on focus loss

	 */

	private boolean hidePopupOnFocusLoss;

	/**

	 * Has an item of the popup been selected or not by the user

	 */

	private boolean popupItemSelected;

	// END NEW ATTRIBUTES

	// LISTENERS

	/**

	 * Listener for the editor key 

	 */

	private KeyListener editorKeyListener;

	/**

	 * Listener for the editor focus 

	 */

	private FocusListener editorFocusListener;

	/**

	 * Listener for the popup menu 

	 */

	private PopupMenuListener popupMenuListener;

	// END LISTENERS

	/**

	 * Default constructor without parameters

	 */

	public JComboBoxSearchURLOfServices() {

		super();

		initialize();

	}

	/**

	 * Default constructor with a {@link ComboBoxModel} as parameter

	 * 

	 * @param aModel javax.swing.ComboBoxModel

	 */

	public JComboBoxSearchURLOfServices(ComboBoxModel aModel) {

		super(aModel);

		initialize();

	}	

	/**

	 * Default constructor with an array of objects as parameter

	 * 

	 * @param items An array of objects. All them must implement a <i>'String toStrin()'</i> method

	 */

	public JComboBoxSearchURLOfServices(Object[] items) {

		super(items);

		initialize();

	}

	/**

	 * Default constructor with a Vector of objects as parameter

	 * 

	 * @param items A {@link Vector} of objects. All them must implement a <i>'String toStrin()'</i> method

	 */

	public JComboBoxSearchURLOfServices(Vector items) {

		super(items);

		initialize();

	}

	/**

	 * This method sets the start values of inner attributes and creates the necessary inner objects

	 */

	private void initialize() {

		// By default user hasn't selected an item of the popup

		popupItemSelected = false;

		// Creates the model for this component and gets it reference

		model = new DefaultComboBoxModelOrderedSearch();

		super.setModel(model);

        // Allows user to edit on the combobox

		super.setEditable(true);

		// Other configuration tasks

		this.configure();

		// If there are items -> select the first

		if (model.getSize() > 0)

			model.setSelectedItem(model.getElementAt(0));

	}

	/**

	 * Configures the component and some of its elements

	 */

	private void configure() {

        // Defines a key listener for the editor of this component

        this.defineEditorKeyListener(this);

        // Defines a focus listener for the editor of this component

        this.defineEditorFocusListener(this);

		// Configures the document of the editor of this component

		this.configureDocument();

		// Configures the editor (ComboBoxEditor) of this component

		this.configureEditor(this.getEditor());

		// Configures the popup of this component

		this.configurePopUp(this);

	}

	/**

	 * Configures the editor ( {@link ComboBoxEditor} ) of this component

	 * 

	 * @param newEditor The new editor to configure

	 */

	private void configureEditor(ComboBoxEditor newEditor) {

        if (newEditor != null) {

           	JTextComponent jTextComponentOfEditor = (JTextComponent) newEditor.getEditorComponent();

        	// Adds the new document (tries to remove it if it existed before)

        	jTextComponentOfEditor.setDocument(this.document);

        	// Adds the new Key Listener (tries to remove it if it existed before)

           	jTextComponentOfEditor.removeKeyListener(this.editorKeyListener);

        	jTextComponentOfEditor.addKeyListener(this.editorKeyListener);

        	// Adds the new Focus Listener (tries to remove it if it existed before)

        	jTextComponentOfEditor.removeFocusListener(this.editorFocusListener);

        	jTextComponentOfEditor.addFocusListener(this.editorFocusListener);

        }

	}

	/**

	 * Configures the document of the editor of this component

	 */

	private void configureDocument() {

		// Creates the document of the editor of this component

        document = new PlainDocumentTextFormatter();

        // Set reference to the container component

        document.setJComboBoxReference(this);

	}

	/**

	 * Configures the popup of this component

	 *

	 * @param combo_Box A reference of this component

	 */

	private void configurePopUp(JComboBoxSearchURLOfServices combo_Box) {

		final JComboBoxSearchURLOfServices comboBoxReference = combo_Box;

		this.addPopupMenuListener(this.popupMenuListener);

        BasicComboBoxUI comboBoxUi = (BasicComboBoxUI)comboBoxReference.getUI();

        Accessible a = comboBoxUi.getAccessibleChild(comboBoxReference, 0);

        if (a instanceof ComboPopup) {

            JList jlist = ((ComboPopup)a).getList();

            jlist.addMouseListener(new MouseAdapter() {

				/*

				 *  (non-Javadoc)

				 * @see java.awt.event.MouseListener#mousePressed(java.awt.event.MouseEvent)

				 */

				public void mousePressed(MouseEvent e) {

					// User selects an item of the popup using the mouse

					popupItemSelected = true;

				}

            });

        }

	}

	/**

	 * Defines a key listener for the editor of this component

	 * This method is another important difference from the JComboBox; and could work badly with some keymaps

	 * 

	 * @param combo_Box A reference of this component

	 */

	private void defineEditorKeyListener(JComboBoxSearchURLOfServices combo_Box) {

		final JComboBoxSearchURLOfServices comboBoxReference = combo_Box;

		editorKeyListener = new KeyAdapter() {

			/*

			 * (non-Javadoc)

			 * @see java.awt.event.KeyAdapter#keyPressed(java.awt.event.KeyEvent)

			 */

			public void keyPressed(KeyEvent ke)  // Executed on the Start view state or Search view state

			{

				// According the key pressed, do some actions or others

				switch (ke.getKeyCode())

				{

					case KeyEvent.VK_ENTER :

						// Don't allow execute the default instructions because they have a bug (first time we remove some characteres, no item will be displayed in the popup)

						ke.consume();

						// Hide the popup

						hidePopup();

						// Sets the caret position of the text in the document to the end:

						((JTextComponent) comboBoxReference.getEditor().getEditorComponent()).setCaretPosition(document.getLength());

						break;

					case KeyEvent.VK_UP: case KeyEvent.VK_DOWN:

						// User selects an item of the popup using the mouse

						popupItemSelected = true;

						break;

				}

			}

		};

	}

	/**

	 * Defines a focus listener for the editor of this component

	 * 

	 * @param combo_Box A reference of this component

	 */

	private void defineEditorFocusListener(JComboBoxSearchURLOfServices combo_Box) {

		final JComboBoxSearchURLOfServices comboBoxReference = combo_Box;

		// Bug 5100422 on Java 1.5: Editable JComboBox won't hide popup when tabbing out		

		hidePopupOnFocusLoss=System.getProperty("java.version").startsWith("1.5");

		// Highlight whole text when gaining focus

		editorFocusListener = new FocusAdapter() {

			/*

			 *  (non-Javadoc)

			 * @see java.awt.event.FocusListener#focusLost(java.awt.event.FocusEvent)

			 */

			public void focusLost(FocusEvent e) {

				// Workaround for Bug 5100422 - Hide Popup on focus loss

				if (hidePopupOnFocusLoss)

					comboBoxReference.setPopupVisible(false);

			}			

		};

	}

	/**

	 * Inner class that inherits of the class PlainDocument, and is used for manipulate the textWritten that has the document of the editor of this component

	 * This class is also optimized for items seek

	 * 

	 * @author Pablo Piqueras Bartolom? (p_queras@hotmail.com)

	 */

	private class PlainDocumentTextFormatter extends PlainDocument {

		private static final long serialVersionUID = 4158213349939840209L;

		private JComboBoxSearchURLOfServices comboBoxReference;

		private String textWritten;

		private boolean updatedModel;

		private String textOfReplacement;

		private int old_caretPosition;

		/**

		 * Default Constructor

		 */

		public PlainDocumentTextFormatter() {

			super();

			this.initialize();

		}

		/**

		 * This method makes some initialize operations 

		 */

		private void initialize() {

			textWritten = "";

			textOfReplacement = "";

		}

		/**

		 * Sets a reference of this component

		 * 

		 * @param combo_Box A reference to the class that contains this.

		 */

		private void setJComboBoxReference(JComboBoxSearchURLOfServices combo_Box) {

			comboBoxReference = combo_Box;

		}

		/*

		 *  (non-Javadoc)

		 * @see javax.swing.text.Document#insertString(int, java.lang.String, javax.swing.text.AttributeSet)

		 */

	    public void insertString(int offs, String str, AttributeSet a) throws BadLocationException {

	    	if (updatedModel) {

	    		model.setTextWritten(textWritten);

		    	super.insertString(offs, textWritten, a);

		    	return;

	    	}

	    	hidePopup();

	    	if (textWritten.length() > 0) {

	    		if (offs < textWritten.length()) {

	    			String old_textWritten = textWritten;

	    			// End of the text

	    			textWritten = textWritten.substring(offs, textWritten.length());

	    			// Beginning of the text

	    			if (offs > 0) {

	    		    	// Reset (without text written)

	    				textWritten = old_textWritten.substring(0, offs) + str + textWritten;

	    			}

	    			else {

	    				textWritten = str + textWritten;

	    			}

	    		}

	    		else {

	    			textWritten = textWritten.substring(0, offs) + str;

	    		}

	    	}

	    	else {

	    		textWritten =  str;

	    	}

	    	model.setTextWritten(textWritten);

	    	super.insertString(offs, str, a);

	    	// Only show the popup if there are items to show

	    	if (model.getSize() > 0) {

	    		showPopup();

	    	}

	    	// Update the caret position -> at the same place it was or at the end

	    	updateCaretPosition(textWritten.length());	    	

	    }

	    /*

	     *  (non-Javadoc)

	     * @see javax.swing.text.AbstractDocument#replace(int, int, java.lang.String, javax.swing.text.AttributeSet)

	     */

	    public void replace(int offset, int length, String text, AttributeSet attrs) throws BadLocationException {

	    	// Avoid two replaces for the same operation

	    	if ((text.compareTo("") == 0) && (length == textWritten.length()))

	    		return;

	    	// Only remove if there is text to be replaced (text selected)

	    	if (length > 0) {

	    		textOfReplacement = text;

	    		remove(offset, length);

	    	}

	    	else {

	    		if ((offset > 0) && (offset != textWritten.length())) {

	    			// Must replace the model for update the data in the popup correctly

	    			String old_textWritten;

	    	    	// There is a bug that when text has been removed, the elements in the popup aren seen.

	    	    	// The solution to this bug is add them as a new model

	    	    	hidePopup();

	    	    	updatedModel = true;

	    	    	old_textWritten = textWritten;

	    	    	old_caretPosition = ((JTextComponent) comboBoxReference.getEditor().getEditorComponent()).getCaretPosition() + text.length();

	    	    	textWritten = "";

	    	    	model.setTextWritten(textWritten);

	    	    	super.remove(0, old_textWritten.length());

	    	    	// Must replace the model for update the data in the popup correctly

	    	    	model = new DefaultComboBoxModelOrderedSearch(model.getData());

	    	    	comboBoxReference.setModel(model);

	    	    	// Reset (without text written)

	    	    	insertString(0, textWritten, null);

	    	    	// Insert the new text

	    	    	textWritten = old_textWritten.substring(0, offset) + text + old_textWritten.substring(offset, old_textWritten.length());

	    	    	insertString(0, textWritten, null);

	    	    	updatedModel = false;

	    	    	// Update the caret position -> at the same place it was or at the end

	    	    	updateCaretPosition(old_caretPosition);

	    	    	// Only show the popup if there are items to show

	    	    	if (model.getSize() > 0) {

	    	    		showPopup();

	    	    	}

	    		}

	    		else {

		    		// Default replacement

		    		super.replace(offset, length, text, attrs);

	    		}

	    	}

	    }

		/*

		 *  (non-Javadoc)

		 * @see javax.swing.text.Document#remove(int, int)

		 */

		public void remove(int offs, int len) throws BadLocationException {

			String old_textWritten;

	    	// There is a bug that when text has been removed, the elements in the popup aren seen.

	    	// The solution to this bug is add them as a new model

	    	hidePopup();

	    	updatedModel = true;

	    	old_textWritten = textWritten;

	    	old_caretPosition = Math.min(((JTextComponent) comboBoxReference.getEditor().getEditorComponent()).getCaretPosition(), offs);

	    	textWritten = "";

	    	model.setTextWritten(textWritten);

	    	super.remove(0, old_textWritten.length());

	    	// Must replace the model for update the data in the popup correctly

	    	model = new DefaultComboBoxModelOrderedSearch(model.getData());

	    	comboBoxReference.setModel(model);

	    	// Reset (without text written)

	    	insertString(0, textWritten, null);

	    	// Insert the new text

	    	textWritten = old_textWritten.substring(0, offs) + textOfReplacement + old_textWritten.substring(offs + len, old_textWritten.length());

	    	textOfReplacement = "";

	    	insertString(0, textWritten, null);

	    	updatedModel = false;

	    	// Only show the popup if there are items to show

	    	if (model.getSize() > 0) {

	    		showPopup();

	    	}

	    	// Update the caret position -> at the same place it was or at the end

	    	updateCaretPosition(old_caretPosition);

		}

		/**

		 * Updates the position of the caret in the {@link ComboBoxEditor} of this component.

		 * 

		 * @param position The new position of the caret.

		 */

		private void updateCaretPosition(int position) {

			// If user has selected an item of the popup (using the mouse) -> set the caret position to the end of the text

			if (popupItemSelected) {

				((JTextComponent) comboBoxReference.getEditor().getEditorComponent()).setCaretPosition(textWritten.length());

				popupItemSelected = false;

				return;

			}

			if (position > textWritten.length())

				((JTextComponent) comboBoxReference.getEditor().getEditorComponent()).setCaretPosition(textWritten.length());

			else

				((JTextComponent) comboBoxReference.getEditor().getEditorComponent()).setCaretPosition(position);

		}

	}

}