com.fr.design.gui.autocomplete

类 CompletionProviderBase

java.lang.Object

com.fr.design.gui.autocomplete.CompletionProviderBase

所有已实现的接口:

CompletionProvider

直接已知子类:

AbstractCompletionProvider, LanguageAwareCompletionProvider

public abstract class CompletionProviderBase
extends java.lang.Object
implements CompletionProvider

A base class for all standard completion providers. This class implements functionality that should be sharable across all CompletionProvider implementations.

版本:

1.0

作者:

Robert Futrell

另请参阅:

AbstractCompletionProvider

字段概要

字段

限定符和类型	字段和说明
protected static java.lang.String	EMPTY_STRING

构造器概要

构造器

构造器和说明
CompletionProviderBase()

方法概要

方法

限定符和类型	方法和说明
void	clearParameterizedCompletionParams() Clears the values used to identify and insert "parameterized completions" (e.g. functions or methods).
java.util.List<Completion>	getCompletions(javax.swing.text.JTextComponent comp) Gets the possible completions for the text component at the current caret position.
protected abstract java.util.List<Completion>	getCompletionsImpl(javax.swing.text.JTextComponent comp) Does the dirty work of creating a list of completions.
javax.swing.ListCellRenderer	getListCellRenderer() Returns the cell renderer for completions returned from this provider.
ParameterChoicesProvider	getParameterChoicesProvider() Returns an object that can return a list of completion choices for parameters.
char	getParameterListEnd() Returns the text that marks the end of a list of parameters to a function or method.
java.lang.String	getParameterListSeparator() Returns the text that separates parameters to a function or method.
char	getParameterListStart() Returns the text that marks the start of a list of parameters to a function or method.
CompletionProvider	getParent() Returns the parent completion provider.
boolean	isAutoActivateOkay(javax.swing.text.JTextComponent tc) This method is called if auto-activation is enabled in the parent AutoCompletion after the user types a single character.
void	setAutoActivationRules(boolean letters, java.lang.String others) Sets the characters that auto-activation should occur after.
void	setListCellRenderer(javax.swing.ListCellRenderer r) Sets the renderer to use when displaying completion choices.
void	setParameterChoicesProvider(ParameterChoicesProvider pcp) Sets the param choices provider.
void	setParameterizedCompletionParams(char listStart, java.lang.String separator, char listEnd) Sets the values used to identify and insert "parameterized completions" (e.g. functions or methods).
void	setParent(CompletionProvider parent) Sets the parent completion provider.

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

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

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

getAlreadyEnteredText, getCompletionsAt, getParameterizedCompletions

字段详细资料

EMPTY_STRING

protected static final java.lang.String EMPTY_STRING

另请参阅:

常量字段值

构造器详细资料

CompletionProviderBase

public CompletionProviderBase()

方法详细资料

clearParameterizedCompletionParams

public void clearParameterizedCompletionParams()

Clears the values used to identify and insert "parameterized completions" (e.g. functions or methods). After this method is called, functions and methods will not have their parameters auto-completed.

指定者:

clearParameterizedCompletionParams 在接口中 CompletionProvider

另请参阅:

CompletionProvider.setParameterizedCompletionParams(char, String, char)

getCompletions

public java.util.List<Completion> getCompletions(javax.swing.text.JTextComponent comp)

Gets the possible completions for the text component at the current caret position.

指定者:

getCompletions 在接口中 CompletionProvider

参数:

comp - The text component.

返回:

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

getCompletionsImpl

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

Does the dirty work of creating a list of completions.

参数:

comp - The text component to look in.

返回:

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

getListCellRenderer

public javax.swing.ListCellRenderer getListCellRenderer()

Returns the cell renderer for completions returned from this provider.

指定者:

getListCellRenderer 在接口中 CompletionProvider

返回:

The cell renderer, or null if the default should be used.

另请参阅:

CompletionProvider.setListCellRenderer(ListCellRenderer)

getParameterChoicesProvider

public ParameterChoicesProvider getParameterChoicesProvider()

Returns an object that can return a list of completion choices for parameters. This is used when a user code-completes a parameterized completion, such as a function or method. For any parameter to the function/method, this object can return possible completions.

