Package org.fife.ui.autocomplete

Class DefaultCompletionProvider

java.lang.Object
org.fife.ui.autocomplete.CompletionProviderBase
org.fife.ui.autocomplete.AbstractCompletionProvider
org.fife.ui.autocomplete.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.

  • Field Details

    • seg

      protected Segment seg
      A buffer used when generating completion results.

  • 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(JTextComponent 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(JTextComponent 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(JTextComponent 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

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

    • loadFromXML

      public void loadFromXML(File file) throws IOException
      Loads completions from an XML file. The XML should validate against CompletionXml.dtd.
      Parameters:
      file - An XML file to load from.
      Throws:
      IOException - If an IO error occurs.

    • loadFromXML

      public void loadFromXML(InputStream in) throws IOException
      Loads completions from an XML input stream. The XML should validate against CompletionXml.dtd.
      Parameters:
      in - The input stream to read from.
      Throws:
      IOException - If an IO error occurs.

    • loadFromXML

      public void loadFromXML(InputStream in, ClassLoader cl) throws IOException
      Loads completions from an XML input stream. The XML should validate against CompletionXml.dtd.
      Parameters:
      in - The input stream to read from.
      cl - The class loader to use when loading any extra classes defined in the XML, such as custom FunctionCompletions. This may be null if the default is to be used, or if no custom completions are defined in the XML.
      Throws:
      IOException - If an IO error occurs.

    • loadFromXML

      public void loadFromXML(String resource) throws IOException
      Loads completions from an XML file. The XML should validate against CompletionXml.dtd.
      Parameters:
      resource - A resource the current ClassLoader can get to.
      Throws:
      IOException - If an IO error occurs.