org.jdesktop.swingx.autocomplete
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.

Field Summary

protected Document	delegate
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)

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.

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

void	addDocumentListener(DocumentListener listener) Registers the given observer to begin receiving notifications when changes are made to the document.
void	addUndoableEditListener(UndoableEditListener listener) Registers the given observer to begin receiving notifications when undoable edits are made to the document.
protected Document	createDefaultDocument() Creates the default backing document when no delegate is passed to this document.
Position	createPosition(int offs) This method allows an application to mark a place in a sequence of character content.
Element	getDefaultRootElement() Returns the root element that views should be based upon, unless some other mechanism for assigning views to element structures is provided.
Position	getEndPosition() Returns a position that represents the end of the document.
int	getLength() Returns number of characters of content currently in the document.
Object	getProperty(Object key) Gets the properties associated with the document.
Element[]	getRootElements() Returns all of the root elements that are defined.
Position	getStartPosition() Returns a position that represents the start of the document.
String	getText(int offset, int length) Fetches the text contained within the given portion of the document.
void	getText(int offset, int length, Segment txt) Fetches the text contained within the given portion of the document.
void	insertString(int offs, String str, AttributeSet a) Inserts a string of content.
boolean	isStrictMatching() Returns if only items from the adaptor's list should be allowed to be entered.
void	putProperty(Object key, Object value) Associates a property with the document.
void	remove(int offs, int len) Removes a portion of the content of the document.
void	removeDocumentListener(DocumentListener listener) Unregisters the given observer from the notification list so it will no longer receive change updates.
void	removeUndoableEditListener(UndoableEditListener listener) Unregisters the given observer from the notification list so it will no longer receive updates.
void	render(Runnable r) Allows the model to be safely rendered in the presence of concurrency, if the model supports being updated asynchronously.

Methods inherited from class java.lang.Object

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

Field Detail

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

Constructor Detail

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:

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

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

Description copied from interface: javax.swing.text.Document

Removes a portion of the content of the document. This will cause a DocumentEvent of type DocumentEvent.EventType.REMOVE to be sent to the registered DocumentListeners, unless an exception is thrown. The notification will be sent to the listeners by calling the removeUpdate method on the DocumentListeners.

To ensure reasonable behavior in the face of concurrency, the event is dispatched after the mutation has occurred. This means that by the time a notification of removal is dispatched, the document has already been updated and any marks created by createPosition have already changed. For a removal, the end of the removal range is collapsed down to the start of the range, and any marks in the removal range are collapsed down to the start of the range.

If the Document structure changed as result of the removal, the details of what Elements were inserted and removed in response to the change will also be contained in the generated DocumentEvent. It is up to the implementation of a Document to decide how the structure should change in response to a remove.

If the Document supports undo/redo, an UndoableEditEvent will also be generated.

Specified by:

remove in interface Document

Parameters:

offs - the offset from the beginning >= 0

len - the number of characters to remove >= 0

Throws:

BadLocationException - some portion of the removal range was not a valid part of the document. The location in the exception is the first bad position encountered.

See Also:

DocumentEvent, DocumentListener, UndoableEditEvent, UndoableEditListener

insertString

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

Description copied from interface: javax.swing.text.Document

Inserts a string of content. This will cause a DocumentEvent of type DocumentEvent.EventType.INSERT to be sent to the registered DocumentListers, unless an exception is thrown. The DocumentEvent will be delivered by calling the insertUpdate method on the DocumentListener. The offset and length of the generated DocumentEvent will indicate what change was actually made to the Document.

If the Document structure changed as result of the insertion, the details of what Elements were inserted and removed in response to the change will also be contained in the generated DocumentEvent. It is up to the implementation of a Document to decide how the structure should change in response to an insertion.

If the Document supports undo/redo, an UndoableEditEvent will also be generated.

Specified by:

insertString in interface Document

Parameters:

offs - the offset into the document to insert the content >= 0. All positions that track change at or after the given location will move.

str - the string to insert

a - the attributes to associate with the inserted content. This may be null if there are no attributes.

Throws:

BadLocationException - the given insert position is not a valid position within the document

See Also:

DocumentEvent, DocumentListener, UndoableEditEvent, UndoableEditListener

addDocumentListener

public void addDocumentListener(DocumentListener listener)

Registers the given observer to begin receiving notifications when changes are made to the document.

Specified by:

addDocumentListener in interface Document

Parameters:

listener - the observer to register

See Also:

Document.removeDocumentListener(javax.swing.event.DocumentListener)

addUndoableEditListener

public void addUndoableEditListener(UndoableEditListener listener)

Registers the given observer to begin receiving notifications when undoable edits are made to the document.

Specified by:

