| gvSIG desktop 1

package org.gvsig.gui.beans.comboBoxItemsSeeker;

import java.awt.Color;

import java.awt.PopupMenu;

import java.awt.event.ActionEvent;

import java.awt.event.ActionListener;

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.awt.event.MouseListener;

import java.beans.PropertyChangeEvent;

import java.beans.PropertyChangeListener;

import java.lang.reflect.Field;

import java.util.Iterator;

import javax.swing.ComboBoxEditor;

import javax.swing.ComboBoxModel;

import javax.swing.JButton;

import javax.swing.JComboBox;

import javax.swing.JOptionPane;

import javax.swing.ListCellRenderer;

import javax.swing.event.DocumentEvent;

import javax.swing.event.DocumentListener;

import javax.swing.event.ListDataEvent;

import javax.swing.event.ListDataListener;

import javax.swing.plaf.basic.BasicComboBoxRenderer;

import javax.swing.plaf.basic.BasicComboBoxUI;

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.comboBoxItemsSeeker.JComboBoxItemsSeekerDynamic;

import org.gvsig.gui.beans.comboBoxItemsSeeker.ComboBoxItemsSeekerDynamicModel;

import com.iver.andami.PluginServices;

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

 */

/**  VERSI?N EN DESARROLLO

 *  REVISAR COMENTARIOS Y C?DIGO QUE PUEDA SOBRAR

* This class allows users to insert a chain of characters and show all the sentences of the JComboBox that match its first ones characters with it.

* This class is also a Java Bean, and is made according the MVC (Model - View - Controller) pattern.

* This class has the View, the Control and can access to the Model.

* The behavior of this componet can be configurated by 7 flags: (Esto lo cambio!!!!!)

*  + The appearence of the items showed at the beginning and when the user presses the ESCAPE key: (This is configured with 2 flags -> 3 different states are possible) 

*             -> maintainPositionItems -> When we see the list of all items, this are showed in the ordenation as they have been introduced (if true); (if false) each new item 

*           when we write on the TextField of this Component will be showed at the end (esto ?ltimo creo q. no -> revisarlo)

*      -> all_Alphanumeric_Sorted -> All items we can see in this Component will be showed in alphanumeric ordenation (if true)

*  + The list of the items showed when the user makes a search writting or pressing the BACK-SPACE key (This is configured with 1 flag -> 2 different states are possible)

*      -> alphanumericSortedSearches -> When we write on the TextField of this Component all results (items) are showed in alphanumeric ordenation (if true)

*  + Key Sensitive or not when the user writes 

*      -> key_Sensitive -> When we write on the TextField it can discriminate upper cases from down cases (if true) or not (if false) (This is configured with 1 flag -> 2 different states are possible)

*  + Show all items always

*      -> showAllItems -> If true -> this component shows all items always; if false -> this component only shows items that their first characters match with the string written by the user

*  + Use one color (black) or 2 colors (black by default and red if the string written doesn't match with the beginning of all items)

*      -> only_One_Color -> The text on the textField only will be showed on black color (if true); false -> if the text on the textField doesn't match with any current item of this component -> the text

*            will be showed on red color

*  +            * @param boolean (completeMatchedItem (explicar))

*  + @param boolean (useBeep (explicar))

* 

* Default Values of the Flags:

*  -> maintainPositionItems -> true

*  -> all_Alphanumeric_Sorted -> true

*  -> alphanumericSortedSearches -> false 

*  -> key_Sensitive -> false

*  -> showAllItems -> false

*  -> only_One_Color -> false

*  

*  The flags are distributed in two classes:

*  -> ComboBoxSearcheableDynamicModel -> maintainPositionItems, all_Alphanumeric_Sorted, alphanumericSortedSearches, key_Sensitive, showAllItems 

*  -> JComboBoxSearcheableDynamic -> only_One_Color

* 

* Combinations of flags not allowed:

*         ->        maintainPositionItems == allAlphanumericSorted == true

*        ->        ((maintain_Position_Items == false) && (all_Alphanumeric_Sorted == true) && (alphanumeric_Sorted_Searches == false))

*   ->  showAllItems == true && maintainPositionItems == false (Creo que esta mal)

* 

* Limitations:

* -> When we add more than one item with the same name (string value) -> the behavior of this component only considers one item in most of the cases when it does a search

* -> If this component has Hundreds,Thousands or even Million/s of items is probably that had quite delay to respond the evens of the user; this also depends of the machine where it's executed and other factors

* 

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

*/

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

        //private static final long serialVersionUID = -1853812970336818959L;

        // eSTAS HAY QUE BORRARLAS!

/*        private Vector defaultItems;

        private Set notRemovedItems;

        private Set removedItems;*/

        // CONFIGURATION FLAGS

        private boolean onlyOneColor;

        private boolean completeMatchedItem;

        private boolean useBeep;

        // END FLAGS

        // PUEDE QUE TB. sOBren

//        private boolean allItemsAreSorted;

        // Index in the showed list of the last selected item

        private int lastSelectedIndex;

        // pueDE QUE TB. SOBRE

//        private int num = 0;

