com.fr.design.gui.autocomplete

类 LanguageAwareCompletionProvider

java.lang.Object

com.fr.design.gui.autocomplete.CompletionProviderBase

com.fr.design.gui.autocomplete.LanguageAwareCompletionProvider

所有已实现的接口:

CompletionProvider, ToolTipSupplier

public class LanguageAwareCompletionProvider
extends CompletionProviderBase
implements ToolTipSupplier

A completion provider for the C programming language (and other languages with similar syntax). This provider simply delegates to another provider, depending on whether the caret is in:

• Code (plain text)
• A string
• A comment
• A documentation comment

This allows for different completion choices in comments than in code, for example.

This provider also implements the org.fife.ui.rtextarea.ToolTipSupplier interface, which allows it to display tooltips for completion choices. Thus the standard VariableCompletion and FunctionCompletion completions should be able to display tooltips with the variable declaration or function definition (provided the RSyntaxTextArea was registered with the javax.swing.ToolTipManager).

版本:

1.0

作者:

Robert Futrell

字段概要

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

EMPTY_STRING

构造器概要

构造器

限定符	构造器和说明
protected	LanguageAwareCompletionProvider() Constructor subclasses can use when they don't have their default provider created at construction time.
	LanguageAwareCompletionProvider(CompletionProvider defaultProvider) Constructor.

方法概要

方法

限定符和类型	方法和说明
void	clearParameterizedCompletionParams() Calling this method will result in an UnsupportedOperationException being thrown.
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.
CompletionProvider	getCommentCompletionProvider() Returns the completion provider to use for comments.
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.
protected java.util.List<Completion>	getCompletionsImpl(javax.swing.text.JTextComponent comp) Does the dirty work of creating a list of completions.
CompletionProvider	getDefaultCompletionProvider() Returns the completion provider used when one isn't defined for a particular token type.
CompletionProvider	getDocCommentCompletionProvider() Returns the completion provider to use for documentation comments.
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).
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	getStringCompletionProvider() Returns the completion provider to use for strings.
java.lang.String	getToolTipText(RTextArea textArea, java.awt.event.MouseEvent e) Returns the tool tip to display for a mouse event.
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	setCommentCompletionProvider(CompletionProvider provider) Sets the comment completion provider.
void	setDefaultCompletionProvider(CompletionProvider provider) Sets the default completion provider.
void	setDocCommentCompletionProvider(CompletionProvider provider) Sets the documentation comment completion provider.
void	setParameterizedCompletionParams(char listStart, java.lang.String separator, char listEnd) Calling this method will result in an UnsupportedOperationException being thrown.
void	setStringCompletionProvider(CompletionProvider provider) Sets the completion provider to use while in a string.

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

getCompletions, getListCellRenderer, getParameterChoicesProvider, getParent, setAutoActivationRules, setListCellRenderer, setParameterChoicesProvider, setParent

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

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

构造器详细资料

LanguageAwareCompletionProvider

protected LanguageAwareCompletionProvider()

Constructor subclasses can use when they don't have their default provider created at construction time. They should call setDefaultCompletionProvider(CompletionProvider) in this constructor.

LanguageAwareCompletionProvider

public LanguageAwareCompletionProvider(CompletionProvider defaultProvider)

Constructor.

参数:

defaultProvider - The provider to use when no provider is assigned to a particular token type. This cannot be null.

方法详细资料

clearParameterizedCompletionParams

public void clearParameterizedCompletionParams()

Calling this method will result in an UnsupportedOperationException being thrown. To set the parameter completion parameters, do so on the provider returned by getDefaultCompletionProvider().

指定者:

clearParameterizedCompletionParams 在接口中 CompletionProvider

覆盖:

clearParameterizedCompletionParams 在类中 CompletionProviderBase

抛出:

java.lang.UnsupportedOperationException - Always.

另请参阅:

setParameterizedCompletionParams(char, String, char)

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.

指定者:

getAlreadyEnteredText 在接口中 CompletionProvider

参数:

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).

getCommentCompletionProvider

public CompletionProvider getCommentCompletionProvider()

Returns the completion provider to use for comments.

返回:

The completion provider to use.

另请参阅:

setCommentCompletionProvider(CompletionProvider)

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.

指定者:

getCompletionsAt 在接口中 CompletionProvider

参数:

tc - The text component.

p - The position, usually from a MouseEvent.

返回:

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

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.

getDefaultCompletionProvider

public CompletionProvider getDefaultCompletionProvider()

Returns the completion provider used when one isn't defined for a particular token type.

返回:

The completion provider to use.

另请参阅:

setDefaultCompletionProvider(CompletionProvider)

getDocCommentCompletionProvider

public CompletionProvider getDocCommentCompletionProvider()

Returns the completion provider to use for documentation comments.

返回:

The completion provider to use.

另请参阅:

setDocCommentCompletionProvider(CompletionProvider)

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).

指定者:

getParameterizedCompletions 在接口中 CompletionProvider

参数:

tc - The text component.

返回:

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

getParameterListEnd

public char getParameterListEnd()

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

指定者:

getParameterListEnd 在接口中 CompletionProvider

覆盖:

getParameterListEnd 在类中 CompletionProviderBase

返回:

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

覆盖:

getParameterListSeparator 在类中 CompletionProviderBase

返回:

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

覆盖:

getParameterListStart 在类中 CompletionProviderBase

返回:

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

另请参阅:

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

getStringCompletionProvider

public CompletionProvider getStringCompletionProvider()

Returns the completion provider to use for strings.

返回:

The completion provider to use.

另请参阅:

setStringCompletionProvider(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

覆盖:

isAutoActivateOkay 在类中 CompletionProviderBase

参数:

tc - The text component.

返回:

Whether auto-activation would be appropriate.

setCommentCompletionProvider

public void setCommentCompletionProvider(CompletionProvider provider)

Sets the comment completion provider.

参数:

provider - The provider to use in comments.

另请参阅:

getCommentCompletionProvider()

setDefaultCompletionProvider

public void setDefaultCompletionProvider(CompletionProvider provider)

Sets the default completion provider.

参数:

provider - The provider to use when no provider is assigned to a particular token type. This cannot be null.

另请参阅:

getDefaultCompletionProvider()

setDocCommentCompletionProvider

public void setDocCommentCompletionProvider(CompletionProvider provider)

Sets the documentation comment completion provider.

参数:

provider - The provider to use in comments.

另请参阅:

getDocCommentCompletionProvider()

setParameterizedCompletionParams

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

Calling this method will result in an UnsupportedOperationException being thrown. To set the parameter completion parameters, do so on the provider returned by getDefaultCompletionProvider().

指定者:

setParameterizedCompletionParams 在接口中 CompletionProvider

覆盖:

setParameterizedCompletionParams 在类中 CompletionProviderBase

参数:

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.

抛出:

java.lang.UnsupportedOperationException - Always.

另请参阅:

clearParameterizedCompletionParams()

setStringCompletionProvider

public void setStringCompletionProvider(CompletionProvider provider)

Sets the completion provider to use while in a string.

参数:

provider - The provider to use.

另请参阅:

getStringCompletionProvider()

getToolTipText

public java.lang.String getToolTipText(RTextArea textArea,
                              java.awt.event.MouseEvent e)

Returns the tool tip to display for a mouse event.

For this method to be called, the RSyntaxTextArea must be registered with the javax.swing.ToolTipManager like so:

 ToolTipManager.sharedInstance().registerComponent(textArea);
 

指定者:

getToolTipText 在接口中 ToolTipSupplier

参数:

textArea - The text area.

e - The mouse event.

返回:

The tool tip text, or null if none.