Class: Rocketbar

Rocketbar

new Rocketbar()

The Rocketbar is a system-wide URL/search/title bar.

The Rocketbar is a system-wide URL/search/title bar.

Source:
Requires:
  • module:SearchWindow
  • module:SettingsListener

Requires

  • module:SearchWindow
  • module:SettingsListener

Methods

_handle_home()

Handle press of hardware home button.

Handle press of hardware home button.

Source:

_handle_launchactivity()

Handles activities for the search app.

Handles activities for the search app.

Source:

activate() → {Promise}

Put Rocketbar in the active state.

Put Rocketbar in the active state.

Input is displayed, title is hidden and search app is loaded, input not always focused.

Source:
Returns:
Type
Promise

addEventListeners()

Add event listeners.

Add event listeners. Only called when Rocketbar is turned on.

Source:

blur()

Blur Rocketbar input.

Blur Rocketbar input.

Source:

deactivate()

Take Rocketbar out of active state.

Take Rocketbar out of active state.

Title is displayed, input is hidden, input is always blurred.

Source:

focus()

Focus Rocketbar input.

Focus Rocketbar input.

Source:

handleBlur()

Handle a blur event.

Handle a blur event.

Source:

handleCancel()

Handle click of cancel button.

Handle click of cancel button.

Source:

handleEvent(e)

Dispatch events to correct event handlers.

Dispatch events to correct event handlers.

Parameters:
Name Type Description
e Event

Event.

Source:

handleFocus()

Handle a focus event.

Handle a focus event.

Source:

handleInput()

Handle text input in Rocketbar.

Handle text input in Rocketbar.

Source:

handleLock()

Handle a lock event.

Handle a lock event.

Source:

handleSearchMessage(e)

Handle messages from the search app.

Handle messages from the search app.

Parameters:
Name Type Description
e Event

Message event.

Source:

handleSearchTerminated()

Handles when the search app terminates.

Handles when the search app terminates.

Source:

handleSubmit(e)

Handle submission of the Rocketbar.

Handle submission of the Rocketbar.

Parameters:
Name Type Description
e Event

Submit event.

Source:

hideResults()

Hide the Rocketbar results pane.

Hide the Rocketbar results pane.

Source:

initSearchConnection() → {Promise}

Initialise inter-app connection with search app.

Initialise inter-app connection with search app.

Source:
Returns:
Type
Promise

loadSearchApp() → {Promise}

Instantiates a new SearchWindow.

Instantiates a new SearchWindow.

Source:
Returns:
Type
Promise

selectAll()

SelectAll text content from Rocketbar input.

SelectAll text content from Rocketbar input.

Source:

setSearchAppURL(url)

Set URL and generate manifest URL of search app.

Set URL and generate manifest URL of search app.

Parameters:
Name Type Description
url String

The search app URL.

Source:

showResults()

Show the Rocketbar results pane.

Show the Rocketbar results pane.

Source:

start()

Starts Rocketbar.

Starts Rocketbar.

Source:

updateSearchIndex()

Tell the search app to update its index.

Tell the search app to update its index.

Source: