Summary:
Nested Classes
| Constants
| Inherited Constants
| Ctors
| Methods
| Inherited Methods
| [Expand All]
| java.lang.Object | |
| ↳ | com.pspdfkit.configuration.search.SearchConfiguration |
Class Overview
Class containing search configuration properties.
Summary
| Nested Classes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| class | SearchConfiguration.Builder | Builder to create SearchConfiguration instances. |
|||||||||
| Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| int | DEFAULT_SNIPPET_LENGTH | Default number of preview characters extracted with every search result. | |||||||||
| int | DEFAULT_START_SEARCH_CHARS | Default number of characters after which the search starts. | |||||||||
| boolean | DEFAULT_START_SEARCH_ON_CURRENT_PAGE | Default value for whether the search should start on the current page or not. | |||||||||
| int | UNLIMITED_SEARCH_RESULTS | Used as argument for maxSearchResults(int) to turn off search result limiting. |
|||||||||
|
[Expand]
Inherited Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
 From interface
android.os.Parcelable
| |||||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| SearchConfiguration() | |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract Integer |
getMaxSearchResults()
Returns maximum search results.
| ||||||||||
| abstract int |
getSnippetLength()
Returns the search snippet length, which is a number of letters displayed in the search result preview.
| ||||||||||
| abstract int |
getStartSearchChars()
Returns the number of letter after which the search starts.
| ||||||||||
| abstract boolean |
isStartSearchOnCurrentPage()
Returns
true if the search should be started on the current page, false to start from the beginning. | ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From class
java.lang.Object
| |||||||||||
|
From interface
android.os.Parcelable
| |||||||||||
Constants
public static final int DEFAULT_SNIPPET_LENGTH
Default number of preview characters extracted with every search result.
Constant Value:
80
(0x00000050)
public static final int DEFAULT_START_SEARCH_CHARS
Default number of characters after which the search starts.
Constant Value:
2
(0x00000002)
public static final boolean DEFAULT_START_SEARCH_ON_CURRENT_PAGE
Default value for whether the search should start on the current page or not.
Constant Value:
false
public static final int UNLIMITED_SEARCH_RESULTS
Used as argument for maxSearchResults(int) to turn off search result limiting.
Constant Value:
2147483647
(0x7fffffff)
Public Constructors
public SearchConfiguration ()
Public Methods
public abstract Integer getMaxSearchResults ()
Returns maximum search results.
Returns
- maximum search results, or
nullif not set.
public abstract int getSnippetLength ()
Returns the search snippet length, which is a number of letters displayed in the search result preview.
Returns
- Search snippet length.
public abstract int getStartSearchChars ()
Returns the number of letter after which the search starts.
Returns
- Number of letters in the input field after which the search is triggered.
public abstract boolean isStartSearchOnCurrentPage ()
Returns true if the search should be started on the current page, false to start from the beginning.
Returns
trueto start search from current page,falseto start from beginning.