Interface nsIAutoCompleteInputType

Hierarchy

Properties

completeDefaultIndex completeSelectedIndex consumeRollupEvent controller disableAutoComplete forceComplete inPrivateContext invalidatePreviousResult maxRows minResultsForPopup noRollupOnCaretMove noRollupOnEmptySearch popup popupElement popupOpen searchCount searchParam selectionEnd selectionStart textValue timeout userContextId

Methods

AddRef QueryInterface Release getSearchAt onSearchBegin onSearchComplete onTextEntered onTextReverted selectTextRange

Properties

completeDefaultIndex

completeDefaultIndex: boolean

If a search result has its defaultIndex set, this will optionally try to complete the text in the textbox to the entire text of the result at the default index as the user types

completeSelectedIndex

completeSelectedIndex: boolean

complete text in the textbox as the user selects from the dropdown options if set to true

Readonly consumeRollupEvent

consumeRollupEvent: boolean

This popup should consume or dispatch the rollup event. TRUE: should consume; FALSE: should dispatch.

Readonly controller

controller: nsIAutoCompleteController

The controller.

disableAutoComplete

disableAutoComplete: boolean

Option to disable autocomplete functionality

forceComplete

forceComplete: boolean

Option for completing to the default result whenever the user hits enter or the textbox loses focus

Readonly inPrivateContext

inPrivateContext: boolean

Indicates whether this input is in a "private browsing" context. nsIAutoCompleteSearches for these inputs should not persist any data to disk (such as a history database).

Readonly invalidatePreviousResult

invalidatePreviousResult: boolean

Since search content is updated, we shouldn't use previous search result.

maxRows

maxRows: number

The maximum number of rows to show in the autocomplete popup.

minResultsForPopup

minResultsForPopup: number

Option to open the popup only after a certain number of results are available

Readonly noRollupOnCaretMove

noRollupOnCaretMove: boolean

Don't rollup the popup when the caret is moved.

Readonly noRollupOnEmptySearch

noRollupOnEmptySearch: boolean

Don't rollup the popup when the search string becomes "".

Readonly popup

popup: nsIAutoCompletePopup

Readonly popupElement

popupElement: Element

The result view that will be used to display results

popupOpen

popupOpen: boolean

Indicates if the popup is currently open

Readonly searchCount

searchCount: number

The number of autocomplete session to search

searchParam

searchParam: string

An extra parameter to configure searches with.

Readonly selectionEnd

selectionEnd: number

Report the ending index of the cursor in the textbox

Readonly selectionStart

selectionStart: number

Report the starting index of the cursor in the textbox

textValue

textValue: string

The value of text in the autocomplete textbox.

timeout

timeout: number

Number of milliseconds after a keystroke before a search begins

Readonly userContextId

userContextId: number

The userContextId of the current browser.

Methods

AddRef

  • Increases the reference count for this interface. The associated instance will not be deleted unless the reference count is returned to zero.

    Returns

    The resulting reference count.

    Returns number

QueryInterface

  • Parameters

    • aIID: object
    • Optional aInstancePtr: object

    Returns any

  • A run time mechanism for interface discovery.

    Returns

    NS_OK if the interface is supported by the associated instance, NS_NOINTERFACE if it is not.

    aInstancePtr must not be null.

    Parameters

    • aIID: object

      [in] A requested interface IID

    • aInstancePtr: object

      [out] A pointer to an interface pointer to receive the result.

    Returns void

Release

  • Decreases the reference count for this interface. Generally, if the reference count returns to zero, the associated instance is deleted.

    Returns

    The resulting reference count.

    Returns number

getSearchAt

  • Get the name of one of the autocomplete search session objects

    Parameters

    • index: number

    Returns string

onSearchBegin

  • Notification that the search has started

    Returns void

onSearchComplete

  • Notification that the search concluded successfully

    Returns void

onTextEntered

  • Notification that the user selected and entered a result item

    Returns

    True if the user wishes to prevent the enter

    Parameters

    • aEvent: Event

      The event that triggered the enter.

    • itemWasSelected: boolean

      A boolean value that indicates whether an item was selected from the autocomplete popup.

    Returns boolean

onTextReverted

  • Notification that the user cancelled the autocomplete session

    Returns

    True if the user wishes to prevent the revert

    Returns boolean

selectTextRange

  • Select a range of text in the autocomplete textbox

    Parameters

    • startIndex: number
    • endIndex: number

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc