com.xmlmind.guiutil

Class AutoCompletion

java.lang.Object

com.xmlmind.guiutil.AutoCompletion

All Implemented Interfaces:

ActionListener, ComponentListener, FocusListener, HierarchyBoundsListener, KeyListener, Runnable, EventListener, DocumentListener

public final class AutoCompletion
extends Object
implements FocusListener, ComponentListener, HierarchyBoundsListener, DocumentListener, KeyListener, ActionListener, Runnable

Attach an auto-completion facility to an existing JTextField and optionally also to an existing JList.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AutoCompletion.AppendMode
static class	AutoCompletion.AutoSuggest
static class	AutoCompletion.ChoiceList The list of all possible choices given the ``prefix'' typed by the user.
static class	AutoCompletion.ChoiceRenderer A kind of ListCellRenderer which is capable of properly rendering AutoCompletion.PossibleChoice.
static interface	AutoCompletion.Choices Computes the list of all possible choices given the ``prefix'' typed by the user.
static class	AutoCompletion.ChoicesBase A possible base class for the classes implementing AutoCompletion.Choices.
static class	AutoCompletion.MinimalChoices A simple implementation where the computation of AutoCompletion.ChoiceList depends on the prefix typed by the user in the text field.
static class	AutoCompletion.NoChoices Dummy implementation of choices which never finds any possible choice whatever the specified prefix.
static interface	AutoCompletion.PossibleChoice A choice which can be disabled (that is, grayed).
static class	AutoCompletion.ProgressTextField Use this kind of text field rather than the stock JTextField if you need to support AutoCompletion.SlowChoices.
static interface	AutoCompletion.RichChoice A choice which can have a description and a location.
static class	AutoCompletion.RichChoiceRenderer A kind of ListCellRenderer which is capable of properly rendering AutoCompletion.PossibleChoice and/or AutoCompletion.RichChoice.
static class	AutoCompletion.SimpleChoices A simple implementation where the computation of AutoCompletion.ChoiceList does not depend on the prefix typed by the user in the text field.
static interface	AutoCompletion.SlowChoices Similar to AutoCompletion.Choices, but the computation of the AutoCompletion.ChoiceList is slow and as such, may invoke a ProgressMonitor.

Field Summary

Fields

Modifier and Type	Field and Description
static AutoCompletion.ChoiceRenderer	CHOICE_RENDERER
static AWTKeyStroke[]	KEY_STROKES1 An array containing the Ctrl-SPACE key stroke.
static AWTKeyStroke[]	KEY_STROKES2 An array containing the Ctrl-SPACE and SPACE key strokes.
static AutoCompletion.NoChoices	NO_CHOICES A ready to use instance of NoChoices.
static AutoCompletion.RichChoiceRenderer	RICH_CHOICE_RENDERER

Constructor Summary

Constructors

Constructor and Description
AutoCompletion()
AutoCompletion(JTextField textField)

Method Summary

