Class AutoCompleteDocument

java.lang.Object

org.jdesktop.swingx.autocomplete.AutoCompleteDocument

All Implemented Interfaces:

Document

Direct Known Subclasses:

AutoCompleteStyledDocument

public class AutoCompleteDocument
extends Object
implements Document

A document that can be plugged into any JTextComponent to enable automatic completion. It finds and selects matching items using any implementation of the AbstractAutoCompleteAdaptor.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	AutoCompleteDocument.Handler
private static class	AutoCompleteDocument.LookupResult

Field Summary

Fields

Modifier and Type	Field	Description
(package private) AbstractAutoCompleteAdaptor	adaptor	The adaptor that is used to find and select items.
protected final Document	delegate
private static final Comparator<String>	EQUALS
private static final Comparator<String>	EQUALS_IGNORE_CASE
private final AutoCompleteDocument.Handler	handler
(package private) boolean	selecting	Flag to indicate if adaptor.setSelectedItem has been called.
private static final Comparator<String>	STARTS_WITH
private static final Comparator<String>	STARTS_WITH_IGNORE_CASE
protected boolean	strictMatching	true, if only items from the adaptors's list can be entered false, otherwise (selected item might not be in the adaptors's list)
(package private) ObjectToStringConverter	stringConverter

Fields inherited from interface Document

StreamDescriptionProperty, TitleProperty

Constructor Summary

Constructors

Constructor	Description
AutoCompleteDocument(AbstractAutoCompleteAdaptor adaptor, boolean strictMatching)	Creates a new AutoCompleteDocument for the given AbstractAutoCompleteAdaptor.
AutoCompleteDocument(AbstractAutoCompleteAdaptor adaptor, boolean strictMatching, ObjectToStringConverter stringConverter)	Creates a new AutoCompleteDocument for the given AbstractAutoCompleteAdaptor.
AutoCompleteDocument(AbstractAutoCompleteAdaptor adaptor, boolean strictMatching, ObjectToStringConverter stringConverter, Document delegate)	Creates a new AutoCompleteDocument for the given AbstractAutoCompleteAdaptor.

Method Summary

Modifier and Type	Method	Description
void	addDocumentListener(DocumentListener listener)
void	addUndoableEditListener(UndoableEditListener listener)
protected Document	createDefaultDocument()	Creates the default backing document when no delegate is passed to this document.
Position	createPosition(int offs)
Element	getDefaultRootElement()
Position	getEndPosition()
int	getLength()
Object	getProperty(Object key)
Element[]	getRootElements()
Position	getStartPosition()
String	getText(int offset, int length)
void	getText(int offset, int length, Segment txt)
void	insertString(int offs, String str, AttributeSet a)
boolean	isStrictMatching()	Returns if only items from the adaptor's list should be allowed to be entered.
private AutoCompleteDocument.LookupResult	lookupItem(String pattern)	Searches for an item that matches the given pattern.
private AutoCompleteDocument.LookupResult	lookupItem(String pattern, Comparator<String> comparator)
private AutoCompleteDocument.LookupResult	lookupOneItem(Object item, String pattern, Comparator<String> comparator)
void	putProperty(Object key, Object value)
void	remove(int offs, int len)
void	removeDocumentListener(DocumentListener listener)
void	removeUndoableEditListener(UndoableEditListener listener)
void	render(Runnable r)
private void	setSelectedItem(Object item, String itemAsString)	Selects the given item using the AbstractAutoCompleteAdaptor.
private void	setText(String text)	Sets the text of this AutoCompleteDocument to the given text.

Methods inherited from class Object

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

Field Details

strictMatching

protected boolean strictMatching

true, if only items from the adaptors's list can be entered false, otherwise (selected item might not be in the adaptors's list)

delegate

protected final Document delegate

selecting

boolean selecting

Flag to indicate if adaptor.setSelectedItem has been called. Subsequent calls to remove/insertString should be ignored as they are likely have been caused by the adapted Component that is trying to set the text for the selected component.

adaptor

AbstractAutoCompleteAdaptor adaptor

The adaptor that is used to find and select items.

stringConverter

ObjectToStringConverter stringConverter

handler

private final AutoCompleteDocument.Handler handler

EQUALS_IGNORE_CASE

private static final Comparator<String> EQUALS_IGNORE_CASE

STARTS_WITH_IGNORE_CASE

private static final Comparator<String> STARTS_WITH_IGNORE_CASE

EQUALS

private static final Comparator<String> EQUALS

STARTS_WITH

private static final Comparator<String> STARTS_WITH

Constructor Details

AutoCompleteDocument