//        private JTextField txtField;

        // Reference to the ui

        //private MetalComboBoxItemsSeekerUI ui;

        // Reference to the model

        private ComboBoxItemsSeekerDynamicModel model;

        // Some listeners for the Control between the View and de Model

        private KeyListener editorKeyListener;

        private FocusListener editorFocusListener;

        private DocumentListener documentListener;

        private ListDataListener modelListDataListener;        

        // Reference to the document of the Editor of this component for optimize the seeks

        private PlainDocumentSeeker document;

        private String writtenString;

        private boolean upOrDownKeyPressed;

        // OTRAS FLAGS que puede que sobren alguNAS

        private boolean selecting=false;

        private boolean hidePopupOnFocusLoss;

        private boolean hitBackspace=false;

        private boolean hitBackspaceOnSelection;        

        /**

         * Default Constructor

         */

        public JComboBoxItemsSeekerDynamic() {

                // Invokes to the parent class constructor                

                super();

                // Create attributes and set initial values

                this.initialize();

                // Set the default values of the flags

                this.onlyOneColor = false;

                this.completeMatchedItem = false; //true;

                this.useBeep = false; //true;

                // Other configuration tasks

                this.createDefaultListeners();

                this.configure();

                //this.configure();

        }

        /**

         * Default Constructor with four parameters: configure the 4 flags

         * 

         * @param boolean (true -> maintains the position of the items; false -> don't maintains the position of the items)

         * @param boolean (true -> all items showed when we write on the textfield will be showed in alphanumeric ordenation; false -> they don't have to be in alphanumeric ordenation)

         * @param boolean (true -> all items showed will be in alphanumeric ordenation; false -> they don't have to be in alphanumeric ordenation)

         * @param boolean (true -> discriminates capital letters from small letters; false -> don't discriminates capital letters from small letters)

         */

        public JComboBoxItemsSeekerDynamic(boolean maintain_Position_Items, boolean alphanumeric_Sorted_Searches, boolean all_Alphanumeric_Sorted, boolean key_Sensitive)        {

                // Invokes to the parent class constructor                

                super();        

                // Create attributes and set initial values

                this.initialize();

                // Sets the options selected by the user

                this.model.setMaintainPositionItems(maintain_Position_Items);

                this.model.setAllAlphanumericSorted(all_Alphanumeric_Sorted);

                this.model.setAlphanumericSortedSearches(alphanumeric_Sorted_Searches);

                this.model.setKeySensitive(key_Sensitive);

                this.model.setShowAllItems(false);

                this.onlyOneColor = false;

                this.completeMatchedItem = true;

                this.useBeep = false; //true;

                if (!testFlagsConfigurationOK())

                        JOptionPane.showMessageDialog(this, PluginServices.getText(this, "error_message_JComboBoxSearcheableDynamic"), PluginServices.getText(this, "exportJOP2Title"), JOptionPane.ERROR_MESSAGE);

                else

                        this.configure();

        }

        /**

         * Default Constructor with six parameters: configure the 6 flags

         * 

         * @param boolean (true -> maintains the position of the items; false -> don't maintains the position of the items)

         * @param boolean (true -> all items showed when we write on the textfield will be showed in alphanumeric ordenation; false -> they don't have to be in alphanumeric ordenation)

         * @param boolean (true -> all items showed will be in alphanumeric ordenation; false -> they don't have to be in alphanumeric ordenation)

         * @param boolean (true -> discriminates capital letters from small letters; false -> don't discriminates capital letters from small letters)

         * @param boolean (true -> the text on the textField only will be showed on black color (if true); false -> if the text on the textField doesn't match with any current item of this component -> the text

         *                           will be showed on red color)

           * @param boolean (true -> this component shows all items always; false -> this component only shows items that their first characters match with the string written by the user)

           * @param boolean (completeMatchedItem (explicar))

           * @param boolean (useBeep (explicar))

         */

        public JComboBoxItemsSeekerDynamic(boolean maintain_Position_Items, boolean alphanumeric_Sorted_Searches, boolean all_Alphanumeric_Sorted, boolean key_Sensitive, boolean only_One_Color, boolean show_All_Items, boolean complete_Matched_Item, boolean use_Beep) {

                // Invokes to the parent class constructor                

                super();        

                // Create attributes and set initial values

                this.initialize();

                // Sets the options selected by the user

                this.model.setMaintainPositionItems(maintain_Position_Items);

                this.model.setAllAlphanumericSorted(all_Alphanumeric_Sorted);

                this.model.setAlphanumericSortedSearches(alphanumeric_Sorted_Searches);

                this.model.setKeySensitive(key_Sensitive);

                this.model.setShowAllItems(show_All_Items);

                this.onlyOneColor = only_One_Color;

                this.completeMatchedItem = complete_Matched_Item;

                this.useBeep = use_Beep;

                if (!testFlagsConfigurationOK())

                        JOptionPane.showMessageDialog(this, PluginServices.getText(this, "error_message_JComboBoxSearcheableDynamic"), PluginServices.getText(this, "exportJOP2Title"), JOptionPane.ERROR_MESSAGE);

                else

                        this.configure();

        }

        /**

         * 

         */

        private void initialize() {

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

//                super.setUI(new MetalComboBoxItemsSeekerUI());

//                this.ui = (MetalComboBoxItemsSeekerUI) super.getUI();

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

                super.setModel(new ComboBoxItemsSeekerDynamicModel());

                this.model = (ComboBoxItemsSeekerDynamicModel) super.getModel();

        // Allows user to edit on the combobox

                super.setEditable(true);

                // Set the last selected item -> if there isn't any item -> -1; else -> this will be 0

                this.lastSelectedIndex = -1;

                super.setSelectedIndex(lastSelectedIndex);

//                System.out.println("lastselecteditem: " + this.getSelectedIndex());

                // By default the keys Up and Down aren't pressed

                this.upOrDownKeyPressed = false;

        }

        /**

         * 

         */

        private void createDefaultListeners() {

                // TODO Auto-generated method stub

        // Define the key listener for the editor of this component

        this.defineEditorKeyListener(this);

        // Define the focus listener for the editor of this component

        this.defineEditorFocusListener(this);

        // Define a document listener for changes of text

        this.defineDocumentListener();

                // Define the list data listener for the model of this component

        this.defineModelListDataListener();

        }

        /**

         *  Define a document listener for changes of text

         */

        private void defineDocumentListener() {

                // TODO Auto-generated method stub

               documentListener = new DocumentListener() {

                        public void changedUpdate(DocumentEvent arg0) {

                                // TODO Auto-generated method stub

//                                System.out.println("NUM: " + num + " DocumentListener->changedUpdate");

//                                num++;

                        }

                        public void insertUpdate(DocumentEvent arg0) {

                                // TODO Auto-generated method stub

//                                System.out.println("NUM: " + num + " DocumentListener->insertUpdate");

//                                num++;

                                // This flag indicates to the 'insertString' and 'remove' method of the PlainDocumentSeeker that the text of the item selected or written by the user

                                //  has been written on the TextEditor of ths component

                                selecting = true;

                                // Indicate to the model than there has been a change of item selected

                                if (!upOrDownKeyPressed)  // If items have to be showed disordered, if we have pushed the UP or DOWN key -> we don't disorder the items this time

                                        model.setWrittenString("AAA");

                                else

                                        upOrDownKeyPressed = false;

                                //model.setWrittenString(writtenString);

                        }

                        public void removeUpdate(DocumentEvent arg0) {

                                // TODO Auto-generated method stub

//                                System.out.println("NUM: " + num + " DocumentListener->removeUpdate");

//                                num++;

                        }                        

                };

        }

        /**

         * 

         */

        private void configure() {

                // TODO Auto-generated method stub

                // Configure the document of the editor of this component

                this.configureDocument();

                // Configure the editor (ComboBoxEditor) of this component

                this.configureEditor(this.getEditor());        

                // Configure the model of this component

                this.configureModel();

        }

