| java.lang.Object | |
| ↳ | com.pspdfkit.document.search.SearchOptions |
Class Overview
Search options used when searching a loaded document for text.
See Also
Summary
| Nested Classes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| class | SearchOptions.Builder | Builder for creating SearchOptions. |
|||||||||
| Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| int | UNLIMITED_SEARCH_RESULTS | Use as argument for maxSearchResults(int) to turn off search result limiting. |
|||||||||
| Fields | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| public final EnumSet<CompareOptions> | compareOptionsFlags | ||||||||||
| public final int | maxSearchResults | Maximum number of search results. | |||||||||
| public final List<Range> | priorityPages | Pages that should be searched first. | |||||||||
| public final boolean | searchAnnotations | Indicates whether the search should be performed over annotation contents in addition to page text. | |||||||||
| public final boolean | searchOnlyInPriorityPages | ||||||||||
| public final int | snippetLength | Number of preview characters extracted with every search result. | |||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
Constants
public static final int UNLIMITED_SEARCH_RESULTS
Use as argument for maxSearchResults(int) to turn off search result limiting.
Constant Value:
2147483647
(0x7fffffff)
Fields
public final int maxSearchResults
Maximum number of search results. Defaults to {@value Builder#MAX_SEARCH_RESULTS} or {@value Builder#MAX_SEARCH_RESULTS_LOW_MEM} on devices with little of RAM.
public final boolean searchAnnotations
Indicates whether the search should be performed over annotation contents in addition to page text.
public final boolean searchOnlyInPriorityPages
public final int snippetLength
Number of preview characters extracted with every search result. The actual length of the extracted snippet may be different from this value, e.g. if no more text is available to extract, or the search term length exceeds the configured snippet length. Defaults to {@value Builder#DEFAULT_SNIPPET_LENGTH} characters.