public AutoCompleteDocument(AbstractAutoCompleteAdaptor adaptor,
 boolean strictMatching,
 ObjectToStringConverter stringConverter,
 Document delegate)

Creates a new AutoCompleteDocument for the given AbstractAutoCompleteAdaptor.

Parameters:

adaptor - The adaptor that will be used to find and select matching items.

strictMatching - true, if only items from the adaptor's list should be allowed to be entered

stringConverter - the converter used to transform items to strings

delegate - the Document delegate backing this document

AutoCompleteDocument

public AutoCompleteDocument(AbstractAutoCompleteAdaptor adaptor,
 boolean strictMatching,
 ObjectToStringConverter stringConverter)

Creates a new AutoCompleteDocument for the given AbstractAutoCompleteAdaptor.

Parameters:

adaptor - The adaptor that will be used to find and select matching items.

strictMatching - true, if only items from the adaptor's list should be allowed to be entered

stringConverter - the converter used to transform items to strings

AutoCompleteDocument

public AutoCompleteDocument(AbstractAutoCompleteAdaptor adaptor,
 boolean strictMatching)

Creates a new AutoCompleteDocument for the given AbstractAutoCompleteAdaptor.

Parameters:

adaptor - The adaptor that will be used to find and select matching items.

strictMatching - true, if only items from the adaptor's list should be allowed to be entered

Method Details

createDefaultDocument

protected Document createDefaultDocument()

Creates the default backing document when no delegate is passed to this document.

Returns:

the default backing document

remove

public void remove(int offs,
 int len)
            throws BadLocationException

Specified by:

remove in interface Document

Throws:

BadLocationException

insertString

public void insertString(int offs,
 String str,
 AttributeSet a)
                  throws BadLocationException

Specified by:

insertString in interface Document

Throws:

BadLocationException

setText

private void setText(String text)

Sets the text of this AutoCompleteDocument to the given text.

Parameters:

text - the text that will be set for this document

setSelectedItem

private void setSelectedItem(Object item,
 String itemAsString)

Selects the given item using the AbstractAutoCompleteAdaptor.

Parameters:

item - the item that is to be selected

itemAsString - string representation of the item to be selected

lookupItem

private AutoCompleteDocument.LookupResult lookupItem(String pattern)

Searches for an item that matches the given pattern. The AbstractAutoCompleteAdaptor is used to access the candidate items. The match is not case-sensitive and will only match at the beginning of each item's string representation.

Parameters:

pattern - the pattern that should be matched

Returns:

the first item that matches the pattern or null if no item matches

lookupOneItem

private AutoCompleteDocument.LookupResult lookupOneItem(Object item,
 String pattern,
 Comparator<String> comparator)

lookupItem

private AutoCompleteDocument.LookupResult lookupItem(String pattern,
 Comparator<String> comparator)

addDocumentListener

public void addDocumentListener(DocumentListener listener)

Specified by:

addDocumentListener in interface Document

addUndoableEditListener

public void addUndoableEditListener(UndoableEditListener listener)

Specified by:

addUndoableEditListener in interface Document

createPosition

public Position createPosition(int offs)
                        throws BadLocationException

Specified by:

createPosition in interface Document

Throws:

BadLocationException

getDefaultRootElement

public Element getDefaultRootElement()

Specified by:

getDefaultRootElement in interface Document

getEndPosition

public Position getEndPosition()

Specified by:

getEndPosition in interface Document

getLength

public int getLength()

Specified by:

getLength in interface Document

getProperty

public Object getProperty(Object key)

Specified by:

getProperty in interface Document

getRootElements

public Element[] getRootElements()

Specified by:

getRootElements in interface Document

getStartPosition

public Position getStartPosition()

Specified by:

getStartPosition in interface Document

getText

public String getText(int offset,
 int length)
               throws BadLocationException

Specified by:

getText in interface Document

Throws:

BadLocationException

getText

public void getText(int offset,
 int length,
 Segment txt)
             throws BadLocationException

Specified by:

getText in interface Document

Throws:

BadLocationException

putProperty

public void putProperty(Object key,
 Object value)

Specified by:

putProperty in interface Document

removeDocumentListener

public void removeDocumentListener(DocumentListener listener)

Specified by:

removeDocumentListener in interface Document

removeUndoableEditListener

public void removeUndoableEditListener(UndoableEditListener listener)

Specified by:

removeUndoableEditListener in interface Document

render

public void render(Runnable r)

Specified by:

render in interface Document

isStrictMatching

public boolean isStrictMatching()

Returns if only items from the adaptor's list should be allowed to be entered.

Returns:

if only items from the adaptor's list should be allowed to be entered