/bundles/plugins-trunk/SideKick/sidekick/SideKickCompletion.java

/*
 * SideKickCompletion.java
 * :tabSize=8:indentSize=8:noTabs=false:
 * :folding=explicit:collapseFolds=1:
 *
 * Copyright (C) 2003, 2005 Slava Pestov
 *
 * 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 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.
 */

package sidekick;

//{{{ Imports
import javax.swing.*;
import java.util.*;
import org.gjt.sp.jedit.*;
import org.gjt.sp.jedit.buffer.JEditBuffer;
import org.gjt.sp.jedit.textarea.*;
//}}}

/**
 * A code completion instance.<p>
 *
 * This is a wrapper around a collection of possible completions, with callbacks
 * for inserting and displaying the completions in a popup menu.
 *
 * @author Slava Pestov
 * @version $Id: SideKickCompletion.java 10427 2007-08-22 22:43:15Z ezust $
 * @since SideKick 0.3
 */
public abstract class SideKickCompletion
{
	//{{{ SideKickCompletion constructor
	/**
	 * @deprecated Use the other constructor instead.
	 */
	public SideKickCompletion() {}
	//}}}

	//{{{ SideKickCompletion constructor
	/**
	 * @since SideKick 0.3.2
	 */
	public SideKickCompletion(View view, String text)
	{
		this.view = view;
		textArea = view.getTextArea();
		this.text = text;
	} //}}}

	//{{{ SideKickCompletion constructor
	/**
	 * @since SideKick 0.3.2
	 * @param items - a list of strings containing the possible completions.
	 */
	public SideKickCompletion(View view, String text, List items)
	{
		this(view,text);
		this.items = items;
	} //}}}

	//{{{ SideKickCompletion constructor
	/**
	 * @since SideKick 0.3.2
	 */
	public SideKickCompletion(View view, String text, Object[] items)
	{
		this(view,text);
		this.items = Arrays.asList(items);
	} //}}}

	//{{{ size() method
	public int size()
	{
		return items.size();
	} //}}}

	//{{{ get() method
	public Object get(int index)
	{
		return items.get(index);
	} //}}}

	//{{{ getCompletionDescription() method
	public String getCompletionDescription(int index)
	{
		return null;
	} //}}}

	//{{{ isCompletionSelectable() method
	/**
	 * @deprecated
	 *   Do not return false from this method. Unselectable completion
	 *   is not useful.
	 */
	@Deprecated
	public boolean isCompletionSelectable(int index)
	{
		return true;
	} //}}}

	//{{{ updateInPlace() method
	/**
	 * @return If this returns false, then we create a new completion
	 * object after user input.
	 */
	public boolean updateInPlace(EditPane editPane, int caret)
	{
		return false;
	} //}}}
	
	//{{{ getRenderer() method
	public ListCellRenderer getRenderer()
	{
		return new DefaultListCellRenderer();
	} //}}}

	//{{{ insert() method
	public void insert(int index)
	{
		String selected = String.valueOf(get(index));
		int caret = textArea.getCaretPosition();
		Selection s = textArea.getSelectionAtOffset(caret);
		int start = (s == null ? caret : s.getStart());
		int end = (s == null ? caret : s.getEnd());
		JEditBuffer buffer = textArea.getBuffer();
		try
		{
			buffer.beginCompoundEdit();
			buffer.remove(start - text.length(),text.length());
			buffer.insert(start - text.length(),selected);
		}
		finally
		{
			buffer.endCompoundEdit();
		}
	} //}}}

	//{{{ getTokenLength() method
	/**
	 * The length of the text being completed (popup will be positioned there).
	 */
	public int getTokenLength()
	{
		return text.length();
	} //}}}

	//{{{ handleKeystroke() method
	/**
	 * @param selectedIndex The index of the selected completion.
	 * @param keyChar the character typed by the user.
	 * @return True if completion should continue, false otherwise.
	 * @since SideKick 0.3.2
	 */
	public boolean handleKeystroke(int selectedIndex, char keyChar)
	{
		// if(keyChar == '\t' || keyChar == '\n')
		if(SideKickActions.acceptChars.indexOf(keyChar) > -1)
		{
			insert(selectedIndex);
			if(SideKickActions.insertChars.indexOf(keyChar) > -1)
				textArea.userInput(keyChar);
			return false;
		}
		else
		{
			textArea.userInput(keyChar);
			return true;
		}
	} //}}}

	protected View view;
	protected JEditTextArea textArea;
	protected String text;
	protected List items = new ArrayList();
}