com.fr.design.gui.autocomplete

类 AbstractCompletion

java.lang.Object

com.fr.design.gui.autocomplete.AbstractCompletion

所有已实现的接口:

Completion, java.lang.Comparable<Completion>

直接已知子类:

BasicCompletion, MarkupTagCompletion, TemplateCompletion

public abstract class AbstractCompletion
extends java.lang.Object
implements Completion

Base class for possible completions. Most, if not all, Completion implementations can extend this class. It remembers the CompletionProvider that returns this completion, and also implements Comparable, allowing such completions to be compared lexicographically (ignoring case).

This implementation assumes the input text and replacement text are the same value. It also returns the input text from its toString() method (which is what DefaultListCellRenderer uses to render objects). Subclasses that wish to override any of this behavior can simply override the corresponding method(s) needed to do so.

版本:

1.0

作者:

Robert Futrell

构造器概要

构造器

构造器和说明
AbstractCompletion(CompletionProvider provider) Constructor.

方法概要

方法

限定符和类型	方法和说明
int	compareTo(Completion c2) Compares this completion to another one lexicographically, ignoring case.
java.lang.String	getAlreadyEntered(javax.swing.text.JTextComponent comp) Returns the portion of this completion that has already been entered into the text component.
javax.swing.Icon	getIcon() The default implementation returns null.
java.lang.String	getInputText() Returns the text the user has to (start) typing for this completion to be offered.
CompletionProvider	getProvider() Returns the provider that returned this completion.
int	getRelevance() Returns the "relevance" of this completion.
java.lang.String	getToolTipText() The default implementation returns null.
void	setRelevance(int relevance) Sets the relevance of this completion.
java.lang.String	toString() Returns a string representation of this completion.

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

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

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

getReplacementText, getSummary

构造器详细资料

AbstractCompletion

public AbstractCompletion(CompletionProvider provider)

Constructor.

参数:

provider - The provider that created this completion.

方法详细资料

compareTo

public int compareTo(Completion c2)

Compares this completion to another one lexicographically, ignoring case.

指定者:

compareTo 在接口中 Completion

指定者:

compareTo 在接口中 java.lang.Comparable<Completion>

参数:

c2 - Another completion instance.

返回:

How this completion compares to the other one.

getAlreadyEntered

public java.lang.String getAlreadyEntered(javax.swing.text.JTextComponent comp)

Returns the portion of this completion that has already been entered into the text component. The match is case-insensitive.

This is a convenience method for: getProvider().getAlreadyEnteredText(comp).

指定者:

getAlreadyEntered 在接口中 Completion

参数:

comp - The text component.

返回:

The already-entered portion of this completion.

getIcon

public javax.swing.Icon getIcon()

The default implementation returns null. Subclasses who wish to display an icon can override this method.

指定者:

getIcon 在接口中 Completion

返回:

The icon for this completion.

getInputText

public java.lang.String getInputText()

Returns the text the user has to (start) typing for this completion to be offered. The default implementation simply returns Completion.getReplacementText().

指定者:

getInputText 在接口中 Completion

返回:

The text the user has to (start) typing for this completion.

另请参阅:

Completion.getReplacementText()

getProvider

public CompletionProvider getProvider()

Returns the provider that returned this completion.

指定者:

getProvider 在接口中 Completion

返回:

The provider.

getRelevance

public int getRelevance()

Returns the "relevance" of this completion. This is used when sorting completions by their relevance. It is an abstract concept that may mean different things to different languages, and may depend on the context of the completion.

By default, all completions have a relevance of 0. The higher the value returned by this method, the higher up in the list this completion will be; the lower the value returned, the lower it will be. Completions with equal relevance values will be sorted alphabetically.

指定者:

getRelevance 在接口中 Completion

返回:

The relevance of this completion.

getToolTipText

public java.lang.String getToolTipText()

The default implementation returns null. Subclasses can override this method.

指定者:

getToolTipText 在接口中 Completion

返回:

The tool tip text.

setRelevance

public void setRelevance(int relevance)

Sets the relevance of this completion.

参数:

relevance - The new relevance of this completion.

另请参阅:

getRelevance()

toString

public java.lang.String toString()

Returns a string representation of this completion. The default implementation returns getInputText().

覆盖:

toString 在类中 java.lang.Object

返回:

A string representation of this completion.