com.fr.design.gui.autocomplete

类 AbstractCompletionProvider

java.lang.Object

com.fr.design.gui.autocomplete.CompletionProviderBase

com.fr.design.gui.autocomplete.AbstractCompletionProvider

所有已实现的接口:

CompletionProvider

直接已知子类:

DefaultCompletionProvider

public abstract class AbstractCompletionProvider
extends CompletionProviderBase

A base class for completion providers. Completions are kept in a sorted list. To get the list of completions that match a given input, a binary search is done to find the first matching completion, then all succeeding completions that also match are also returned.

版本:

1.0

作者:

Robert Futrell

嵌套类概要

嵌套类

限定符和类型	类和说明
protected static class	AbstractCompletionProvider.CaseInsensitiveComparator A comparator that compares the input text of a Completion against a String lexicographically, ignoring case.

字段概要

字段

限定符和类型	字段和说明
protected AbstractCompletionProvider.CaseInsensitiveComparator	comparator Compares a Completion against a String.
protected java.util.List<Completion>	completions The completions this provider is aware of.

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

EMPTY_STRING

构造器概要

构造器

构造器和说明
AbstractCompletionProvider() Constructor.

方法概要

方法

限定符和类型	方法和说明
void	addCompletion(Completion c) Adds a single completion to this provider.
void	addCompletions(java.util.List<Completion> completions) Adds Completions to this provider.
protected void	addWordCompletions(java.lang.String[] words) Adds simple completions for a list of words.
protected void	checkProviderAndAdd(Completion c)
void	clear() Removes all completions from this provider.
java.util.List<Completion>	getCompletionByInputText(java.lang.String inputText) Returns a list of Completions in this provider with the specified input text.
protected java.util.List<Completion>	getCompletionsImpl(javax.swing.text.JTextComponent comp) Does the dirty work of creating a list of completions.
boolean	removeCompletion(Completion c) Removes the specified completion from this provider.

从类继承的方法 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

从接口继承的方法 com.fr.design.gui.autocomplete.CompletionProvider

getAlreadyEnteredText, getCompletionsAt, getParameterizedCompletions

字段详细资料

completions

protected java.util.List<Completion> completions

The completions this provider is aware of. Subclasses should ensure that this list is sorted alphabetically (case-insensitively).

comparator

protected AbstractCompletionProvider.CaseInsensitiveComparator comparator

Compares a Completion against a String.

构造器详细资料

AbstractCompletionProvider

public AbstractCompletionProvider()

Constructor.

方法详细资料

addCompletion

public void addCompletion(Completion c)

Adds a single completion to this provider. If you are adding multiple completions to this provider, for efficiency reasons please consider using addCompletions(List) instead.

参数:

c - The completion to add.

抛出:

java.lang.IllegalArgumentException - If the completion's provider isn't this CompletionProvider.

另请参阅:

addCompletions(List), removeCompletion(Completion), clear()

addCompletions

public void addCompletions(java.util.List<Completion> completions)

Adds Completions to this provider.

参数:

completions - The completions to add. This cannot be null.

抛出:

java.lang.IllegalArgumentException - If a completion's provider isn't this CompletionProvider.

另请参阅:

addCompletion(Completion), removeCompletion(Completion), clear()

addWordCompletions

protected void addWordCompletions(java.lang.String[] words)

Adds simple completions for a list of words.

参数:

words - The words.

另请参阅:

BasicCompletion

checkProviderAndAdd

protected void checkProviderAndAdd(Completion c)

clear

public void clear()

Removes all completions from this provider. This does not affect the parent CompletionProvider, if there is one.

另请参阅:

addCompletion(Completion), addCompletions(List), removeCompletion(Completion)

getCompletionByInputText

public java.util.List<Completion> getCompletionByInputText(java.lang.String inputText)

Returns a list of Completions in this provider with the specified input text.

参数:

inputText - The input text to search for.

返回:

A list of Completions, or null if there are no matching Completions.

getCompletionsImpl

protected java.util.List<Completion> getCompletionsImpl(javax.swing.text.JTextComponent comp)

Does the dirty work of creating a list of completions.

指定者:

getCompletionsImpl 在类中 CompletionProviderBase

参数:

comp - The text component to look in.

返回:

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

removeCompletion

public boolean removeCompletion(Completion c)

Removes the specified completion from this provider. This method will not remove completions from the parent provider, if there is one.

参数:

c - The completion to remove.

返回:

true if this provider contained the specified completion.

另请参阅:

clear(), addCompletion(Completion), addCompletions(List)