Package org.fife.ui.autocomplete
Class CompletionProviderBase
java.lang.Object
org.fife.ui.autocomplete.CompletionProviderBase
- All Implemented Interfaces:
CompletionProvider
- Direct Known Subclasses:
AbstractCompletionProvider
,LanguageAwareCompletionProvider
A base class for all standard completion providers. This class implements
functionality that should be sharable across all
CompletionProvider
implementations.- Version:
- 1.0
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate boolean
Whether auto-activation should occur after letters.private String
Non-letter chars that should cause auto-activation to occur.protected static final String
private ListCellRenderer
<Object> The renderer to use for completions from this provider.private ParameterChoicesProvider
Provides completion choices for a parameterized completion's parameters.private char
Text that marks the end of a parameter list, for example, ')'.private String
Text that separates items in a parameter list, for example, ", ".private char
Text that marks the beginning of a parameter list, for example, '('.private CompletionProvider
The parent completion provider.private final Segment
A segment to use for fast char access.private static final Comparator
<Completion> Comparator used to sort completions by their relevance before sorting them lexicographically. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Clears the values used to identify and insert "parameterized completions" (e.g.getCompletions
(JTextComponent comp) Gets the possible completions for the text component at the current caret position.protected abstract List
<Completion> Does the dirty work of creating a list of completions.Returns the cell renderer for completions returned from this provider.Returns an object that can return a list of completion choices for parameters.char
Returns the text that marks the end of a list of parameters to a function or method.Returns the text that separates parameters to a function or method.char
Returns the text that marks the start of a list of parameters to a function or method.Returns the parent completion provider.boolean
This method is called if auto-activation is enabled in the parentAutoCompletion
after the user types a single character.void
setAutoActivationRules
(boolean letters, String others) Sets the characters that auto-activation should occur after.void
Sets the renderer to use when displaying completion choices.void
Sets the param choices provider.void
setParameterizedCompletionParams
(char listStart, String separator, char listEnd) Sets the values used to identify and insert "parameterized completions" (e.g.void
setParent
(CompletionProvider parent) Sets the parent completion provider.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.fife.ui.autocomplete.CompletionProvider
getAlreadyEnteredText, getCompletionsAt, getParameterizedCompletions
-
Field Details
-
parent
The parent completion provider. -
listCellRenderer
The renderer to use for completions from this provider. If this isnull
, a default renderer is used. -
paramListStart
private char paramListStartText that marks the beginning of a parameter list, for example, '('. -
paramListEnd
private char paramListEndText that marks the end of a parameter list, for example, ')'. -
paramListSeparator
Text that separates items in a parameter list, for example, ", ". -
autoActivateAfterLetters
private boolean autoActivateAfterLettersWhether auto-activation should occur after letters. -
autoActivateChars
Non-letter chars that should cause auto-activation to occur. -
paramChoicesProvider
Provides completion choices for a parameterized completion's parameters. -
s
A segment to use for fast char access. -
EMPTY_STRING
- See Also:
-
SORT_BY_RELEVANCE_COMPARATOR
Comparator used to sort completions by their relevance before sorting them lexicographically.
-
-
Constructor Details
-
CompletionProviderBase
public CompletionProviderBase()
-
-
Method Details
-
clearParameterizedCompletionParams
public void clearParameterizedCompletionParams()Description copied from interface:CompletionProvider
Clears the values used to identify and insert "parameterized completions" (e.g. functions or methods). After this method is called, functions and methods will not have their parameters auto-completed.- Specified by:
clearParameterizedCompletionParams
in interfaceCompletionProvider
- See Also:
-
getCompletions
Description copied from interface:CompletionProvider
Gets the possible completions for the text component at the current caret position.- Specified by:
getCompletions
in interfaceCompletionProvider
- Parameters:
comp
- The text component.- Returns:
- The list of
Completion
s. If no completions are available, this method should return an empty list.
-
getCompletionsImpl
Does the dirty work of creating a list of completions.- Parameters:
comp
- The text component to look in.- Returns:
- The list of possible completions, or an empty list if there are none.
-
getListCellRenderer
Description copied from interface:CompletionProvider
Returns the cell renderer for completions returned from this provider.- Specified by:
getListCellRenderer
in interfaceCompletionProvider
- Returns:
- The cell renderer, or
null
if the default should be used. - See Also:
-
getParameterChoicesProvider
Description copied from interface:CompletionProvider
Returns an object that can return a list of completion choices for parameters. This is used when a user code-completes a parameterized completion, such as a function or method. For any parameter to the function/method, this object can return possible completions.- Specified by:
getParameterChoicesProvider
in interfaceCompletionProvider
- Returns:
- The parameter choices provider, or
null
if none is installed.
-
getParameterListEnd
public char getParameterListEnd()Description copied from interface:CompletionProvider
Returns the text that marks the end of a list of parameters to a function or method.- Specified by:
getParameterListEnd
in interfaceCompletionProvider
- Returns:
- The text for a parameter list end, for example,
'
)
', or0
if none. - See Also:
-
getParameterListSeparator
Description copied from interface:CompletionProvider
Returns the text that separates parameters to a function or method.- Specified by:
getParameterListSeparator
in interfaceCompletionProvider
- Returns:
- The text that separates parameters, for example,
"
,
". - See Also:
-
getParameterListStart
public char getParameterListStart()Description copied from interface:CompletionProvider
Returns the text that marks the start of a list of parameters to a function or method.- Specified by:
getParameterListStart
in interfaceCompletionProvider
- Returns:
- The text for a parameter list start, for example,
"
(
". - See Also:
-
getParent
Description copied from interface:CompletionProvider
Returns the parent completion provider.- Specified by:
getParent
in interfaceCompletionProvider
- Returns:
- The parent completion provider.
- See Also:
-
isAutoActivateOkay
Description copied from interface:CompletionProvider
This method is called if auto-activation is enabled in the parentAutoCompletion
after the user types a single character. This provider should check the text at the current caret position of the text component, and decide whether auto-activation would be appropriate here. For example, aCompletionProvider
for Java might want to returntrue
for this method only if the last character typed was a '.
'.- Specified by:
isAutoActivateOkay
in interfaceCompletionProvider
- Parameters:
tc
- The text component.- Returns:
- Whether auto-activation would be appropriate.
-
setAutoActivationRules
Sets the characters that auto-activation should occur after. A Java completion provider, for example, might want to setothers
to ".
", to allow auto-activation for members of an object.- Parameters:
letters
- Whether auto-activation should occur after any letter.others
- A string of (non-letter) chars that auto-activation should occur after. This may benull
.
-
setParameterChoicesProvider
Sets the param choices provider. This is used when a user code-completes a parameterized completion, such as a function or method. For any parameter to the function/method, this object can return possible completions.- Parameters:
pcp
- The parameter choices provider, ornull
for none.- See Also:
-
setListCellRenderer
Description copied from interface:CompletionProvider
Sets the renderer to use when displaying completion choices.- Specified by:
setListCellRenderer
in interfaceCompletionProvider
- Parameters:
r
- The renderer to use.- See Also:
-
setParameterizedCompletionParams
Description copied from interface:CompletionProvider
Sets the values used to identify and insert "parameterized completions" (e.g. functions or methods). If this method isn't called, functions and methods will not have their parameters auto-completed.- Specified by:
setParameterizedCompletionParams
in interfaceCompletionProvider
- Parameters:
listStart
- The character that marks the beginning of a list of parameters, such as '(
' in C or Java.separator
- Text that should separate parameters in a parameter list when one is inserted. For example, ",
".listEnd
- The character that marks the end of a list of parameters, such as ')
' in C or Java.- See Also:
-
setParent
Description copied from interface:CompletionProvider
Sets the parent completion provider.- Specified by:
setParent
in interfaceCompletionProvider
- Parameters:
parent
- The parent provider.null
means there will be no parent provider.- See Also:
-