org.jdesktop.swingx.autocomplete.AbstractAutoCompleteAdaptor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of swingx Show documentation
Contains extensions to the Swing GUI toolkit, including new and enhanced components that provide functionality commonly required by rich client applications.
The newest version!
/*
 * $Id: AbstractAutoCompleteAdaptor.java 1299 2006-07-29 14:57:49Z Bierhance $
 *
 * Copyright 2004 Sun Microsystems, Inc., 4150 Network Circle,
 * Santa Clara, California 95054, U.S.A. All rights reserved.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * This library 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
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */
package org.jdesktop.swingx.autocomplete;

import javax.swing.text.JTextComponent;

/**
 * This is the interface that binds the mechanism for automatic completion to
 * a data model, a selection model (e.g. those used by JList, JComboBox and JTable)
 * and the JTextComponent for which the automatic completion should happen.
 * It is used to search and select a matching item and to mark the completed text
 * inside the JTextComponent. Using this interface the mechanism for automatic
 * completion is independent from the underlying data and selection model.
 *
 * @see ComboBoxAdaptor
 * @see ListAdaptor
 *
 * @author Thomas Bierhance
 */
public abstract class AbstractAutoCompleteAdaptor {
    
    /** the string representation in use for the currently selected item*/
    private String selectedItemAsString;
    
    /**
     * Returns the currently selected item.
     * @return the selected item
     */
    public abstract Object getSelectedItem();
    
    /**
     * Sets the selected item.
     * @param item the item that is to be selected
     */
    public abstract void setSelectedItem(Object item);
    
    /**
     * Returns the string representation in use for the currently selected item.
     * @return the string representation in use for the currently selected item
     */
    public String getSelectedItemAsString() {
        return this.selectedItemAsString;
    }
    
    /**
     * Sets the string representation in use for the currently selected item.
     * @param itemAsString the string representation in use for the currently selected item
     */
    public void setSelectedItemAsString(String itemAsString) {
        this.selectedItemAsString = itemAsString;
    }

    /**
     * Returns the number of items in the list.
     * @return the number of items in the list
     */
    public abstract int getItemCount();
    
    /**
     * Returns the item at a given index. It is supposed that 0<=index<getItemCount().
     * @param index the index of the item that is to be returned
     * @return the item at the given index
     */
    public abstract Object getItem(int index);
    
    /**
     * Returns true if the list contains the currently selected item.
     * @return true if the list contains the currently selected item.
     */
    public boolean listContainsSelectedItem() {
        Object selectedItem = getSelectedItem();
        for (int i=0,n=getItemCount(); istart.
     * @param start index of the first character that should be marked
     */
    public void markText(int start) {
        getTextComponent().setCaretPosition(getTextComponent().getText().length());
        getTextComponent().moveCaretPosition(start);
    }
}