指定者:

getParameterChoicesProvider 在接口中 CompletionProvider

返回:

The parameter choices provider, or null if none is installed.

getParameterListEnd

public char getParameterListEnd()

Returns the text that marks the end of a list of parameters to a function or method.

指定者:

getParameterListEnd 在接口中 CompletionProvider

返回:

The text for a parameter list end, for example, ')'.

另请参阅:

CompletionProvider.getParameterListStart(), CompletionProvider.getParameterListSeparator(), CompletionProvider.setParameterizedCompletionParams(char, String, char)

getParameterListSeparator

public java.lang.String getParameterListSeparator()

Returns the text that separates parameters to a function or method.

指定者:

getParameterListSeparator 在接口中 CompletionProvider

返回:

The text that separates parameters, for example, ", ".

另请参阅:

CompletionProvider.getParameterListStart(), CompletionProvider.getParameterListEnd(), CompletionProvider.setParameterizedCompletionParams(char, String, char)

getParameterListStart

public char getParameterListStart()

Returns the text that marks the start of a list of parameters to a function or method.

指定者:

getParameterListStart 在接口中 CompletionProvider

返回:

The text for a parameter list start, for example, "(".

另请参阅:

CompletionProvider.getParameterListEnd(), CompletionProvider.getParameterListSeparator(), CompletionProvider.setParameterizedCompletionParams(char, String, char)

getParent

public CompletionProvider getParent()

Returns the parent completion provider.

指定者:

getParent 在接口中 CompletionProvider

返回:

The parent completion provider.

另请参阅:

CompletionProvider.setParent(CompletionProvider)

isAutoActivateOkay

public boolean isAutoActivateOkay(javax.swing.text.JTextComponent tc)

This method is called if auto-activation is enabled in the parent AutoCompletion after the user types a single character. This provider should check the text at the current caret position of the text component, and decide whether auto-activation would be appropriate here. For example, a CompletionProvider for Java might want to return true for this method only if the last character typed was a '.'.

指定者:

isAutoActivateOkay 在接口中 CompletionProvider

参数:

tc - The text component.

返回:

Whether auto-activation would be appropriate.

setAutoActivationRules

public void setAutoActivationRules(boolean letters,
                          java.lang.String others)

Sets the characters that auto-activation should occur after. A Java completion provider, for example, might want to set others to ".", to allow auto-activation for members of an object.

参数:

letters - Whether auto-activation should occur after any letter.

others - A string of (non-letter) chars that auto-activation should occur after. This may be null.

setParameterChoicesProvider

public void setParameterChoicesProvider(ParameterChoicesProvider pcp)

Sets the param choices provider. This is used when a user code-completes a parameterized completion, such as a function or method. For any parameter to the function/method, this object can return possible completions.

参数:

pcp - The parameter choices provider, or null for none.

另请参阅:

getParameterChoicesProvider()

setListCellRenderer

public void setListCellRenderer(javax.swing.ListCellRenderer r)

Sets the renderer to use when displaying completion choices.

指定者:

setListCellRenderer 在接口中 CompletionProvider

参数:

r - The renderer to use.

另请参阅:

CompletionProvider.getListCellRenderer()

setParameterizedCompletionParams

public void setParameterizedCompletionParams(char listStart,
                                    java.lang.String separator,
                                    char listEnd)

Sets the values used to identify and insert "parameterized completions" (e.g. functions or methods). If this method isn't called, functions and methods will not have their parameters auto-completed.

指定者:

setParameterizedCompletionParams 在接口中 CompletionProvider

参数:

listStart - The character that marks the beginning of a list of parameters, such as '(' in C or Java.

separator - Text that should separate parameters in a parameter list when one is inserted. For example, ", ".

listEnd - The character that marks the end of a list of parameters, such as ')' in C or Java.

另请参阅:

CompletionProvider.clearParameterizedCompletionParams()

setParent

public void setParent(CompletionProvider parent)

Sets the parent completion provider.

指定者:

setParent 在接口中 CompletionProvider

参数:

parent - The parent provider. null means there will be no parent provider.

另请参阅:

CompletionProvider.getParent()