org.jdesktop.swingx.autocomplete
Class AutoCompleteDocument

java.lang.Object
  javax.swing.text.AbstractDocument
      javax.swing.text.PlainDocument
          org.jdesktop.swingx.autocomplete.AutoCompleteDocument

All Implemented Interfaces:

Serializable, Document

public class AutoCompleteDocument
extends PlainDocument

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.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.text.AbstractDocument

AbstractDocument.AbstractElement, AbstractDocument.AttributeContext, AbstractDocument.BranchElement, AbstractDocument.Content, AbstractDocument.DefaultDocumentEvent, AbstractDocument.ElementEdit, AbstractDocument.LeafElement

Field Summary

Fields inherited from class javax.swing.text.PlainDocument

lineLimitAttribute, tabSizeAttribute

Fields inherited from class javax.swing.text.AbstractDocument

BAD_LOCATION, BidiElementName, ContentElementName, ElementNameAttribute, listenerList, ParagraphElementName, SectionElementName

Fields inherited from interface javax.swing.text.Document

StreamDescriptionProperty, TitleProperty

Constructor Summary

AutoCompleteDocument(AbstractAutoCompleteAdaptor adaptor, boolean strictMatching)
Creates a new AutoCompleteDocument for the given AbstractAutoCompleteAdaptor.

Method Summary

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.
void	remove(int offs, int len)

Methods inherited from class javax.swing.text.PlainDocument

createDefaultRoot, getDefaultRootElement, getParagraphElement, insertUpdate, removeUpdate

Methods inherited from class javax.swing.text.AbstractDocument

addDocumentListener, addUndoableEditListener, createBranchElement, createLeafElement, createPosition, dump, fireChangedUpdate, fireInsertUpdate, fireRemoveUpdate, fireUndoableEditUpdate, getAsynchronousLoadPriority, getAttributeContext, getBidiRootElement, getContent, getCurrentWriter, getDocumentFilter, getDocumentListeners, getDocumentProperties, getEndPosition, getLength, getListeners, getProperty, getRootElements, getStartPosition, getText, getText, getUndoableEditListeners, postRemoveUpdate, putProperty, readLock, readUnlock, removeDocumentListener, removeUndoableEditListener, render, replace, setAsynchronousLoadPriority, setDocumentFilter, setDocumentProperties, writeLock, writeUnlock

Methods inherited from class java.lang.Object

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

Constructor Detail

AutoCompleteDocument

public AutoCompleteDocument(AbstractAutoCompleteAdaptor adaptor,
                            boolean strictMatching)

Creates a new AutoCompleteDocument for the given AbstractAutoCompleteAdaptor.

Parameters:

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

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

Method Detail

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

remove

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

Specified by:

remove in interface Document

Overrides:

remove in class AbstractDocument

Throws:

BadLocationException

insertString

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

Specified by:

insertString in interface Document

Overrides:

insertString in class PlainDocument

Throws:

BadLocationException