nsIAutoCompleteController

Mis en œuvre avec: @mozilla.org/autocomplete/controller;1 . Pour utiliser ce service:

var autoCompleteController = Components.classes["@mozilla.org/autocomplete/controller;1"]
                             .getService(Components.interfaces.nsIAutoCompleteController);

Aperçu des méthodes

Attributes

Constants

Status Constants

Key Constants

Methods

getCommentAt()

Gets the comment of the result at a given index in the last completed search.

AString getCommentAt(
  in long index
);

Parameters

index

The given index.

Return value

The comment of the result at the given index.

getImageAt()

Get the URL of the image of the result at a given index in the last completed search.

AString getImageAt(
  in long index
);

Parameters

index

The given index.

Return value

The image URL of the result at the given index.

getLabelAt()

Gets the label for the result at a given index in the last completed search. Normally this is the same as the value, except when autocompleting a datalist in a web page.

AString getLabelAt(
  in long index
);

Parameters

index

The given index.

Return value

The label for the result at the given index.

getStyleAt()

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

AString getStyleAt(
  in long index
);

Parameters

index

The given index.

Return value

The style hint for the result at the given index.

getValueAt()

Gets the value of the result at a given index in the last completed search.

AString getValueAt(
  in long index
);

Parameters

index

The given index value.

Return value

The value of the result at the given index.

handleDelete()

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

boolean handleDelete();

Parameters

None.

Return value

Returns true if the event that called handleDelete() should be canceled, otherwise returns false.

handleEndComposition()

void handleEndComposition();

Parameters

None.

handleEnter()

Notifies the controller that the user wishes to enter the current text.

boolean handleEnter(
  in boolean aIsPopupSelection 
);

Parameters

aIsPopupSelection

true if a selection was made from the popup (That is the currently selected entry's value will entered into the input). false to indicate that the input's current value should be used. Typically used to differentiate between selections made with the mouse (which do not result in the input value being changed) and selections made with the keyboard (which may or may not result in the input's value changing, depending on the nsIAutocompleteInput's completeSelectedIndex attribute). See bug 408723 for more information.

Return value

true if the controller wishes to prevent event propagation and default event.

handleEscape()

Notifies the controller that the user wishes to revert autocomplete.

boolean handleEscape();

Parameters

None.

Return value

true if the controller wishes to prevent event propagation and default event.

handleKeyNavigation()

Notifies the controller of the following key navigation events: up, down, left, right, page up, page down.

boolean handleKeyNavigation(
  in unsigned long key
);

Parameters

key

The key for the navigation event.

Return value

true if the controller wishes to prevent event propagation and default event.

handleStartComposition()

Notify the controller that the user wishes to start composition.

void handleStartComposition();

Parameters

None.

handleTab()

Handles tab; this just closes autocomplete.

void handleTab();

Parameters

None.

handleText()

Notifies 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, or pasting in an entirely new value.

void handleText(
  in boolean aIgnoreSelection  Obsolète depuis Gecko 1.9.2
);

Parameters

setSearchString()

void setSearchString(
  in AString aSearchString
);

Parameters

aIgnoreSelection Obsolète depuis Gecko 1.9.2

true to allow the text handling to occur regardless of where the caret is in the text box; false to only start the search to begin or resume if the caret is at the end of the text box.

aSearchString

A string to use in searches.

startSearch()

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

void startSearch(
  in AString searchString
);

Parameters

searchString

The string to start searching on.

stopSearch()

Stops all asynchronous searches.

void stopSearch();

Parameters

None.