Class TeXWordFinder

java.lang.Object
com.swabunga.spell.event.AbstractWordFinder
com.swabunga.spell.event.TeXWordFinder
All Implemented Interfaces:
WordFinder

public class TeXWordFinder extends AbstractWordFinder
A word finder for TeX and LaTeX documents, which searches text for sequences of letters, but ignores any commands and environments as well as Math environments.
Author:
Anthony Roy (ajr@antroy.co.uk)
  • Field Details

    • STRING_EXPR

      public static final int STRING_EXPR
      A type where string expressions are used to define expression to ignore
      See Also:
    • REG_EXPR

      public static final int REG_EXPR
      A type where regular expressions are used to define expression to ignore
      See Also:
  • Constructor Details

    • TeXWordFinder

      public TeXWordFinder(String inText)
      Creates a new DefaultWordFinder object.
      Parameters:
      inText - the text to search.
    • TeXWordFinder

      public TeXWordFinder()
      Creates a new DefaultWordFinder object.
  • Method Details

    • next

      public Word next()
      This method scans the text from the end of the last word, and returns a new Word object corresponding to the next word.
      Specified by:
      next in interface WordFinder
      Specified by:
      next in class AbstractWordFinder
      Returns:
      the next word.
      Throws:
      WordNotFoundException - search string contains no more words.
    • addUserDefinedIgnores

      public void addUserDefinedIgnores(Collection expressions, int regex)
      This method is used to import a user defined set of either strings or regular expressions to ignore.
      Parameters:
      expressions - a collection of Objects whose toString() value should be the expression. Typically String objects.
      regex - is an integer specifying the type of expression to use. e.g. REG_EXPR, STRING_EXPR.
    • setIgnoreComments

      public void setIgnoreComments(boolean ignore)
      Define if comments contents are ignored during spell checking
      Parameters:
      ignore - an indication if comments content is to be ignored