addUndoableEditListener in interface Document

Parameters:

listener - the observer to register

See Also:

UndoableEditEvent

createPosition

public Position createPosition(int offs)
                        throws BadLocationException

This method allows an application to mark a place in a sequence of character content. This mark can then be used to tracks change as insertions and removals are made in the content. The policy is that insertions always occur prior to the current position (the most common case) unless the insertion location is zero, in which case the insertion is forced to a position that follows the original position.

Specified by:

createPosition in interface Document

Parameters:

offs - the offset from the start of the document >= 0

Returns:

the position

Throws:

BadLocationException - if the given position does not represent a valid location in the associated document

getDefaultRootElement

public Element getDefaultRootElement()

Returns the root element that views should be based upon, unless some other mechanism for assigning views to element structures is provided.

Specified by:

getDefaultRootElement in interface Document

Returns:

the root element

getEndPosition

public Position getEndPosition()

Returns a position that represents the end of the document. The position returned can be counted on to track change and stay located at the end of the document.

Specified by:

getEndPosition in interface Document

Returns:

the position

getLength

public int getLength()

Returns number of characters of content currently in the document.

Specified by:

getLength in interface Document

Returns:

number of characters >= 0

getProperty

public Object getProperty(Object key)

Gets the properties associated with the document.

Specified by:

getProperty in interface Document

Parameters:

key - a non-null property key

Returns:

the properties

See Also:

Document.putProperty(Object, Object)

getRootElements

public Element[] getRootElements()

Returns all of the root elements that are defined.

Typically there will be only one document structure, but the interface supports building an arbitrary number of structural projections over the text data. The document can have multiple root elements to support multiple document structures. Some examples might be:

• Text direction.
• Lexical token streams.
• Parse trees.
• Conversions to formats other than the native format.
• Modification specifications.
• Annotations.

Specified by:

getRootElements in interface Document

Returns:

the root element

getStartPosition

public Position getStartPosition()

Returns a position that represents the start of the document. The position returned can be counted on to track change and stay located at the beginning of the document.

Specified by:

getStartPosition in interface Document

Returns:

the position

getText

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

Fetches the text contained within the given portion of the document.

Specified by:

getText in interface Document

Parameters:

offset - the offset into the document representing the desired start of the text >= 0

length - the length of the desired string >= 0

Returns:

the text, in a String of length >= 0

Throws:

BadLocationException - some portion of the given range was not a valid part of the document. The location in the exception is the first bad position encountered.

getText

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

Fetches the text contained within the given portion of the document.

If the partialReturn property on the txt parameter is false, the data returned in the Segment will be the entire length requested and may or may not be a copy depending upon how the data was stored. If the partialReturn property is true, only the amount of text that can be returned without creating a copy is returned. Using partial returns will give better performance for situations where large parts of the document are being scanned. The following is an example of using the partial return to access the entire document:

   int nleft = doc.getDocumentLength();
   Segment text = new Segment();
   int offs = 0;
   text.setPartialReturn(true);   
   while (nleft > 0) {
       doc.getText(offs, nleft, text);
       // do someting with text
       nleft -= text.count;
       offs += text.count;
   }

 

Specified by:

getText in interface Document

Parameters:

offset - the offset into the document representing the desired start of the text >= 0

length - the length of the desired string >= 0

txt - the Segment object to return the text in

Throws:

BadLocationException - Some portion of the given range was not a valid part of the document. The location in the exception is the first bad position encountered.

putProperty

public void putProperty(Object key,
                        Object value)

Associates a property with the document. Two standard property keys provided are: StreamDescriptionProperty and TitleProperty. Other properties, such as author, may also be defined.

Specified by:

putProperty in interface Document

Parameters:

key - the non-null property key

value - the property value

See Also:

Document.getProperty(Object)

removeDocumentListener

public void removeDocumentListener(DocumentListener listener)

Unregisters the given observer from the notification list so it will no longer receive change updates.

Specified by:

removeDocumentListener in interface Document

Parameters:

listener - the observer to register

See Also:

Document.addDocumentListener(javax.swing.event.DocumentListener)

removeUndoableEditListener

public void removeUndoableEditListener(UndoableEditListener listener)

Unregisters the given observer from the notification list so it will no longer receive updates.

Specified by:

removeUndoableEditListener in interface Document

Parameters:

listener - the observer to register

See Also:

UndoableEditEvent

render

public void render(Runnable r)

Allows the model to be safely rendered in the presence of concurrency, if the model supports being updated asynchronously. The given runnable will be executed in a way that allows it to safely read the model with no changes while the runnable is being executed. The runnable itself may not make any mutations.

Specified by:

render in interface Document

Parameters:

r - a Runnable used to render the model

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