Interface nsIAutoCompleteControllerType

Hierarchy

Properties

input matchCount searchStatus searchString

Methods

AddRef QueryInterface Release getCommentAt getFinalCompleteValueAt getImageAt getLabelAt getStyleAt getValueAt handleDelete handleEndComposition handleEnter handleEscape handleKeyNavigation handleStartComposition handleTab handleText resetInternalState setInitiallySelectedIndex startSearch stopSearch

Properties

input

input: nsIAutoCompleteInput

The input widget that is currently being controlled.

Readonly matchCount

matchCount: number

The number of matches

Readonly searchStatus

searchStatus: number

State which indicates the status of possible ongoing searches

searchString

searchString: string

Get / set the current search string. Note, setting will not start searching

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

getCommentAt

  • Get the comment of the result at a given index in the last completed search

    Parameters

    • index: number

    Returns string

getFinalCompleteValueAt

  • For the last completed search, get the final value that should be completed when the user confirms the match at the given index

    Parameters

    • index: number

    Returns string

getImageAt

  • Get the url of the image of the result at a given index in the last completed search

    Parameters

    • index: number

    Returns string

getLabelAt

  • Get the label of the result at a given index in the last completed search

    Parameters

    • index: number

    Returns string

getStyleAt

  • Get the style hint for the result at a given index in the last completed search

    Parameters

    • index: number

    Returns string

getValueAt

  • Get the value of the result at a given index in the last completed search

    Parameters

    • index: number

    Returns string

handleDelete

  • Notify the controller that the user chose to delete the current auto-complete result.

    Returns

    Whether the controller removed a result item.

    Returns boolean

handleEndComposition

  • Notify the controller that the user wishes to end composition

    NOTE: nsIAutoCompleteController implementation expects that this is called by DOM compositionend handler.

    Returns void

handleEnter

  • Notify the controller that the user wishes to enter the current text. If aIsPopupSelection is true, then a selection was made from the popup, so fill this value into the input field before continuing. If false, just use the current value of the input field.

    Returns

    Whether the controller wishes to prevent event propagation and default event.

    Parameters

    • aIsPopupSelection: boolean

      Pass true if the selection was made from the popup.

    • aEvent: Event

      The event that triggered the enter, like a key event if the user pressed the Return key or a click event if the user clicked a popup item.

    Returns boolean

handleEscape

  • Notify the controller that the user wishes to revert autocomplete

    Returns

    Whether the controller wishes to prevent event propagation and default event.

    Returns boolean

handleKeyNavigation

  • Notify the controller of the following key navigation events: up, down, left, right, page up, page down

    Returns

    Whether the controller wishes to prevent event propagation and default event

    Parameters

    • key: number

    Returns boolean

handleStartComposition

  • Notify the controller that the user wishes to start composition

    NOTE: nsIAutoCompleteController implementation expects that this is called by DOM compositionstart handler.

    Returns void

handleTab

  • Handle tab. Just closes up.

    Returns void

handleText

  • Notify the controller that the user has changed text in the textbox. This includes all means of changing the text value, including typing a character, backspacing, deleting, pasting, committing composition or canceling composition.

    NOTE: handleText() must be called after composition actually ends, even if the composition is canceled and the textbox value isn't changed. Then, implementation of handleText() can access the editor when it's not in composing mode. DOM compositionend event is not good timing for calling handleText(). DOM input event immediately after DOM compositionend event is the best timing to call this.

    Returns

    whether this handler started a new search.

    Returns boolean

resetInternalState

  • Reset controller internal caches for cases where the input doesn't change but its context resets, thus it is about to start a completely new search session.

    Returns void

setInitiallySelectedIndex

  • Set the index of the result item that should be initially selected. This should be used when a search wants to pre-select an element before the user starts using results.

    Note

    Setting this is not the same as just setting selectedIndex in nsIAutocompletePopup, since this will take care of updating any internal tracking variables of features like completeSelectedIndex.

    Parameters

    • index: number

    Returns void

startSearch

  • Start a search on a string, assuming the input property is already set.

    Parameters

    • searchString: string

    Returns void

stopSearch

  • Stop all asynchronous searches

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc