Module platform
Package de.grogra.pf.ui.autocomplete.impl

Class DefaultCompletionProvider

java.lang.Object
de.grogra.pf.ui.autocomplete.impl.CompletionProviderBase
de.grogra.pf.ui.autocomplete.impl.AbstractCompletionProvider
de.grogra.pf.ui.autocomplete.impl.DefaultCompletionProvider
All Implemented Interfaces:
CompletionProvider
public class DefaultCompletionProvider extends AbstractCompletionProvider
A basic completion provider implementation. This provider has no understanding of language semantics. It simply checks the text entered up to the caret position for a match against known completions. This is all that is needed in the majority of cases.
Version:
1.0
Author:
Robert Futrell

  • Constructor Details

    • DefaultCompletionProvider

      public DefaultCompletionProvider()
      Constructor. The returned provider will not be aware of any completions.
      See Also:

    • DefaultCompletionProvider

      public DefaultCompletionProvider(String[] words)
      Creates a completion provider that provides completion for a simple list of words.
      Parameters:
      words - The words to offer as completion suggestions. If this is null, no completions will be known.
      See Also:

  • Method Details

    • getAlreadyEnteredText

      public String getAlreadyEnteredText(AutoCompletableTextArea comp)
      Returns the text just before the current caret position that could be the start of something auto-completable.

      This method returns all characters before the caret that are matched by isValidChar(char).

      Returns the text just before the current caret position that could be the start of something auto-completable.

      Parameters:
      comp - The text component.
      Returns:
      The text. A return value of null means nothing should be auto-completed; a value of an empty string ("") means auto-completion should still be considered (i.e., all possible choices are valid).

    • getCompletionsAt

      public List<Completion> getCompletionsAt(AutoCompletableTextArea tc, Point p)
      Description copied from interface: CompletionProvider
      Returns the completions that have been entered at the specified visual location. This can be used for tool tips when the user hovers the mouse over completed text.
      Parameters:
      tc - The text component.
      p - The position, usually from a MouseEvent.
      Returns:
      The completions, or an empty list if there are none.

    • getParameterizedCompletions

      public List<ParameterizedCompletion> getParameterizedCompletions(AutoCompletableTextArea tc)
      Description copied from interface: CompletionProvider
      Returns a list of parameterized completions that have been entered at the current caret position of a text component (and thus can have their completion choices displayed).
      Parameters:
      tc - The text component.
      Returns:
      The list of ParameterizedCompletions. If no completions are available, this may be null.

    • init

      protected void init()
      Initializes this completion provider.

    • isValidChar

      public boolean isValidChar(char ch)
      Returns whether the specified character is valid in an auto-completion. The default implementation is equivalent to "Character.isLetterOrDigit(ch) || ch=='_'". Subclasses can override this method to change what characters are matched.
      Parameters:
      ch - The character.
      Returns:
      Whether the character is valid.