SearchHeader.Builder


class SearchHeader.Builder


A builder of SearchHeader.

Summary

Public constructors

Creates a new Builder with provided search callback SearchCallback.

Public functions

SearchHeader

Constructs the SearchHeader instance.

SearchHeader.Builder

Adds an Action to be displayed at the end of the header.

SearchHeader.Builder

Sets the initial search text to display in the search box.

SearchHeader.Builder

Sets the text hint to display in the search box when it is empty.

SearchHeader.Builder

Sets whether the keyboard should be displayed by default.

SearchHeader.Builder

Sets the start header Action.

Public constructors

Builder

Added in 1.9.0-alpha02
Builder(callback: SearchCallback)

Creates a new Builder with provided search callback SearchCallback.

Parameters
callback: SearchCallback

the callback to be invoked for search events

Throws
java.lang.NullPointerException

if callback is null

Public functions

build

Added in 1.9.0-alpha02
fun build(): SearchHeader

Constructs the SearchHeader instance.

setEndHeaderActions

Added in 1.9.0-alpha02
@CanIgnoreReturnValue
fun setEndHeaderActions(endHeaderActions: (Mutable)List<Action!>): SearchHeader.Builder

Adds an Action to be displayed at the end of the header.

Throws
java.lang.NullPointerException

if headerAction is null

setInitialSearchText

Added in 1.9.0-alpha02
@CanIgnoreReturnValue
fun setInitialSearchText(initialSearchText: String): SearchHeader.Builder

Sets the initial search text to display in the search box.

Throws
java.lang.NullPointerException

if initialSearchText is null

setSearchHint

Added in 1.9.0-alpha02
@CanIgnoreReturnValue
fun setSearchHint(searchHint: String): SearchHeader.Builder

Sets the text hint to display in the search box when it is empty.

Throws
java.lang.NullPointerException

if searchHint is null

setShowKeyboardByDefault

Added in 1.9.0-alpha02
@CanIgnoreReturnValue
fun setShowKeyboardByDefault(showKeyboardByDefault: Boolean): SearchHeader.Builder

Sets whether the keyboard should be displayed by default. Defaults to true.

setStartHeaderAction

Added in 1.9.0-alpha02
@CanIgnoreReturnValue
fun setStartHeaderAction(headerAction: Action): SearchHeader.Builder

Sets the start header Action.

Throws
java.lang.NullPointerException

if headerAction is null

java.lang.IllegalArgumentException

if headerAction does not meet the requirements