| gvSIG desktop 1

package org.gvsig.gui.beans.comboBoxItemsSeeker;

import java.util.Arrays;

import java.util.Collections;

import java.util.HashSet;

import java.util.List;

import java.util.Set;

import java.util.Vector;

import javax.swing.DefaultComboBoxModel;

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

 *  COMENTAR Y REVISAR

 * Se consideran los datos que contiene DefaultComboBoxModel como los que se tomar?n para devolver datos a no ser que sea para actualizar la lista

 *    de la vista, que en cuyo caso se tendr? en cuenta la configuraci?n del comportamiento y atributos internos.

 * 

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

 */

public class ComboBoxItemsSeekerDynamicModel extends DefaultComboBoxModel implements java.io.Serializable {

        // INNER MODEL STRUCTURES

        private Set itemsShowed;

        private Object itemsShowedSortedOrDisordered[];

        private String writtenText;

//        private String writtenString = "";

        // END INNER MODEL STRUCTURES

        // CONTANTS FOR CONFIGURE THE BEHAVIOR

        public final int ORIGINAL_POSITION_ALL = 0;

        public final int SORTED_ALL = 1;

        public final int DISORDERED_ALL = 2;

        public final int ORIGINAL_POSITION_SEARCH = 0;

        public final int SORTED_SEARCH = 1;

        public final int DISORDERED_SEARCH = 2;

        // END CONTANTS FOR CONFIGURE THE BEHAVIOR

        // CONFIGURATION FLAGS (Voy a Cambiar algunas!!!!)

        private boolean maintainPositionItems;        

        private boolean alphanumericSortedSearches;

        private boolean allAlphanumericSorted;

        private boolean keySensitive;

        private boolean showAllItems;

//        (With the default value)

//        private boolean maintainPositionItems = true;        

//        private boolean alphanumericSortedSearches = true;

//        private boolean allAlphanumericSorted  = true;

//        private boolean keySensitive = false;

//        private boolean showAllItems = true; //false;;

        // END FLAGS        

        // OTHER FLAGS

        private boolean allItemsAreSorted;

        private boolean allItemsAreDisordered;

        private boolean thisIsAComboBoxItemsSeekerDynamicModelClass; // To distinguish the class which invokes some methods of this class

        // END OTHER FLAGS

        /**

         * Default Constructor without parameters.

         * Constructs an empty ComboBoxItemsSeekerDynamicModel object.          

         */

        public ComboBoxItemsSeekerDynamicModel() {

                super();

                this.initialize();

        }

        /**

         * Default Constructor with an array of objects as parameter.

         * Constructs a ComboBoxItemsSeekerDynamicModel object initialized with an array of objects.

         * @throws Exception 

         */

        public ComboBoxItemsSeekerDynamicModel(Object[] items) throws Exception {                

                super(items);

                this.initialize();

                if (!this.itemsShowed.addAll(Arrays.asList(items)))

                        throw new Exception();

        }

        /**

         * Default Constructor with a vector as parameter.

         * Constructs a ComboBoxItemsSeekerDynamicModel object initialized with a vector.

         * @throws Exception 

         */

        public ComboBoxItemsSeekerDynamicModel(Vector objects) throws Exception {

                super(objects);

                this.initialize();

                if (!this.itemsShowed.addAll(objects))

                        throw new Exception();

        }

        /**

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

         */

        private void initialize() {

                thisIsAComboBoxItemsSeekerDynamicModelClass = true;

//                this.currentString = "";

                this.writtenText = "";

                this.setDefaultBehaviorFlagsConfiguration();

                this.allItemsAreSorted = false;

                this.allItemsAreDisordered = false;

                this.itemsShowed = new HashSet();

        }

        /**

         * Method that sets the default values of the behavior flags

         */

        private void setDefaultBehaviorFlagsConfiguration() {

                // Set the default values of the flags

                this.maintainPositionItems = true;                

                this.alphanumericSortedSearches = true;

                this.allAlphanumericSorted = false;

                this.keySensitive = false;

                this.showAllItems = true; //false;        

        }

        /** A BORRAR

         * @param currentString The currentString to set.

         */

//        public void setCurrentString(String currentString) {

//                this.currentString = currentString;

//                Vector v = new Vector();                

//                

//                //Refrescar el modelo                

//                for (int i=0 ; i<allObjects.size() ; i++){

//                        String obj = allObjects.get(i).toString();

//                        if (currentString.equals("")){

//                                v.add(allObjects.get(i));

//                        }else if (obj.indexOf(currentString) == 0){

//                                v.add(allObjects.get(i));

//                        }

//                }

//                orderedObjects = v;

//        }

        ////// 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() {

