org.fife.ui.autocomplete
Class BasicCompletion

java.lang.Object
  org.fife.ui.autocomplete.AbstractCompletion
      org.fife.ui.autocomplete.BasicCompletion

All Implemented Interfaces:

Comparable, Completion

Direct Known Subclasses:

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.

Version:

1.0

Author:

Robert Futrell

Constructor Summary

BasicCompletion(CompletionProvider provider, String replacementText)
Constructor.

BasicCompletion(CompletionProvider provider, String replacementText, String shortDesc)
Constructor.

BasicCompletion(CompletionProvider provider, String replacementText, String shortDesc, String summary)
Constructor.

Method Summary

String	getReplacementText() Returns the text to insert as the result of this auto-completion.
String	getShortDescription() Returns the short description of this completion, usually used in the completion choices list.
String	getSummary() Returns the description of this auto-complete choice.
void	setShortDescription(String shortDesc) Sets the short description of this completion.
void	setSummary(String summary) Sets the summary for this completion.
String	toString() Returns a string representation of this completion.

Methods inherited from class org.fife.ui.autocomplete.AbstractCompletion

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

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicCompletion

public BasicCompletion(CompletionProvider provider,
                       String replacementText)

Constructor.

Parameters:

provider - The parent completion provider.

replacementText - The text to replace.

BasicCompletion

public BasicCompletion(CompletionProvider provider,
                       String replacementText,
                       String shortDesc)

Constructor.

Parameters:

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,
                       String replacementText,
                       String shortDesc,
                       String summary)

Constructor.

Parameters:

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.

Method Detail

getReplacementText

public 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.

Returns:

The replacement text.

See Also:

Completion.getInputText()

getShortDescription

public String getShortDescription()

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

Returns:

The short description, or null if there is none.

See Also:

setShortDescription(String)

getSummary

public String getSummary()

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

Returns:

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

setShortDescription

public void setShortDescription(String shortDesc)

Sets the short description of this completion.

Parameters:

shortDesc - The short description of this completion.

See Also:

getShortDescription()

setSummary

public void setSummary(String summary)

Sets the summary for this completion.

Parameters:

summary - The summary for this completion.

See Also:

getSummary()

toString

public 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().

Overrides:

toString in class AbstractCompletion

Returns:

A string representation of this completion.