ByteEdit/src/org/fife/ui/autocomplete/AbstractCompletion.java

/*
 * 12/21/2008
 * AbstractCompletion.java - Base class for possible completions.
 * This library is distributed under a modified BSD license. See the included
 * AutoComplete.License.txt file for details.
 */
package org.fife.ui.autocomplete;

import javax.swing.Icon;
import javax.swing.text.JTextComponent;

/**
 * Base class for possible completions. Most, if not all, {@link Completion}
 * implementations can extend this class. It remembers the
 * <tt>CompletionProvider</tt> that returns this completion, and also implements
 * <tt>Comparable</tt>, allowing such completions to be compared
 * lexicographically (ignoring case).
 * <p>
 *
 * This implementation assumes the input text and replacement text are the
 * same value. It also returns the input text from its {@link #toString()}
 * method (which is what <code>DefaultListCellRenderer</code> uses to render
 * objects). Subclasses that wish to override any of this behavior can simply
 * override the corresponding method(s) needed to do so.
 *
 * @author Robert Futrell
 * @version 1.0
 */
public abstract class AbstractCompletion implements Completion {
	
	/**
	 * The provider that created this completion;
	 */
	private CompletionProvider provider;
	/**
	 * The icon to use for this completion.
	 */
	private Icon icon;
	/**
	 * The relevance of this completion. Completion instances with higher
	 * "relevance" values are inserted higher into the list of possible
	 * completions than those with lower values. Completion instances with
	 * equal relevance values are sorted alphabetically.
	 */
	private int relevance;
	
	/**
	 * Constructor.
	 *
	 * @param provider
	 *            The provider that created this completion.
	 */
	protected AbstractCompletion(CompletionProvider provider) {
		this.provider = provider;
	}
	
	/**
	 * Constructor.
	 *
	 * @param provider
	 *            The provider that created this completion.
	 * @param icon
	 *            The icon for this completion.
	 */
	protected AbstractCompletion(CompletionProvider provider, Icon icon) {
		this(provider);
		setIcon(icon);
	}
	
	/**
	 * {@inheritDoc}
	 */
	@Override
	public int compareTo(Completion c2) {
		if (c2 == this) {
			return 0;
		} else if (c2 != null) {
			return toString().compareToIgnoreCase(c2.toString());
		}
		return -1;
	}
	
	/**
	 * {@inheritDoc}
	 */
	@Override
	public String getAlreadyEntered(JTextComponent comp) {
		return provider.getAlreadyEnteredText(comp);
	}
	
	/**
	 * {@inheritDoc}
	 */
	@Override
	public Icon getIcon() {
		return icon;
	}
	
	/**
	 * Returns the text the user has to (start) typing for this completion
	 * to be offered. The default implementation simply returns
	 * {@link #getReplacementText()}.
	 *
	 * @return The text the user has to (start) typing for this completion.
	 * @see #getReplacementText()
	 */
	@Override
	public String getInputText() {
		return getReplacementText();
	}
	
	/**
	 * {@inheritDoc}
	 */
	@Override
	public CompletionProvider getProvider() {
		return provider;
	}
	
	/**
	 * {@inheritDoc}
	 */
	@Override
	public int getRelevance() {
		return relevance;
	}
	
	/**
	 * The default implementation returns <code>null</code>. Subclasses
	 * can override this method.
	 *
	 * @return The tool tip text.
	 */
	@Override
	public String getToolTipText() {
		return null;
	}
	
	/**
	 * Sets the icon to use for this completion.
	 *
	 * @param icon
	 *            The icon to use.
	 * @see #getIcon()
	 */
	public void setIcon(Icon icon) {
		this.icon = icon;
	}
	
	/**
	 * Sets the relevance of this completion.
	 *
	 * @param relevance
	 *            The new relevance of this completion.
	 * @see #getRelevance()
	 */
	public void setRelevance(int relevance) {
		this.relevance = relevance;
	}
	
	/**
	 * Returns a string representation of this completion. The default
	 * implementation returns {@link #getInputText()}.
	 *
	 * @return A string representation of this completion.
	 */
	@Override
	public String toString() {
		return getInputText();
	}
}