com.fr.design.gui.autocomplete

类 DefaultCompletionProvider

java.lang.Object

com.fr.design.gui.autocomplete.CompletionProviderBase

com.fr.design.gui.autocomplete.AbstractCompletionProvider

com.fr.design.gui.autocomplete.DefaultCompletionProvider

所有已实现的接口:

CompletionProvider

public class DefaultCompletionProvider
extends AbstractCompletionProvider

A basic completion provider implementation. This provider has no understanding of language semantics. It simply checks the text entered up to the caret position for a match against known completions. This is all that is needed in the majority of cases.

版本:

1.0

作者:

Robert Futrell

嵌套类概要

从类继承的嵌套类/接口 com.fr.design.gui.autocomplete.AbstractCompletionProvider

AbstractCompletionProvider.CaseInsensitiveComparator

字段概要

字段

限定符和类型	字段和说明
protected javax.swing.text.Segment	seg

从类继承的字段 com.fr.design.gui.autocomplete.AbstractCompletionProvider

comparator, completions

从类继承的字段 com.fr.design.gui.autocomplete.CompletionProviderBase

EMPTY_STRING

构造器概要

构造器

构造器和说明
DefaultCompletionProvider() Constructor.
DefaultCompletionProvider(java.lang.String[] words) Creates a completion provider that provides completion for a simple list of words.

方法概要

方法

限定符和类型	方法和说明
java.lang.String	getAlreadyEnteredText(javax.swing.text.JTextComponent comp) Returns the text just before the current caret position that could be the start of something auto-completable.
java.util.List<Completion>	getCompletionsAt(javax.swing.text.JTextComponent tc, java.awt.Point p) Returns the completions that have been entered at the specified visual location.
java.util.List<ParameterizedCompletion>	getParameterizedCompletions(javax.swing.text.JTextComponent tc) Returns a list of parameterized completions that have been entered at the current caret position of a text component (and thus can have their completion choices displayed).
protected void	init() Initializes this completion provider.
protected boolean	isValidChar(char ch) Returns whether the specified character is valid in an auto-completion.
void	loadFromXML(java.io.File file) Loads completions from an XML file.
void	loadFromXML(java.io.InputStream in) Loads completions from an XML input stream.
void	loadFromXML(java.io.InputStream in, java.lang.ClassLoader cl) Loads completions from an XML input stream.
void	loadFromXML(java.lang.String resource) Loads completions from an XML file.

从类继承的方法 com.fr.design.gui.autocomplete.AbstractCompletionProvider

addCompletion, addCompletions, addWordCompletions, checkProviderAndAdd, clear, getCompletionByInputText, getCompletionsImpl, removeCompletion

从类继承的方法 com.fr.design.gui.autocomplete.CompletionProviderBase

clearParameterizedCompletionParams, getCompletions, getListCellRenderer, getParameterChoicesProvider, getParameterListEnd, getParameterListSeparator, getParameterListStart, getParent, isAutoActivateOkay, setAutoActivationRules, setListCellRenderer, setParameterChoicesProvider, setParameterizedCompletionParams, setParent

从类继承的方法 java.lang.Object

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

字段详细资料

seg

protected javax.swing.text.Segment seg

构造器详细资料

DefaultCompletionProvider

public DefaultCompletionProvider()

Constructor. The returned provider will not be aware of any completions.

另请参阅:

AbstractCompletionProvider.addCompletion(Completion)

DefaultCompletionProvider

public DefaultCompletionProvider(java.lang.String[] words)

Creates a completion provider that provides completion for a simple list of words.

参数:

words - The words to offer as completion suggestions. If this is null, no completions will be known.

另请参阅:

BasicCompletion

方法详细资料

getAlreadyEnteredText

public java.lang.String getAlreadyEnteredText(javax.swing.text.JTextComponent comp)

Returns the text just before the current caret position that could be the start of something auto-completable.

This method returns all characters before the caret that are matched by isValidChar(char). Returns the text just before the current caret position that could be the start of something auto-completable.

参数:

comp - The text component.

返回:

The text. A return value of null means nothing should be auto-completed; a value of an empty string ("") means auto-completion should still be considered (i.e., all possible choices are valid).

getCompletionsAt

public java.util.List<Completion> getCompletionsAt(javax.swing.text.JTextComponent tc,
                                          java.awt.Point p)

Returns the completions that have been entered at the specified visual location. This can be used for tool tips when the user hovers the mouse over completed text.

参数:

tc - The text component.

p - The position, usually from a MouseEvent.

返回:

The completions, or an empty list if there are none.

getParameterizedCompletions

public java.util.List<ParameterizedCompletion> getParameterizedCompletions(javax.swing.text.JTextComponent tc)

Returns a list of parameterized completions that have been entered at the current caret position of a text component (and thus can have their completion choices displayed).

参数:

tc - The text component.

返回:

The list of ParameterizedCompletions. If no completions are available, this may be null.

init

protected void init()

Initializes this completion provider.

isValidChar

protected boolean isValidChar(char ch)

Returns whether the specified character is valid in an auto-completion. The default implementation is equivalent to "Character.isLetterOrDigit(ch) || ch=='_'". Subclasses can override this method to change what characters are matched.

参数:

ch - The character.

返回:

Whether the character is valid.

loadFromXML

public void loadFromXML(java.io.File file)
                 throws java.io.IOException

Loads completions from an XML file. The XML should validate against CompletionXml.dtd.

参数:

file - An XML file to load from.

抛出:

java.io.IOException - If an IO error occurs.

loadFromXML

public void loadFromXML(java.io.InputStream in)
                 throws java.io.IOException

Loads completions from an XML input stream. The XML should validate against CompletionXml.dtd.

参数:

in - The input stream to read from.

抛出:

java.io.IOException - If an IO error occurs.

loadFromXML

public void loadFromXML(java.io.InputStream in,
               java.lang.ClassLoader cl)
                 throws java.io.IOException

Loads completions from an XML input stream. The XML should validate against CompletionXml.dtd.

参数:

in - The input stream to read from.

cl - The class loader to use when loading any extra classes defined in the XML, such as custom FunctionCompletions. This may be null if the default is to be used, or if no custom completions are defined in the XML.

抛出:

java.io.IOException - If an IO error occurs.

loadFromXML

public void loadFromXML(java.lang.String resource)
                 throws java.io.IOException

Loads completions from an XML file. The XML should validate against CompletionXml.dtd.

参数:

resource - A resource the current ClassLoader can get to.

抛出:

java.io.IOException - If an IO error occurs.