                if ((maintainPositionItems == allAlphanumericSorted) && (maintainPositionItems == true))

                        return false;

                if ((maintainPositionItems == false) && (allAlphanumericSorted == true) && (alphanumericSortedSearches == false))

                        return false;

//                if ((showAllItems == true) && (maintainPositionItems == false))

//                        return false;

                return true;

        }

        /**

         * 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 maintainPositionItems;

        }

        /**

         * 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.maintainPositionItems = maintain_Position_Items;

        }

        /**

         * 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 alphanumericSortedSearches;

        }

        /**

         * 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.alphanumericSortedSearches = alphanumeric_Sorted_Searches;

//                if (!testFlagsConfigurationOK())

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

//

//                if (alphanumericSortedSearches)

//                {

//                        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 allAlphanumericSorted;

        }

        /**

         * 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.allAlphanumericSorted = all_Alphanumeric_Sorted;

                // If all_Alphanumeric_Sorted = true -> alphanumeric_Sorted_Searches = true

                setAlphanumericSortedSearches(this.alphanumericSortedSearches | this.allAlphanumericSorted);

//                if (allAlphanumericSorted)

//                

        }

        /**

         * 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 keySensitive;

        }

        /**

         * 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.keySensitive = key_Sensitive;

        }

        /**

         * 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 showAllItems;

        }

        /**

         * 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.showAllItems = show_All_Items;

//                if (this.showAllItems == false)

//                        this.setModel(getCopyOfModel());

        }

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

        ////// REIMPLEMENTATION OF SOME METHODS OF "DefaultComboBoxModel" TO ADAPT THE BEHAVIOR OF THIS MODEL //////        

        /*

         *  (non-Javadoc)

         * @see javax.swing.DefaultComboBoxModel#getSize()

         */

        public int getSize() {

                // TENGO DUDAS DE ESTE ALGORITMO

                if (thisIsAComboBoxItemsSeekerDynamicModelClass == true)

                {

//                        System.out.println("ENTRA AQUI ComboBoxItemsSeekerDynamicModel");

                        if (this.showAllItems)

                                return this.itemsShowed.size();

                        else

                        {

                                // HAcerlo

//                                System.out.println("ENTRA AQUI");

                                return 0;

                        }

                }

                else

                {

                        // If the class which is this object instance is 'javax.swing.DefaultComboBoxModel'

//                        System.out.println("ENTRA AQUI DEFAULTCOMBOBOXMODEL");

                        return super.getSize();

                }

        }

        /*

         *  (non-Javadoc)

         * @see javax.swing.ListModel#getElementAt(int)

         */

        public Object getElementAt(int index) {

                if (this.showAllItems)

                {

                        // Primero considerar el mostrar todos al comienzo

                        // Caso de las b?squedas

                        // If the items have to be showed in ascending order

                        if (this.alphanumericSortedSearches)

                        {

                                // If the items aren't sorted -> sort them!

                                if (!this.allItemsAreSorted)

                                        this.sortItemsCopy();

                                // Return the item at that position

                                return this.itemsShowedSortedOrDisordered[index];

                        }

                        else

                        {

                                if (this.maintainPositionItems)

                                        return super.getElementAt(index);

                                else

                                {

                                        // If the items aren't sorted -> sort them!

                                        if (!this.allItemsAreDisordered)

                                                this.disorderItemsCopy();

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

                                        // Return the item at that position

                                        return this.itemsShowedSortedOrDisordered[index];

                                }

                        }

                }

                else

                {

                        // HAcerlo

                        return new Object();

                }                

        }

        /*

         *  (non-Javadoc)

         * @see javax.swing.MutableComboBoxModel#addElement(java.lang.Object)

         */

        public void addElement(Object anObject) {

                super.addElement(anObject);

                // Add the item also in the inner attribute

                this.itemsShowed.add(anObject);

                // If this model has to return the elements sorted

                if (this.alphanumericSortedSearches)

                        this.allItemsAreSorted = false;

                // If elements have to be disordered

                if ((!this.maintainPositionItems) && (!this.alphanumericSortedSearches))

                        this.allItemsAreDisordered = false;

         }

        /*

         *  (non-Javadoc)

         * @see javax.swing.DefaultComboBoxModel#getIndexOf(java.lang.Object)

         */

        public int getIndexOf(Object anObject) {

                //if (this.alphanumericSortedSearches)

                        //return this.itemsShowedVector.indexOf(anObject);

                return super.getIndexOf(anObject); //this.itemsShowed.indexOf(anObject);                        

        }

    /*

     *  (non-Javadoc)

     * @see javax.swing.ComboBoxModel#getSelectedItem()

     */

        public Object getSelectedItem() {

                return super.getSelectedItem();

        }        

        /*

         *  (non-Javadoc)

         * @see javax.swing.MutableComboBoxModel#insertElementAt(java.lang.Object, int)

         */

        public void insertElementAt(Object anObject, int index) {

                super.insertElementAt(anObject, index);

                // Add the item also in the inner attribute

                this.itemsShowed.add(anObject);

                // If this model has to return the elements sorted

                if (this.alphanumericSortedSearches)

                        this.allItemsAreSorted = false;

                // If elements have to be disordered

                if ((!this.maintainPositionItems) && (!this.alphanumericSortedSearches))

                        this.allItemsAreDisordered = false;

        }

        /*

         *  (non-Javadoc)

         * @see javax.swing.DefaultComboBoxModel#removeAllElements()

         */

        public void removeAllElements() {

                super.removeAllElements();

                // Also empty the inner attribute

                itemsShowed.clear();                

                // If this model has to return the elements sorted

                if (this.alphanumericSortedSearches)

                        this.allItemsAreSorted = false;

                // If elements have to be disordered

                if ((!this.maintainPositionItems) && (!this.alphanumericSortedSearches))

                        this.allItemsAreDisordered = false;

        }

        /*

         *  (non-Javadoc)

         * @see javax.swing.MutableComboBoxModel#removeElement(java.lang.Object)

         */

        public void removeElement(Object anObject) {

                super.removeElement(anObject);

                // Remove the object also in the inner attribute

                itemsShowed.remove(anObject);

                // If this model has to return the elements sorted

                if (this.alphanumericSortedSearches)

                        this.allItemsAreSorted = false;

                // If elements have to be disordered

                if ((!this.maintainPositionItems) && (!this.alphanumericSortedSearches))

                        this.allItemsAreDisordered = false;

        }

        /*

         *  (non-Javadoc)

         * @see javax.swing.MutableComboBoxModel#removeElementAt(int)

         */

        public void removeElementAt(int index) {

                Object obj = new Object();

                obj = super.getElementAt(index);

                super.removeElementAt(index);

                // Remove the object also in the inner attribute

                itemsShowed.remove(obj);

                // If this model has to return the elements sorted

                if (this.alphanumericSortedSearches)

                        this.allItemsAreSorted = false;

                // If elements have to be disordered

                if ((!this.maintainPositionItems) && (!this.alphanumericSortedSearches))

                        this.allItemsAreDisordered = false;

        }

