Package org.jpedal.grouping

Class SearchType

java.lang.Object
org.jpedal.grouping.SearchType
public final class SearchType extends Object
This class holds constants used to describe the nature of a given search. Methods in the PdfGroupingAlgorithums class that take a search type parameter will take either one, or a combination of the values contained in this class. Multiple constants can be used by using the logical or operator.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    CASE_SENSITIVE
    Used to describe a search that is case-sensitive
    static final int
    DEFAULT
    The default parameter, this describes a search that will not be limited to finding whole words only, is not case-sensitive, and will find all occurrences.
    static final int
    FIND_FIRST_OCCURANCE_ONLY
    Used to describe a search that will find first occurrences only
    static final int
    HIGHLIGHT_ALL_RESULTS
    Used to describe a search that results in all highlights on the page to be visible
    static final int
    IGNORE_SPACE_CHARACTERS
    Used to ignore space characters from the search term and underlying text.
    static final int
    MUTLI_LINE_RESULTS
    Used to describe a search that will find results split across multiple lines
    static final int
    SEARCH_HIGHLIGHTS_ONLY
    Used to describe a search that will only search within highlighted areas
    static final int
    USE_REGULAR_EXPRESSIONS
    Used to describe a search that matches regular expressions with the search term
    static final int
    WHOLE_WORDS_ONLY
    Used to describe a search that will find whole words only

  • Method Summary

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • DEFAULT

      public static final int DEFAULT
      The default parameter, this describes a search that will not be limited to finding whole words only, is not case-sensitive, and will find all occurrences.
      See Also:

    • WHOLE_WORDS_ONLY

      public static final int WHOLE_WORDS_ONLY
      Used to describe a search that will find whole words only
      See Also:

    • CASE_SENSITIVE

      public static final int CASE_SENSITIVE
      Used to describe a search that is case-sensitive
      See Also:

    • FIND_FIRST_OCCURANCE_ONLY

      public static final int FIND_FIRST_OCCURANCE_ONLY
      Used to describe a search that will find first occurrences only
      See Also:

    • MUTLI_LINE_RESULTS

      public static final int MUTLI_LINE_RESULTS
      Used to describe a search that will find results split across multiple lines
      See Also:

    • HIGHLIGHT_ALL_RESULTS

      public static final int HIGHLIGHT_ALL_RESULTS
      Used to describe a search that results in all highlights on the page to be visible
      See Also:

    • USE_REGULAR_EXPRESSIONS

      public static final int USE_REGULAR_EXPRESSIONS
      Used to describe a search that matches regular expressions with the search term
      See Also:

    • SEARCH_HIGHLIGHTS_ONLY

      public static final int SEARCH_HIGHLIGHTS_ONLY
      Used to describe a search that will only search within highlighted areas
      See Also:

    • IGNORE_SPACE_CHARACTERS

      public static final int IGNORE_SPACE_CHARACTERS
      Used to ignore space characters from the search term and underlying text. Useful when number of spaces in gaps is unknown.
      See Also: