Module: UWA/Controls/SearchForm

UWA/Controls/SearchForm

Index

Members

<protected, inner> defaultOptions

Properties:
Name Type Description
defaultOptions Object

The default controls options.

Methods

<inner> init(options)

Set the options to the current controls instance, creates observers and elements object.

Parameters
Name Type Description
options Object

options hash or a option/value pair.

<inner> buildSkeleton()

Build main dom elements.

<inner> setFavicon(url, title)

The the current favicon near the search field.

Parameters
Name Type Description
url String

the URL of the favicon.

title String

the title of the favicon.

<inner> setSearchText(searchText)

Set the current search string.

Parameters
Name Type Description
searchText String

the current search string.

<inner> getSearchText() → {String}

Get the current search string.

Returns
  • the current search string.
Type
String

<inner> setCheckboxState(checked)

Set the current checkbox state.

Parameters
Name Type Description
checked Boolean

true if checked else false.

<inner> getCheckboxState() → {Boolean}

Get the current checkbox state.

Returns
  • true if checked else false.
Type
Boolean

<inner> setHistoryString(searchHistory)

Add entries into search history.

Parameters
Name Type Description
searchHistory Void

TODO.

<inner> getHistoryString()

Get entries into search history.

<inner> addHistory(query)

Add entry into search history.

Parameters
Name Type Description
query Void

TODO.

<inner> clearHistory()

Clear search history.

<inner> hideHistory()

Hide search history popup menu.

<inner> showHistory()

Show search history popup menu.

<inner> toggleHistory()

Toggle search history popup menu visibility.

<inner> onSubmitSearch(searchText, checked)

Invoked when user submit search.

Parameters
Name Type Description
searchText String

TODO.

checked Boolean

TODO.

Invoked when user submit search by clicking on previous search link in history list.

Parameters
Name Type Description
searchText String

TODO.

checked Boolean

TODO.

<inner> onResetSearch(searchText, checked)

Invoked when the user reset search of submit an empty search.

Parameters
Name Type Description
searchText String

TODO.

checked Boolean

TODO.

<inner> onToggleSearch(searchText, checked)

Invoked when user change the checkbox state.

Parameters
Name Type Description
searchText String

TODO.

checked Boolean

TODO.

<inner> onFocusSearch()

Invoked when focus event is trigger on the search field.

<inner> onBlurSearch()

Invoked when blur event is trigger on the search field. Blur event mean loses focus.

<inner> onClickSearch()

Invoked when user click on the search field.

<inner> onSearchKeyPress()

Invoked when key is press and search field is focused.