//        /**

//         * 

//         */

//        private void uninstallDefaultListeners() {

//        

//

//        }

        /**

         * 

         */

        private void configureModel() {

                // TODO Auto-generated method stub

                this.model.addListDataListener(this.modelListDataListener);

        }        

        /**

         * 

         */

        private void configureDocument() {

                // TODO Auto-generated method stub

                // Creates the document of the editor of this component

        document = new PlainDocumentSeeker();

        document.setJComboBoxItemsSeekerDynamicReference(this);

                // Set the written String

                writtenString = "";

                // Remove all Previous document Listeners

//                DocumentListener documentListener[] = document.getDocumentListeners();

//                for (int i=0; i < documentListener.length; i++)

//                        document.removeDocumentListener(documentListener[i]);

                // Defines and add a Document listener for changes on the document of the editor of this component

                document.addDocumentListener(this.documentListener);

        }

        /**

         * Define the list data listener for the model of this component

         */

    public void defineModelListDataListener() {

                this.modelListDataListener = new ListDataListener()        {

                        public void contentsChanged(ListDataEvent e) {

                                // TODO Auto-generated method stub

//                                System.out.println("ContentsChanged");

                                // This flag indicates to the 'insertString' and 'remove' methods of the PlainDocumentSeeker that the text of the item selected or written by the user

                                //  hasn't been written on the TextEditor of ths component

                                selecting = false;

                        }

                        public void intervalAdded(ListDataEvent e) {

                                // TODO Auto-generated method stub

        //                        System.out.println("intervalAdded");

                        }

                        public void intervalRemoved(ListDataEvent e) {

                                // TODO Auto-generated method stub

        //                        System.out.println("intervalRemoved");

                        }

                };

    }

        /**

         * ?Sobra? Contiene c?digo interesante

         */

        private void defineAndAddPropertyChangeListener() {

                // Define and add a Listener for changes on the editor or the model of the JComboBox

        super.addPropertyChangeListener(new PropertyChangeListener() {

            public void propertyChange(PropertyChangeEvent ev) {

                if (ev.getPropertyName().equals("editor"))

                        configureEditor((ComboBoxEditor) ev.getNewValue());

                if (ev.getPropertyName().equals("model"))

                        model = (ComboBoxItemsSeekerDynamicModel) ev.getNewValue();

            }

        });

        }

        /**

         * ?SOBRA? De momento la estoy usando, pero no s? si sobra o no

         */

        private void defineEditorFocusListener(JComboBoxItemsSeekerDynamic combo_Box) {

                final JComboBoxItemsSeekerDynamic comboBox = combo_Box;

                // TODO Auto-generated method stub

                // Highlight whole text when gaining focus

                editorFocusListener = new FocusAdapter() {

                        public void focusGained(FocusEvent e) {

                                highlightCompletedText(0);

                        }

                        public void focusLost(FocusEvent e) {

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

                                if (hidePopupOnFocusLoss) comboBox.setPopupVisible(false);

                        }

                };

        }

        /**

         * 

         */

        private void defineEditorKeyListener(JComboBoxItemsSeekerDynamic combo_Box) {

                final JComboBoxItemsSeekerDynamic comboBoxReference = combo_Box;

                // TODO Auto-generated method stub

                editorKeyListener = new KeyAdapter()

                {

                        public void keyPressed(KeyEvent ke)

                        {

                                // This flag indicates to the 'insertString' and 'remove' methods of the PlainDocumentSeeker that the text of the item selected or written by the user

                                //  hasn't been written on the TextEditor of ths component

                                selecting = false;

                                if (comboBoxReference.isDisplayable())

                                        comboBoxReference.setPopupVisible(true);

                                hitBackspace=false;

                                JTextComponent editor = (JTextComponent) comboBoxReference.getEditor().getEditorComponent();

                                switch (ke.getKeyCode())

                                {

                                        // determine if the pressed key is backspace (needed by the remove method)

                                        case KeyEvent.VK_BACK_SPACE :

                                                // Delete the last character written

//                                                String currentString = model.getCurrentString();

//                                                if (currentString.length() > 0)

//                                                        model.setCurrentString(currentString.substring(0,model.getCurrentString().length()-1));

                                                hitBackspace=true;

                                                hitBackspaceOnSelection=editor.getSelectionStart()!=editor.getSelectionEnd();

                                                break;

                                        // ignore delete key

                                        case KeyEvent.VK_DELETE : // supr key in spanish keyboard

                                                // Do nothing -> use the default behavior

                                                //ke.consume();

                                                break;

                                        case KeyEvent.VK_DOWN :

                                            // If the key (typed, pressed and) released has been the Down Key -> when there isn't any text (item of the list) selected, select the first

                                                ke.consume();

        //                                        selecting = true; // For indicate to the 'insertString' of the 'PlainDocumentSeeker' class that an item has been selected

                                                upOrDownKeyPressed = true;

                                                if (getItemCount() > 0)

                                                {

                                                        if (lastSelectedIndex == (getItemCount()-1))

                                                                ((JComboBox)comboBoxReference).setSelectedIndex(0);

                                                        else

                                                                ((JComboBox)comboBoxReference).setSelectedIndex(lastSelectedIndex+1);

                                                }

//                                                model.setCurrentString(getSelectedItem().toString());

                                                lastSelectedIndex = getSelectedIndex();

                                                showPopup();

                                                break;

                                        case KeyEvent.VK_UP :

                                            // If the key (typed, pressed and) released has been the Up Key -> when there isn't any text (item of the list) selected, select the last

                                                ke.consume();

        //                                        selecting = true; // For indicate to the 'insertString' of the 'PlainDocumentSeeker' class that an item has been selected

                                                upOrDownKeyPressed = true;

                                                switch(lastSelectedIndex)

                                                {

                                                        case -1: case 0:

                                                                ((JComboBox)comboBoxReference).setSelectedIndex(getItemCount()-1);

                                                                break;

                                                        default:

                                                                ((JComboBox)comboBoxReference).setSelectedIndex(lastSelectedIndex-1);

                                                }

//                                                model.setCurrentString(getSelectedItem().toString());

                                                lastSelectedIndex = getSelectedIndex();

                                                showPopup();

                                                break;

                                        case KeyEvent.VK_LEFT :

                                                // Do nothing -> use the default behavior

                                                //ke.consume();

                                                break;

                                        case  KeyEvent.VK_RIGHT :

                                                // Do nothing -> use the default behavior

                                                //ke.consume();

                                                break;

                                        case  KeyEvent.VK_PAGE_DOWN :

                                                // Do nothing -> use the default behavior

                                        //        ke.consume();

                                                break;

                                        case KeyEvent.VK_PAGE_UP :

                                                // Do nothing -> use the default behavior

                                        //        ke.consume();

                                                break;                                        

                                        case KeyEvent.VK_TAB :

                                                if (model.getSize() > 0)

                                                {

//                                                        System.out.println("SelectedIndex: " + getSelectedIndex());

                                                        if (((JComboBox)comboBoxReference).getSelectedIndex() == -1)

                                                        {

                                                                lastSelectedIndex = 0;

                                                                ((JComboBox)comboBoxReference).setSelectedIndex(lastSelectedIndex);

                                                        }

                                                        else

                                                        {

                                                                lastSelectedIndex = getSelectedIndex();

                                                                setSelectedIndex(lastSelectedIndex);        // Complete the item string value in the document of the editor                                                        

                                                        }

                                                        hidePopup();

                                                }

                                                break;

                                        case KeyEvent.VK_ESCAPE :

                                                // Reset to the beginning behavior

                                                setSelectedIndex(0);

                                                highlightCompletedText(0);

                                                break;

                                        default:

                                                //System.out.println("Key Pressed:" + ke.getKeyCode());

                                                 if (editor.getText().trim().equalsIgnoreCase("")) {

                                                        // If the current string in the JTextField of the Editor is an empty string -> hide the popup list and the reset the index

                                                        lastSelectedIndex = -1;

                                                        setSelectedIndex(lastSelectedIndex);

                                                        hidePopup();

                                                 }

//                                        // If the key (typed, pressed and) released has been the TAB Key -> try to complete the current selected item from the list and hide the popup list

//

//                                        // If there isn't any item selected and there are items, select and show the first item

//                                        if (this.getModel().getSize() > 0)

//                                        {

//                                                if (!showAllItems)

//                                                {

//                                                        int numItems = this.getItemCount();

//                                                        

//                                                        if (alphanumericSortedSearches)

//                                                        {

//                                                                for (int i=1; i < numItems; i++)

//                                                                {

//                                                                        removedItems.add(this.getModel().getElementAt(1));

//                                                                        notRemovedItems.remove(this.getModel().getElementAt(1));

//                                                                        this.removeItemAt(1);

//                                                                }

//                                                        }

//                                                        else

//                                                        {

//                                                                for (int i=1; i < numItems; i++)

//                                                                {

//                                                                        removedItems.add(this.getModel().getElementAt(1));

//                                                                        this.removeItemAt(1);

//                                                                }                                                        

//                                                        }

//                                                

//                                                        // Show a item

//                                                        this.setSelectedIndex(0);

//                                                }

//                                        }

                                                // A?ADIR LOS CASOS DE TECLA-ESCAPE; y ??

//                                } else if (ke.getKeyChar() == KeyEvent.VK_ESCAPE) {

//                                        // If the key (typed, pressed and) released has been the Escape Key -> hide the popup list and empty the JTextField                        

//                                        this.hidePopup();

//                                        

//                                        if ((!maintainPositionItems) && (!allAlphanumericSorted))

//                                        {

//                                                if (removedItems.size() > 0)

//                                                {

//                                                        Iterator it = removedItems.iterator();

//                                                        

//                                                        while(it.hasNext())

//                                                                super.addItem(it.next());

//                                                        

//                                                        removedItems.clear();

//                                                }

//                                        }

//                                        else

//                                                this.setModel(getCopyOfModel());

//

//                                        txtField.setText("");

//                                        txtField.setForeground(Color.BLACK);

//                                        lastSelectedItem = -1;

//                                        this.setSelectedIndex(lastSelectedItem);

//

//                                

//

                                                //                                    } else if (txtField.getText().trim().equalsIgnoreCase("")) {

//                                                // If the current string in the JTextField of the Editor is an empty string -> hide the popup list and the reset the index

//                                            lastSelectedItem = -1;

//                                                this.setSelectedIndex(lastSelectedItem);

//                                                this.hidePopup();                                                

                        //        default: // Alphanumeric and simbols keys

                                                // Add the new character written

//                                                model.setCurrentString(model.getCurrentString().concat(String.valueOf(ke.getKeyChar())));

                }

            }

                };

        }

        private void configureEditor(ComboBoxEditor newEditor) {

            JTextComponent editor = (JTextComponent) this.getEditor().getEditorComponent();                

            // If there isn't any change on the editor

            if (editor == newEditor)

                    return;

                // Remove the default or last keyListener and FocusListener of the editor of this component

        if (editor != null) {

            editor.removeKeyListener(this.editorKeyListener);

            editor.removeFocusListener(this.editorFocusListener);            

        }

        // Add the new keyListener and FocusListener for this editor and sets

        //   it document as a PlainDocument to optimize the searches of items

        //   when user writes on this editor

        if (newEditor != null) {

            editor = (JTextComponent) newEditor.getEditorComponent();

            editor.addKeyListener(this.editorKeyListener);

            editor.addFocusListener(this.editorFocusListener);

            editor.setDocument(this.document);

                    // Disable the focus transversal keys (Example: CTRL+TAB) for enable the TAB key

                    editor.setFocusTraversalKeysEnabled(false);

        }

        }

        /**

         * Marks text since 'start' position to its end on a grey color

         *  

         * @param start Start position for mark the text

         */

    private void highlightCompletedText(int start) {

            JTextComponent editor = (JTextComponent) this.getEditor().getEditorComponent();

        editor.setCaretPosition(document.getLength());

        editor.moveCaretPosition(start);

    }

