com.fr.design.gui.autocomplete

类 BasicCompletion

java.lang.Object

com.fr.design.gui.autocomplete.AbstractCompletion

com.fr.design.gui.autocomplete.BasicCompletion

所有已实现的接口:

Completion, java.lang.Comparable<Completion>

直接已知子类:

ShorthandCompletion, VariableCompletion

public class BasicCompletion
extends AbstractCompletion

A straightforward Completion implementation. This implementation can be used if you have a relatively short number of static completions with no (or short) summaries.

This implementation uses the replacement text as the input text. It also includes a "short description" field, which (if non-null), is used in the completion choices list.

版本:

1.0

作者:

Robert Futrell

构造器概要

构造器

构造器和说明
BasicCompletion(CompletionProvider provider, java.lang.String replacementText) Constructor.
BasicCompletion(CompletionProvider provider, java.lang.String replacementText, java.lang.String shortDesc) Constructor.
BasicCompletion(CompletionProvider provider, java.lang.String replacementText, java.lang.String shortDesc, java.lang.String summary) Constructor.

方法概要

方法

限定符和类型	方法和说明
java.lang.String	getReplacementText() Returns the text to insert as the result of this auto-completion.
java.lang.String	getShortDescription() Returns the short description of this completion, usually used in the completion choices list.
java.lang.String	getSummary() Returns the description of this auto-complete choice.
void	setShortDescription(java.lang.String shortDesc) Sets the short description of this completion.
void	setSummary(java.lang.String summary) Sets the summary for this completion.
java.lang.String	toString() Returns a string representation of this completion.

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

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

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

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

构造器详细资料

BasicCompletion

public BasicCompletion(CompletionProvider provider,
               java.lang.String replacementText)

Constructor.

参数:

provider - The parent completion provider.

replacementText - The text to replace.

BasicCompletion

public BasicCompletion(CompletionProvider provider,
               java.lang.String replacementText,
               java.lang.String shortDesc)

Constructor.

参数:

provider - The parent completion provider.

replacementText - The text to replace.

shortDesc - A short description of the completion. This will be displayed in the completion list. This may be null.

BasicCompletion

public BasicCompletion(CompletionProvider provider,
               java.lang.String replacementText,
               java.lang.String shortDesc,
               java.lang.String summary)

Constructor.

参数:

provider - The parent completion provider.

replacementText - The text to replace.

shortDesc - A short description of the completion. This will be displayed in the completion list. This may be null.

summary - The summary of this completion. This should be HTML. This may be null.

方法详细资料

getReplacementText

public java.lang.String getReplacementText()

Returns the text to insert as the result of this auto-completion. This is the "complete" text, including any text that replaces what the user has already typed.

返回:

The replacement text.

另请参阅:

Completion.getInputText()

getShortDescription

public java.lang.String getShortDescription()

Returns the short description of this completion, usually used in the completion choices list.

返回:

The short description, or null if there is none.

另请参阅:

setShortDescription(String)

getSummary

public java.lang.String getSummary()

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

返回:

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

setShortDescription

public void setShortDescription(java.lang.String shortDesc)

Sets the short description of this completion.

参数:

shortDesc - The short description of this completion.

另请参阅:

getShortDescription()

setSummary

public void setSummary(java.lang.String summary)

Sets the summary for this completion.

参数:

summary - The summary for this completion.

另请参阅:

getSummary()

toString

public java.lang.String toString()

Returns a string representation of this completion. If the short description is not null, this method will return: getInputText() + " - " + shortDesc otherwise, it will return getInputText().

覆盖:

toString 在类中 AbstractCompletion

返回:

A string representation of this completion.