Modifier and Type	Method and Description
String	acceptEntry()
void	actionPerformed(ActionEvent e)
void	ancestorMoved(HierarchyEvent e)
void	ancestorResized(HierarchyEvent e)
void	changedUpdate(DocumentEvent e)
void	componentHidden(ComponentEvent e)
void	componentMoved(ComponentEvent e)
void	componentResized(ComponentEvent e)
void	componentShown(ComponentEvent e)
static void	ensureIndexIsVisible(JList<Object> list, int index)
void	focusGained(FocusEvent e)
void	focusLost(FocusEvent e)
AWTKeyStroke[]	getAppendKeyStrokes()
AutoCompletion.AppendMode	getAppendMode()
boolean	getAppendOnAccept()
AutoCompletion.AutoSuggest	getAutoSuggest()
AutoCompletion.Choices	getChoices()
static AWTKeyStroke[]	getDefaultAppendKeyStrokes()
static AutoCompletion.AppendMode	getDefaultAppendMode()
static AutoCompletion.AutoSuggest	getDefaultAutoSuggest()
static int	getDefaultVisibleSuggestionCount()
JList<Object>	getList()
static boolean	getPreferMinimalChoices()
JTextField	getTextField()
int	getVisibleSuggestionCount()
void	insertUpdate(DocumentEvent e)
void	keyPressed(KeyEvent e)
void	keyReleased(KeyEvent e)
void	keyTyped(KeyEvent e)
void	listChoices(String prefix, AutoCompletion.ChoiceList choiceList)
static void	minimalChoiceList(Object[] items, String prefix, AutoCompletion.ChoiceList choiceList) Updates specified choice list for a AutoCompletion.MinimalChoices.
void	removeUpdate(DocumentEvent e)
void	run()
void	setAppendKeyStrokes(AWTKeyStroke[] keyStrokes)
void	setAppendMode(AutoCompletion.AppendMode appendMode)
void	setAppendOnAccept(boolean append)
void	setAutoSuggest(AutoCompletion.AutoSuggest autoSuggest)
void	setChoices(AutoCompletion.Choices choices)
static void	setDefaultAppendKeyStrokes(AWTKeyStroke[] keyStrokes)
static void	setDefaultAppendMode(AutoCompletion.AppendMode appendMode)
static void	setDefaultAutoSuggest(AutoCompletion.AutoSuggest autoSuggest)
static void	setDefaultVisibleSuggestionCount(int count)
void	setEntry(String text) Changes the text contained in the JTextField to which this auto-completion facility is attached.
void	setList(JList<Object> list) Specifies the JList created by the client code which is to be controlled by this auto-completion facility.
static void	setPreferMinimalChoices(boolean prefer)
void	setTextField(JTextField textField)
void	setVisibleSuggestionCount(int count)
static void	simpleChoiceList(Object[] items, String prefix, AutoCompletion.ChoiceList choiceList) Updates specified choice list for a AutoCompletion.SimpleChoices.
void	suggest()
static String	toString(Object object) Utility function: returns the string value of specified object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NO_CHOICES

public static final AutoCompletion.NoChoices NO_CHOICES

A ready to use instance of NoChoices.

CHOICE_RENDERER

public static final AutoCompletion.ChoiceRenderer CHOICE_RENDERER

RICH_CHOICE_RENDERER

public static final AutoCompletion.RichChoiceRenderer RICH_CHOICE_RENDERER

KEY_STROKES1

public static final AWTKeyStroke[] KEY_STROKES1

An array containing the Ctrl-SPACE key stroke. Useful when configuring auto-completion using setAppendKeyStrokes(java.awt.AWTKeyStroke[]).

See Also:

KEY_STROKES2

KEY_STROKES2

public static final AWTKeyStroke[] KEY_STROKES2

An array containing the Ctrl-SPACE and SPACE key strokes. Useful when configuring auto-completion using setAppendKeyStrokes(java.awt.AWTKeyStroke[]).

See Also:

KEY_STROKES1

Constructor Detail

AutoCompletion

public AutoCompletion()

AutoCompletion

public AutoCompletion(JTextField textField)

Method Detail

toString

public static final String toString(Object object)

Utility function: returns the string value of specified object. If specified object is null or is a ``disabled'' AutoCompletion.PossibleChoice, returns null.

simpleChoiceList

public static void simpleChoiceList(Object[] items,
                                    String prefix,
                                    AutoCompletion.ChoiceList choiceList)

Updates specified choice list for a AutoCompletion.SimpleChoices.

minimalChoiceList

public static void minimalChoiceList(Object[] items,
                                     String prefix,
                                     AutoCompletion.ChoiceList choiceList)

Updates specified choice list for a AutoCompletion.MinimalChoices.

setPreferMinimalChoices

public static void setPreferMinimalChoices(boolean prefer)

getPreferMinimalChoices

public static boolean getPreferMinimalChoices()

setDefaultAutoSuggest

public static void setDefaultAutoSuggest(AutoCompletion.AutoSuggest autoSuggest)

getDefaultAutoSuggest

public static AutoCompletion.AutoSuggest getDefaultAutoSuggest()

setDefaultAppendMode

public static void setDefaultAppendMode(AutoCompletion.AppendMode appendMode)

getDefaultAppendMode

public static AutoCompletion.AppendMode getDefaultAppendMode()