////// REDEFINITION OF SOME METHODS OF JCOMBOBOX //////

        /*

         *  (non-Javadoc)

         * @see javax.swing.JComboBox#actionPerformed(java.awt.event.ActionEvent)

         */

        public void actionPerformed(ActionEvent e)

        {

                super.actionPerformed(e);

//                System.out.println("Action-Performed");

                // This flag indicates to the 'insertString' method of the PlainDocumentSeeker that the text of the item selected or written by the user

                //  hasn't been written on the TextEditor of ths component

                selecting = false;

        }

    /*

     * (non-Javadoc)

     * @see javax.swing.JComboBox#addItem(java.lang.Object)

     */

    public void addItem(Object anObject) {

                // Add the item to this component                

                model.addElement(anObject);

//                System.out.println("LastSelectedIndexWas: " + this.lastSelectedIndex);

                // Set the last selected item -> by default select the first item

                if (this.lastSelectedIndex == -1)

                {

                        this.lastSelectedIndex = 0;

                        this.setSelectedIndex(this.lastSelectedIndex);

//                        model.setCurrentString(anObject.toString());

                }

        }

//    /*

//     * (non-Javadoc)

//     * @see javax.swing.JComboBox#getSelectedIndex()

//     */

//    public int getSelectedIndex() {

