com.fr.design.gui.autocomplete

类 FunctionCompletion

java.lang.Object

com.fr.design.gui.autocomplete.AbstractCompletion

com.fr.design.gui.autocomplete.BasicCompletion

com.fr.design.gui.autocomplete.VariableCompletion

com.fr.design.gui.autocomplete.FunctionCompletion

所有已实现的接口:

Completion, ParameterizedCompletion, java.lang.Comparable<Completion>

public class FunctionCompletion
extends VariableCompletion
implements ParameterizedCompletion

A completion choice representing a function.

版本:

1.0

作者:

Robert Futrell

嵌套类概要

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

ParameterizedCompletion.Parameter

构造器概要

构造器

构造器和说明
FunctionCompletion(CompletionProvider provider, java.lang.String name, java.lang.String returnType) Constructor.

方法概要

方法

限定符和类型	方法和说明
protected void	addDefinitionString(java.lang.StringBuilder sb)
protected void	addParameters(java.lang.StringBuilder sb) Adds HTML describing the parameters to this function to a buffer.
java.lang.String	getDefinitionString() Returns the "definition string" for this function completion.
com.fr.design.gui.autocomplete.ParameterizedCompletionInsertionInfo	getInsertionInfo(javax.swing.text.JTextComponent tc, boolean replaceTabsWithSpaces)
ParameterizedCompletion.Parameter	getParam(int index) Returns the specified ParameterizedCompletion.Parameter.
int	getParamCount() Returns the number of parameters to this function.
java.lang.String	getReturnValueDescription() Returns the description of the return value of this function.
boolean	getShowParameterToolTip() Returns whether a tool tip displaying assistance for each parameter while it is being edited is appropriate for this completion.
java.lang.String	getSummary() Returns the description of this auto-complete choice.
java.lang.String	getToolTipText() Returns the tool tip text to display for mouse hovers over this completion.
void	setParams(java.util.List<ParameterizedCompletion.Parameter> params) Sets the parameters to this function.
void	setReturnValueDescription(java.lang.String desc) Sets the description of the return value of this function.

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

getDefinedIn, getName, getType, possiblyAddDefinedIn, possiblyAddDescription, setDefinedIn, toString

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

getReplacementText, getShortDescription, setShortDescription, setSummary

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

compareTo, getAlreadyEntered, getIcon, getInputText, getProvider, getRelevance, setRelevance

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

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

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

compareTo, getAlreadyEntered, getIcon, getInputText, getProvider, getRelevance, getReplacementText

构造器详细资料

FunctionCompletion

public FunctionCompletion(CompletionProvider provider,
                  java.lang.String name,
                  java.lang.String returnType)

Constructor.

参数:

provider - The parent provider.

name - The name of this function.

returnType - The return type of this function.

方法详细资料

addDefinitionString

protected void addDefinitionString(java.lang.StringBuilder sb)

覆盖:

addDefinitionString 在类中 VariableCompletion

addParameters

protected void addParameters(java.lang.StringBuilder sb)

Adds HTML describing the parameters to this function to a buffer.

参数:

sb - The buffer to append to.

getDefinitionString

public java.lang.String getDefinitionString()

Returns the "definition string" for this function completion. For example, for the C "printf" function, this would return "int printf(const char *, ...)".

指定者:

getDefinitionString 在接口中 ParameterizedCompletion

覆盖:

getDefinitionString 在类中 VariableCompletion

返回:

The definition string.

getInsertionInfo

public com.fr.design.gui.autocomplete.ParameterizedCompletionInsertionInfo getInsertionInfo(javax.swing.text.JTextComponent tc,
                                                                                   boolean replaceTabsWithSpaces)

指定者:

getInsertionInfo 在接口中 ParameterizedCompletion

getParam

public ParameterizedCompletion.Parameter getParam(int index)

Returns the specified ParameterizedCompletion.Parameter.

指定者:

getParam 在接口中 ParameterizedCompletion

参数:

index - The index of the parameter to retrieve.

返回:

The parameter.

另请参阅:

ParameterizedCompletion.getParamCount()

getParamCount

public int getParamCount()

Returns the number of parameters to this function.

指定者:

getParamCount 在接口中 ParameterizedCompletion

返回:

The number of parameters to this function.

另请参阅:

getParam(int)

getShowParameterToolTip

public boolean getShowParameterToolTip()

Returns whether a tool tip displaying assistance for each parameter while it is being edited is appropriate for this completion.

指定者:

getShowParameterToolTip 在接口中 ParameterizedCompletion

返回:

Whether the tool tip is appropriate to display.

getReturnValueDescription

public java.lang.String getReturnValueDescription()

Returns the description of the return value of this function.

返回:

The description, or null if there is none.

另请参阅:

setReturnValueDescription(String)

getSummary

public java.lang.String getSummary()

Returns the description of this auto-complete choice. This can be used in a popup "description window."

指定者:

getSummary 在接口中 Completion

覆盖:

getSummary 在类中 VariableCompletion

返回:

This item's description. This should be HTML. It may be null if there is no description for this completion.

getToolTipText

public java.lang.String getToolTipText()

Returns the tool tip text to display for mouse hovers over this completion.

Note that for this functionality to be enabled, a JTextComponent must be registered with the ToolTipManager, and the text component must know to search for this value. In the case of an RSyntaxTextArea, this can be done with a org.fife.ui.rtextarea.ToolTipSupplier that calls into CompletionProvider.getCompletionsAt(JTextComponent, java.awt.Point).

指定者:

getToolTipText 在接口中 Completion

覆盖:

getToolTipText 在类中 VariableCompletion

返回:

The tool tip text for this completion, or null if none.

setParams

public void setParams(java.util.List<ParameterizedCompletion.Parameter> params)

Sets the parameters to this function.

参数:

params - The parameters. This should be a list of ParameterizedCompletion.Parameters.

另请参阅:

getParam(int), getParamCount()

setReturnValueDescription

public void setReturnValueDescription(java.lang.String desc)

Sets the description of the return value of this function.

参数:

desc - The description.

另请参阅:

getReturnValueDescription()