Package docking.widgets.search

Class TextComponentSearcher

java.lang.Object
docking.widgets.search.TextComponentSearcher
All Implemented Interfaces:
FindDialogSearcher
public class TextComponentSearcher extends Object implements FindDialogSearcher
A class to find text matches in the given TextComponent. This class will search for all matches and cache the results for future requests when the user presses Next or Previous. All matches will be highlighted in the text component. The match containing the cursor will be a different highlight color than the others. When the find dialog is closed, all highlights are removed.

If searchAll(String, boolean) is called, then the search results will not be cached, as they are when search(String, CursorPosition, boolean, boolean) is used. The expectation is that clients will cache the search results themselves.

  • Field Details

  • Constructor Details

    • TextComponentSearcher

      public TextComponentSearcher(JEditorPane editorPane)

  • Method Details

    • setEditorPane

      public void setEditorPane(JEditorPane editorPane)

    • getEditorPane

      public JEditorPane getEditorPane()

    • isBusy

      public boolean isBusy()

    • dispose

      public void dispose()
      Description copied from interface: FindDialogSearcher
      Disposes this searcher.
      Specified by:
      dispose in interface FindDialogSearcher

    • hasSearchResults

      public boolean hasSearchResults()

    • isStale

      public boolean isStale()

    • getCursorPosition

      public CursorPosition getCursorPosition()
      Description copied from interface: FindDialogSearcher
      The current cursor position. Used to search for the next item.
      Specified by:
      getCursorPosition in interface FindDialogSearcher
      Returns:
      the cursor position.

    • getStart

      public CursorPosition getStart()
      Description copied from interface: FindDialogSearcher
      Returns the start cursor position. This is used when a search is wrapped to start at the beginning of the search range.
      Specified by:
      getStart in interface FindDialogSearcher
      Returns:
      the start position.

    • getEnd

      public CursorPosition getEnd()
      Description copied from interface: FindDialogSearcher
      The end cursor position. This is used when a search is wrapped while searching backwards to start at the end position.
      Specified by:
      getEnd in interface FindDialogSearcher
      Returns:
      the end position.

    • searchAll

      public TextComponentSearchResults searchAll(String text, boolean useRegex)
      Description copied from interface: FindDialogSearcher
      Search for all matches.
      Specified by:
      searchAll in interface FindDialogSearcher
      Parameters:
      text - the search text.
      useRegex - true if the search text is a regular expression; false if the text is literal.
      Returns:
      all search results or an empty list.

    • search

      public SearchResults search(String text, CursorPosition cursorPosition, boolean searchForward, boolean useRegex)
      Description copied from interface: FindDialogSearcher
      Perform a search for the next item in the given direction starting at the given cursor position.
      Specified by:
      search in interface FindDialogSearcher
      Parameters:
      text - the search text.
      cursorPosition - the current cursor position.
      searchForward - true if searching forward.
      useRegex - true if the search text is a regular expression; false if the text is literal.
      Returns:
      the search result or null if no match was found.

    • createSearchResults

      protected TextComponentSearchResults createSearchResults(Worker theWorker, JEditorPane editor, String searchText, TreeMap<Integer,TextComponentSearchLocation> matchesByPosition)