//            // ??Modificarlo??

//            return super.getSelectedIndex();

//    }

    /*

     * (non-Javadoc)

     * @see javax.swing.JComboBox#getItemCount()

     */

    public int getItemCount() {

            return model.getSize();

    }

    /*

     * (non-Javadoc)

     * @see javax.swing.JComboBox#getItemAt(int)

     */

    public Object getItemAt(int index) {

            return model.getElementAt(index);

    }

    /*

     * (non-Javadoc)

     * @see javax.swing.JComboBox#setModel(javax.swing.ComboBoxModel)

     */

    public void setModel(ComboBoxModel aModel) { //PROBLEMA

            // Depending on the type of class of the current object, this object will execute different code

            if (aModel instanceof ComboBoxItemsSeekerDynamicModel)

            {

//                    System.out.println("A");

                    //super.setModel(aModel);

                    super.setModel(aModel);

                    model = (ComboBoxItemsSeekerDynamicModel)super.getModel();

                    // If we insert a model with items -> select by default the first

                    if (aModel.getSize() > 0)

                    {

                            this.lastSelectedIndex = 0;

                            this.setSelectedIndex(this.lastSelectedIndex);

//                            model.setCurrentString(this.getSelectedItem().toString());

                    }

                    else

                    {

                            // Else -> set the default index (-1) and current showed string ("")

                            this.lastSelectedIndex = -1;

                            this.setSelectedIndex(this.lastSelectedIndex);

//                            model.setCurrentString("");

                    }

                    this.configureModel();

            }

            else

            {

                    // If it's an instance of DefaultComboBoxModel:

//                    System.out.println("B");

                    super.setModel(aModel);                    

            }                    

     }

    /*

     * (non-Javadoc)

     * @see javax.swing.JComboBox#setSelectedIndex(int)

     */

    public void setSelectedIndex(int anIndex) {

            super.setSelectedIndex(anIndex);

            this.lastSelectedIndex = anIndex;

            try {

                        document.remove(0, document.getLength());

                        if (getSelectedIndex() > -1)

                                document.insertString(0, getSelectedItem().toString(), null);

                        else

                                this.lastSelectedIndex = -1;

                } catch (BadLocationException e) {

                        // TODO Auto-generated catch block

                        e.printStackTrace();

                }                

    }

    /*

     *  (non-Javadoc)

     * @see javax.swing.JComboBox#setSelectedItem(java.lang.Object)

     */

    public void setSelectedItem(Object anObject) {

            super.setSelectedItem(anObject);

            this.lastSelectedIndex = model.getIndexOf(anObject);

//            System.out.println("Posici?n: " + this.lastSelectedIndex);

            //super.setSelectedIndex(this.lastSelectedIndex);

//            try {

//                        document.remove(0, document.getLength());

//                        if (getSelectedIndex() > -1)

//                                document.insertString(0, getSelectedItem().toString(), null);

//                        else

//                                this.lastSelectedIndex = -1;

//                        

//                } catch (BadLocationException e) {

//                        // TODO Auto-generated catch block

//                        e.printStackTrace();

//                }                

    }