setDefaultAppendKeyStrokes

public static void setDefaultAppendKeyStrokes(AWTKeyStroke[] keyStrokes)

getDefaultAppendKeyStrokes

public static AWTKeyStroke[] getDefaultAppendKeyStrokes()

setDefaultVisibleSuggestionCount

public static void setDefaultVisibleSuggestionCount(int count)

getDefaultVisibleSuggestionCount

public static int getDefaultVisibleSuggestionCount()

setTextField

public void setTextField(JTextField textField)

getTextField

public JTextField getTextField()

ensureIndexIsVisible

public static final void ensureIndexIsVisible(JList<Object> list,
                                              int index)

setList

public void setList(JList<Object> list)

Specifies the JList created by the client code which is to be controlled by this auto-completion facility. The JList or JScrollPane containing the JList must not be focusable.

Parameters:

list - the JList which is to be controlled by this auto-completion facility. May be null in which case this facility creates its own JList (contained in a popup window).

getList

public JList<Object> getList()

setChoices

public void setChoices(AutoCompletion.Choices choices)

getChoices

public AutoCompletion.Choices getChoices()

listChoices

public void listChoices(String prefix,
                        AutoCompletion.ChoiceList choiceList)

setAutoSuggest

public void setAutoSuggest(AutoCompletion.AutoSuggest autoSuggest)

getAutoSuggest

public AutoCompletion.AutoSuggest getAutoSuggest()

setAppendMode

public void setAppendMode(AutoCompletion.AppendMode appendMode)

getAppendMode

public AutoCompletion.AppendMode getAppendMode()

setAppendKeyStrokes

public void setAppendKeyStrokes(AWTKeyStroke[] keyStrokes)

getAppendKeyStrokes

public AWTKeyStroke[] getAppendKeyStrokes()

setVisibleSuggestionCount

public void setVisibleSuggestionCount(int count)

getVisibleSuggestionCount

public int getVisibleSuggestionCount()

setAppendOnAccept

public void setAppendOnAccept(boolean append)

getAppendOnAccept

public boolean getAppendOnAccept()

setEntry

public void setEntry(String text)

Changes the text contained in the JTextField to which this auto-completion facility is attached.

Use this method rather than JTextField.setText(text), for example in a MouseListener, when the JList has been created by the client code.

acceptEntry

public String acceptEntry()

actionPerformed

public void actionPerformed(ActionEvent e)

Specified by:

actionPerformed in interface ActionListener

focusLost

public void focusLost(FocusEvent e)

Specified by:

focusLost in interface FocusListener

focusGained

public void focusGained(FocusEvent e)

Specified by:

focusGained in interface FocusListener

componentResized

public void componentResized(ComponentEvent e)

Specified by:

componentResized in interface ComponentListener

componentMoved

public void componentMoved(ComponentEvent e)

Specified by:

componentMoved in interface ComponentListener

componentShown

public void componentShown(ComponentEvent e)

Specified by:

componentShown in interface ComponentListener

componentHidden

public void componentHidden(ComponentEvent e)

Specified by:

componentHidden in interface ComponentListener

ancestorMoved

public void ancestorMoved(HierarchyEvent e)

Specified by:

ancestorMoved in interface HierarchyBoundsListener

ancestorResized

public void ancestorResized(HierarchyEvent e)

Specified by:

ancestorResized in interface HierarchyBoundsListener

insertUpdate

public void insertUpdate(DocumentEvent e)

Specified by:

insertUpdate in interface DocumentListener

removeUpdate

public void removeUpdate(DocumentEvent e)

Specified by:

removeUpdate in interface DocumentListener

changedUpdate

public void changedUpdate(DocumentEvent e)

Specified by:

changedUpdate in interface DocumentListener

suggest

public void suggest()

keyPressed

public void keyPressed(KeyEvent e)

Specified by:

keyPressed in interface KeyListener

keyReleased

public void keyReleased(KeyEvent e)

Specified by:

keyReleased in interface KeyListener

keyTyped

public void keyTyped(KeyEvent e)

Specified by:

keyTyped in interface KeyListener

run

public void run()

Specified by:

run in interface Runnable