Interface nsIAutoCompletePopupType

Hierarchy

Properties

input overrideValue popupOpen selectedIndex

Methods

AddRef QueryInterface Release closePopup invalidate openAutocompletePopup selectBy

Properties

Readonly input

input: nsIAutoCompleteInput

The input object that the popup is currently bound to

Readonly overrideValue

overrideValue: string

An alternative value to be used when text is entered, rather than the value of the selected item

Readonly popupOpen

popupOpen: boolean

Indicates if the popup is currently open

selectedIndex

selectedIndex: number

The index of the result item that is currently selected

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

closePopup

  • Close the popup and detach from the bound input

    Returns void

invalidate

  • Instruct the result view to repaint itself to reflect the most current underlying data

    Parameters

    • reason: number

      The reason the popup needs to be invalidated, one of the INVALIDATE_REASON consts.

    Returns void

openAutocompletePopup

  • Bind the popup to an input object and display it with the given coordinates

    Parameters

    • input: nsIAutoCompleteInput

      The input object that the popup will be bound to

    • element: Element

      The element that the popup will be aligned with

    Returns void

selectBy

  • Change the selection relative to the current selection and make sure the newly selected row is visible

    Returns

    The currently selected result item index

    Parameters

    • reverse: boolean

      Select a row above the current selection

    • page: boolean

      Select a row that is a full visible page from the current selection

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc