Package org.jdesktop.swingx.autocomplete
Class AutoCompleteDocument
java.lang.Object
org.jdesktop.swingx.autocomplete.AutoCompleteDocument
- All Implemented Interfaces:
Document
- Direct Known Subclasses:
AutoCompleteStyledDocument
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.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final Document
protected boolean
true, if only items from the adaptors's list can be entered false, otherwise (selected item might not be in the adaptors's list)Fields inherited from interface javax.swing.text.Document
StreamDescriptionProperty, TitleProperty
-
Constructor Summary
ConstructorsConstructorDescriptionAutoCompleteDocument
(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 TypeMethodDescriptionvoid
addDocumentListener
(DocumentListener listener) void
addUndoableEditListener
(UndoableEditListener listener) protected Document
Creates the default backing document when no delegate is passed to this document.createPosition
(int offs) int
getProperty
(Object key) Element[]
getText
(int offset, int length) void
void
insertString
(int offs, String str, AttributeSet a) boolean
Returns if only items from the adaptor's list should be allowed to be entered.void
putProperty
(Object key, Object value) void
remove
(int offs, int len) void
removeDocumentListener
(DocumentListener listener) void
void
-
Field Details
-
strictMatching
protected boolean strictMatchingtrue, if only items from the adaptors's list can be entered false, otherwise (selected item might not be in the adaptors's list) -
delegate
-
-
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 enteredstringConverter
- the converter used to transform items to stringsdelegate
- theDocument
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 enteredstringConverter
- the converter used to transform items to strings
-
AutoCompleteDocument
Creates a new AutoCompleteDocument for the given AbstractAutoCompleteAdaptor.- Parameters:
strictMatching
- true, if only items from the adaptor's list should be allowed to be enteredadaptor
- The adaptor that will be used to find and select matching items.
-
-
Method Details
-
createDefaultDocument
Creates the default backing document when no delegate is passed to this document.- Returns:
- the default backing document
-
remove
- Specified by:
remove
in interfaceDocument
- Throws:
BadLocationException
-
insertString
- Specified by:
insertString
in interfaceDocument
- Throws:
BadLocationException
-
addDocumentListener
- Specified by:
addDocumentListener
in interfaceDocument
-
addUndoableEditListener
- Specified by:
addUndoableEditListener
in interfaceDocument
-
createPosition
- Specified by:
createPosition
in interfaceDocument
- Throws:
BadLocationException
-
getDefaultRootElement
- Specified by:
getDefaultRootElement
in interfaceDocument
-
getEndPosition
- Specified by:
getEndPosition
in interfaceDocument
-
getLength
public int getLength() -
getProperty
- Specified by:
getProperty
in interfaceDocument
-
getRootElements
- Specified by:
getRootElements
in interfaceDocument
-
getStartPosition
- Specified by:
getStartPosition
in interfaceDocument
-
getText
- Specified by:
getText
in interfaceDocument
- Throws:
BadLocationException
-
getText
- Specified by:
getText
in interfaceDocument
- Throws:
BadLocationException
-
putProperty
- Specified by:
putProperty
in interfaceDocument
-
removeDocumentListener
- Specified by:
removeDocumentListener
in interfaceDocument
-
removeUndoableEditListener
- Specified by:
removeUndoableEditListener
in interfaceDocument
-
render
-
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
-