//    

    ////// END REDEFINITION OF SOME METHODS OF JCOMBOBOX //////

        ////// METHODS FOR THE BEHAVIOR FLAGS  //////

        /**

         * This method tests the configuration of the flags and returns true or false if its ok or not with the

         *   logical behavior of this component

         * 

         * @return boolean True if the configuration of the flags is oks, false if not

         */

        public boolean testFlagsConfigurationOK() {

                return this.model.testFlagsConfigurationOK();

        }

        /**

         * Gets the flag of the configuration of the policy for maintain the position of the items of this component 

         * (true -> maintains the position of the items, false -> don't maintains the position of the items)

         * 

         * @return boolean The value of the flag

         */

        public boolean isMaintainPositionItems() {

                return this.model.isMaintainPositionItems();

        }

        /**

         * Sets the flag of the configuration of the policy for maintain the position of the items of this component 

         * (true -> maintains the position of the items, false -> don't maintains the position of the items)

         * 

         * @param boolean The value of the flag

         */

        public void setMaintainPositionItems(boolean maintain_Position_Items) {

                this.model.setMaintainPositionItems(maintain_Position_Items);

                if (!this.model.testFlagsConfigurationOK())

                        JOptionPane.showMessageDialog(this, PluginServices.getText(this, "error_message_JComboBoxSearcheableDynamic"), PluginServices.getText(this, "exportJOP2Title"), JOptionPane.ERROR_MESSAGE);

        }

        /**

         * Gets the flag of the configuration of the alphanumericSortedSearches flag of this component 

         * (true -> all items showed when we write on the textfield will be showed in alphanumeric ordenation; false -> they don't have to be in alphanumeric ordenation)

         * 

         * @return boolean The value of the flag

         */

        public boolean isAlphanumericSortedSearches() {

                return this.model.isAlphanumericSortedSearches();

        }

        /**

         * Sets the flag of the configuration of the alphanumericSortedSearches flag of this component 

         * (true -> all items showed when we write on the textfield will be showed in alphanumeric ordenation; false -> they don't have to be in alphanumeric ordenation)

         * 

         * @param boolean The value of the flag

         */

        public void setAlphanumericSortedSearches(boolean alphanumeric_Sorted_Searches) {

                this.model.setAlphanumericSortedSearches(alphanumeric_Sorted_Searches);

                if (!this.model.testFlagsConfigurationOK())

                        JOptionPane.showMessageDialog(this, PluginServices.getText(this, "error_message_JComboBoxSearcheableDynamic"), PluginServices.getText(this, "exportJOP2Title"), JOptionPane.ERROR_MESSAGE);

//                if (this.model.isAlphanumericSortedSearches())

//                {

//                        notRemovedItems = new HashSet();

//                        

//                        for (int i=0; i < this.getItemCount(); i++)

//                                notRemovedItems.add(this.getItemAt(i));

//                }

//                else

//                        notRemovedItems.clear();

        }

        /**

         * Gets the flag of the configuration of the allAlphanumericSorted flag of this component 

         * (true -> all items showed will be in alphanumeric ordenation; false -> they don't have to be in alphanumeric ordenation)

         * 

         * @return boolean The value of the flag

         */

        public boolean isAllAlphanumericSorted() {

                return this.model.isAllAlphanumericSorted();

        }

        /**

         * Sets the flag of the configuration of the allAlphanumericSorted flag of this component 

         * (true -> all items showed will be in alphanumeric ordenation; false -> they don't have to be in alphanumeric ordenation)

         * 

         * @param boolean The value of the flag

         */

        public void setAllAlphanumericSorted(boolean all_Alphanumeric_Sorted) {

                this.model.setAllAlphanumericSorted(all_Alphanumeric_Sorted);

//                if (allAlphanumericSorted)

                if (!this.model.testFlagsConfigurationOK())

                        JOptionPane.showMessageDialog(this, PluginServices.getText(this, "error_message_JComboBoxSearcheableDynamic"), PluginServices.getText(this, "exportJOP2Title"), JOptionPane.ERROR_MESSAGE);

        }

        /**

         * Gets the flag of the configuration of the keySensitive flag of this component 

         * (true -> discriminates capital letters from small letters ,false -> don't discriminates capital letters from small letters)

         * 

         * @return boolean The value of the flag

         */

        public boolean isKeySensitive() {

                return this.model.isKeySensitive();

        }

        /**

         * Sets the flag of the configuration of the keySensitive flag of this component 

         * (true -> discriminates capital letters from small letters ,false -> don't discriminates capital letters from small letters)

         * 

         * @param boolean The value of the flag

         */

        public void setKeySensitive(boolean key_Sensitive) {

                this.model.setKeySensitive(key_Sensitive);

                if (!this.model.testFlagsConfigurationOK())

                        JOptionPane.showMessageDialog(this, PluginServices.getText(this, "error_message_JComboBoxSearcheableDynamic"), PluginServices.getText(this, "exportJOP2Title"), JOptionPane.ERROR_MESSAGE);

        }

        /**

         * Gets the flag of the configuration of the onlyOneColor flag of this component

         * (true -> The text on the textField only will be showed on black color; false -> if the text on the textField doesn't match with any current item of this 

         *            component -> the text will be showed on red color)

         * 

         * @return boolean The value of the flag

         */

        public boolean isOnlyOneColor() {

                return onlyOneColor;

        }

        /**

         * Sets the flag of the configuration of the onlyOneColor flag of this component 

         * (true -> discriminates capital letters from small letters ,false -> don't discriminates capital letters from small letters)

         * 

         * @param boolean The value of the flag

         */

        public void setOnlyOneColor(boolean only_One_Color) {

                this.onlyOneColor = only_One_Color;

                if (!this.model.testFlagsConfigurationOK())

                        JOptionPane.showMessageDialog(this, PluginServices.getText(this, "error_message_JComboBoxSearcheableDynamic"), PluginServices.getText(this, "exportJOP2Title"), JOptionPane.ERROR_MESSAGE);

        }

        /**

         * Gets the flag of the configuration of the showAllItems flag of this component

         * (true -> this component shows all items always; false -> this component only shows items that their first characters match with the string written by the user) 

         * 

         * @return boolean The value of the flag

         */

        public boolean isShowAllItems() {

                return this.model.isShowAllItems();

        }

        /**

         * Sets the flag of the configuration of the showAllItems flag of this component

         * (true -> this component shows all items always; false -> this component only shows items that their first characters match with the string written by the user)

         * 

         * @return boolean The value of the flag

         */

        public void setShowAllItems(boolean show_All_Items) {

                this.model.setShowAllItems(show_All_Items);

//                if (this.model.isShowAllItems() == false)

//                        this.setModel(getCopyOfModel());

        }

        ////// END METHODS FOR THE BEHAVIOR FLAGS  //////

        /** REVISAR COMENTARIOS Y C?DIGO

         * Inner class for optimize the seek of items

         * 

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

         *

         */

        private class PlainDocumentSeeker extends PlainDocument{

                private JComboBoxItemsSeekerDynamic comboBox;

                /**

                 * Default Constructor

                 */

                public PlainDocumentSeeker() {

                        super();

                }

                /**

                 * Sets a reference of the combo_Box

                 * 

                 * @param combo_Box

                 */

                public void setJComboBoxItemsSeekerDynamicReference(JComboBoxItemsSeekerDynamic combo_Box) {

                        comboBox = combo_Box;

                }

                /* REVISAR

                 *  (non-Javadoc)

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

                 */

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

                // return immediately when selecting an item

                if (selecting) return;

                if (hitBackspace)

                {

                    // user hit backspace => move the selection backwards

                    // old item keeps being selected

                    if (offs>0)

                    {

                        if (hitBackspaceOnSelection)

                                offs--;

                    }

                    else

                    {

                        // User hit backspace with the cursor positioned on the start => beep

                            if (useBeep)

                                    comboBox.getToolkit().beep(); // when available use: UIManager.getLookAndFeel().provideErrorFeedback(comboBox);

                    }

                    highlightCompletedText(offs);

                }

                else

                {

                    super.remove(offs, len);

                }

            }

                /*REVISAR

                 *  (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 {

//                    super.insertString(offs, str, a);

//                    System.out.println("INSERTSTRING: " + str);

//                    model.setCurrentString(str);

                if (comboBox.getSelectedIndex() > -1) // No s? si sobra o no

                {

                            // return immediately when selecting an item

                        if (selecting) return;                        

                        // Insert the string into the document

                        super.insertString(offs, str, a);

                        // Lookup and select a matching item

                        Object item = lookupItem(getText(0, getLength()));

                        if (item != null)

                        {

                            setSelectedItem(item);

//                            model.setCurrentString(getSelectedItem().toString());

//                            lastSelectedIndex = getSelectedIndex();

                        }

                        else

                        {

                            // Keep old item selected if there is no match

                            item = comboBox.getSelectedItem();

                            // Imitate no insert (later on offs will be incremented by str.length(): selection won't move forward)

                            offs = offs-str.length();

                            // Provide feedback to the user that his input has been received but can not be accepted

                            if (useBeep)

                                    comboBox.getToolkit().beep(); // when available use: UIManager.getLookAndFeel().provideErrorFeedback(comboBox);

                        }

                        // Set the complete item value matched

                        if (completeMatchedItem)

                                setText(item.toString());

                        // Select the completed part

                        highlightCompletedText(offs+str.length());

                }

            }

            /** ?Sobra?

             * This method sets the string value of the item to the PlainDocument removing the previous value of the PlainDocument

             * 

             * @param text The string value of the item

             */

            private void setText(String text) {

                try

                {

                    // remove all text and insert the completed string

                    super.remove(0, super.getLength());

                    super.insertString(0, text, null);

                }

                catch (BadLocationException e)

                {

                    throw new RuntimeException(e.toString());

                }

            }

            /**

             * 

             */

            private Object lookupItem(String pattern) {

                    // Reset the color to the default

                    editor.getEditorComponent().setForeground(Color.BLACK);

                Object selectedItem = model.getSelectedItem();

                // only search for a different item if the currently selected does not match

                if ((selectedItem != null) && (startsWithIgnoreCase(selectedItem.toString(), pattern)))

                {

                    return selectedItem;

                }

                else

                {

                    // iterate over all items

                    for (int i=0, n=model.getSize(); i < n; i++)

                    {

                        Object currentItem = model.getElementAt(i);

                        // current item starts with the pattern?

                        if ((currentItem != null) && (startsWithIgnoreCase(currentItem.toString(), pattern)))

                        {

                            return currentItem;

                        }

                    }

                }                

                // If no item starts with the pattern => return null and set the text written on red color if it's allowed                

                if (!isOnlyOneColor())

                        editor.getEditorComponent().setForeground(Color.RED);

                return null;

            }

            /**

             * Checks if the starts of two strings agrees

             */

            private boolean startsWithIgnoreCase(String str1, String str2) {

                    if (comboBox.isKeySensitive())

                            return str1.startsWith(str2);

                    else

                            return str1.toUpperCase().startsWith(str2.toUpperCase());

            }

        }

}