public abstract class AbstractCompletion extends Object implements Completion
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.
Modifier | Constructor and Description |
---|---|
protected |
AbstractCompletion(CompletionProvider provider)
Constructor.
|
protected |
AbstractCompletion(CompletionProvider provider,
Icon icon)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
int |
compareTo(Completion c2)
Compares this completion to another one lexicographically, ignoring
case.
|
String |
getAlreadyEntered(JTextComponent comp)
Returns the portion of this completion that has already been entered
into the text component.
|
Icon |
getIcon()
Returns the icon to use for this completion.
|
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.
|
String |
getToolTipText()
The default implementation returns
null . |
void |
setIcon(Icon icon)
Sets the icon to use for this completion.
|
void |
setRelevance(int relevance)
Sets the relevance of this completion.
|
String |
toString()
Returns a string representation of this completion.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getReplacementText, getSummary
protected AbstractCompletion(CompletionProvider provider)
provider
- The provider that created this completion.protected AbstractCompletion(CompletionProvider provider, Icon icon)
provider
- The provider that created this completion.icon
- The icon for this completion.public int compareTo(Completion c2)
compareTo
in interface Comparable<Completion>
compareTo
in interface Completion
c2
- Another completion instance.public String getAlreadyEntered(JTextComponent comp)
This is a convenience method for:
getProvider().getAlreadyEnteredText(comp)
.
getAlreadyEntered
in interface Completion
comp
- The text component.public Icon getIcon()
getIcon
in interface Completion
null
for none.public String getInputText()
Completion.getReplacementText()
.getInputText
in interface Completion
Completion.getReplacementText()
public CompletionProvider getProvider()
getProvider
in interface Completion
public int getRelevance()
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. Completion
s with equal relevance values will be
sorted alphabetically.
getRelevance
in interface Completion
public String getToolTipText()
null
. Subclasses
can override this method.getToolTipText
in interface Completion
public void setIcon(Icon icon)
icon
- The icon to use.getIcon()
public void setRelevance(int relevance)
relevance
- The new relevance of this completion.getRelevance()
public String toString()
getInputText()
.