com.fr.design.gui.autocomplete

类 VariableCompletion

java.lang.Object

com.fr.design.gui.autocomplete.AbstractCompletion

com.fr.design.gui.autocomplete.BasicCompletion

com.fr.design.gui.autocomplete.VariableCompletion

所有已实现的接口:

Completion, java.lang.Comparable<Completion>

直接已知子类:

FunctionCompletion

public class VariableCompletion
extends BasicCompletion

A completion for a variable (or constant) in a programming language.

This completion type uses its shortDescription property as part of its summary returned by getSummary(); for this reason, it may be a little longer (even much longer), if desired, than what is recommended for BasicCompletions (where the shortDescription is used in toString() for ListCellRenderers).

版本:

1.0

作者:

Robert Futrell

构造器概要

构造器

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

方法概要

方法

限定符和类型	方法和说明
protected void	addDefinitionString(java.lang.StringBuilder sb)
java.lang.String	getDefinedIn() Returns where this variable is defined.
java.lang.String	getDefinitionString()
java.lang.String	getName() Returns the name of this variable.
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.
java.lang.String	getType() Returns the type of this variable.
protected void	possiblyAddDefinedIn(java.lang.StringBuilder sb) Adds some HTML describing where this variable is defined, if this information is known.
protected boolean	possiblyAddDescription(java.lang.StringBuilder sb) Adds the description text as HTML to a buffer, if a description is defined.
void	setDefinedIn(java.lang.String definedIn) Sets where this variable is defined.
java.lang.String	toString() Overridden to return the name of the variable being completed.

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

构造器详细资料

VariableCompletion

public VariableCompletion(CompletionProvider provider,
                  java.lang.String name,
                  java.lang.String type)

Constructor.

参数:

provider - The parent provider.

name - The name of this variable.

type - The type of this variable (e.g. "int", "String", etc.).

方法详细资料

addDefinitionString

protected void addDefinitionString(java.lang.StringBuilder sb)

getDefinitionString

public java.lang.String getDefinitionString()

getDefinedIn

public java.lang.String getDefinedIn()

Returns where this variable is defined.

返回:

Where this variable is defined.

另请参阅:

setDefinedIn(String)

getName

public java.lang.String getName()

Returns the name of this variable.

返回:

The name.

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 在类中 BasicCompletion

返回:

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 在类中 AbstractCompletion

返回:

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

getType

public java.lang.String getType()

Returns the type of this variable.

返回:

The type.

possiblyAddDefinedIn

protected void possiblyAddDefinedIn(java.lang.StringBuilder sb)

Adds some HTML describing where this variable is defined, if this information is known.

参数:

sb - The buffer to append to.

possiblyAddDescription

protected boolean possiblyAddDescription(java.lang.StringBuilder sb)

Adds the description text as HTML to a buffer, if a description is defined.

参数:

sb - The buffer to append to.

返回:

Whether there was a description to add.

setDefinedIn

public void setDefinedIn(java.lang.String definedIn)

Sets where this variable is defined.

参数:

definedIn - Where this variable is defined.

另请参阅:

getDefinedIn()

toString

public java.lang.String toString()

Overridden to return the name of the variable being completed.

覆盖:

toString 在类中 BasicCompletion

返回:

A string representation of this completion.