//        /*

//         *  (non-Javadoc)

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

//         */

//        public void setSelectedItem(Object anObject) {

//                super.setSelectedItem(anObject);

//        }

//        

//        ////// END REIMPLEMENTATION OF METHODS OF "DefaultComboBoxModel" TO ADAPT THE BEHAVIOR OF THIS MODEL //////        

//

//

//        /**

//         * @param currentString 

//         */

//        public void setCurrentString(String currentString) {

//                this.currentString = currentString;

//                

//                System.out.println("SetCurrentString-> CurrentString: '" + this.currentString + "'");

////                Vector v = new Vector();                

//                

//                //Refrescar el modelo

//                

////                for (int i=0 ; i< super.getSize() ; i++){

////                        String obj = super.getElementAt(i).toString();

////                        if (currentString.equals("")){

////                                v.add(super.getElementAt(i));

////                        }else if (obj.indexOf(currentString) == 0){

////                                v.add(super.getElementAt(i));

////                        }

////                }                

//        }

//        /**

//         * 

//         * @return

//         */

//        public String getCurrentString() {

//                System.out.println("GetCurrentString-> CurrentString: '" + this.currentString + "'");

//                return this.currentString;

//        }

        /**

         * 

         */

        public void setWrittenString(String text) {

//                System.out.println("Entrada: " + writtenString);

                writtenText = text;

                if ((!this.maintainPositionItems) && (!this.alphanumericSortedSearches))

                        this.disorderItemsCopy();

        }

        /**

         * This method sort the items of this component and store them on a array

         */

        private void sortItemsCopy() {

                if (this.alphanumericSortedSearches)

                {

                        this.itemsShowedSortedOrDisordered = this.itemsShowed.toArray();

                        Arrays.sort(this.itemsShowedSortedOrDisordered);

                        this.allItemsAreSorted = true;

                }

        }

        /**

         * This method gets the items of this component disordered and store them on a array

         */

        private void disorderItemsCopy() {

                if ((!this.maintainPositionItems) && (!this.alphanumericSortedSearches))                        

                {

                        this.itemsShowedSortedOrDisordered = this.itemsShowed.toArray();

                        Collections.shuffle(Arrays.asList(this.itemsShowedSortedOrDisordered)); // Disorder the items

                        this.allItemsAreDisordered = true;

                }

        }        

}