Constructor Detail

• SearchConfiguration.Builder

  SearchConfiguration.Builder()

Method Detail

• maxSearchResults

  @NonNull() SearchConfiguration.Builder maxSearchResults(int maxSearchResults)

  Limits the maximum number of search results. If not set maxSearchResults will be used by default. To turn off limiting use UNLIMITED_SEARCH_RESULTS.

  Parameters:

  maxSearchResults - Maximum count of search results to return, or UNLIMITED_SEARCH_RESULTS to turn off limiting.

• build

  @NonNull() SearchConfiguration build()

  Builds SearchConfiguration from the values provided to the builder.

  Returns:

  Built search configuration.

• setStartSearchChars

  @NonNull() SearchConfiguration.Builder setStartSearchChars(int startSearchChars)

  Sets the number of characters that need to be entered for the search to start.

  Parameters:

  startSearchChars - Number of characters needed to trigger the search, defaults to {@value DEFAULT_START_SEARCH_CHARS}.

• setSnippetLength

  @NonNull() SearchConfiguration.Builder setSnippetLength(int snippetLength)

  Sets the number of preview characters extracted with every search result.

  Parameters:

  snippetLength - Number of characters, defaults to {@value DEFAULT_SNIPPET_LENGTH}.

• setStartSearchOnCurrentPage

  @NonNull() SearchConfiguration.Builder setStartSearchOnCurrentPage(boolean startSearchOnCurrentPage)

  Sets whether the search should start on the current page or not. This defaults to {@value * DEFAULT_START_SEARCH_ON_CURRENT_PAGE}.

  Parameters:

  startSearchOnCurrentPage - true to start search on the current page, false to start from the beginning of the document.