Как сделать пользовательское автозаполнение текстового поля для панели инструментов Firefox?

Question

ОБНОВЛЕНИЕ: Нашли решение самостоятельно, см. Ответ

Answer 1

Я нашел решение самостоятельно, надеюсь, что это поможет кому-то.

я должен был сделать именно так:

В удлиняющем реже я создал новый реж под названием «компоненты».

Внутри этого каталога я создаю файл js с моим пользовательским автозаполнением, в данном случае «simpleautocomplete.js». Содержание этого Js файла:

/* 
* https://developer.mozilla.org/en/How_to_implement_custom_autocomplete_search_component 
*/ 
const Ci = Components.interfaces; 

const CLASS_ID = Components.ID("6224daa1-71a2-4d1a-ad90-01ca1c08e323"); 
const CLASS_NAME = "Simple AutoComplete"; 
const CONTRACT_ID = "@mozilla.org/autocomplete/search;1?name=simple-autocomplete"; 

try{ 
    Components.utils.import("resource://gre/modules/XPCOMUtils.jsm"); 
} catch (x) { 
} 


// Implements nsIAutoCompleteResult 
function SimpleAutoCompleteResult(searchString, searchResult, 
            defaultIndex, errorDescription, 
            results, comments) { 
    this._searchString = searchString; 
    this._searchResult = searchResult; 
    this._defaultIndex = defaultIndex; 
    this._errorDescription = errorDescription; 
    this._results = results; 
    this._comments = comments; 
} 

SimpleAutoCompleteResult.prototype = { 
    _searchString: "", 
    _searchResult: 0, 
    _defaultIndex: 0, 
    _errorDescription: "", 
    _results: [], 
    _comments: [], 

    getLabelAt: function(index) { return this._results[index]; }, 

    /** 
    * The original search string 
    */ 
    get searchString() { 
    return this._searchString; 
    }, 

    /** 
    * The result code of this result object, either: 
    *   RESULT_IGNORED (invalid searchString) 
    *   RESULT_FAILURE (failure) 
    *   RESULT_NOMATCH (no matches found) 
    *   RESULT_SUCCESS (matches found) 
    */ 
    get searchResult() { 
    return this._searchResult; 
    }, 

    /** 
    * Index of the default item that should be entered if none is selected 
    */ 
    get defaultIndex() { 
    return this._defaultIndex; 
    }, 

    /** 
    * A string describing the cause of a search failure 
    */ 
    get errorDescription() { 
    return this._errorDescription; 
    }, 

    /** 
    * The number of matches 
    */ 
    get matchCount() { 
    return this._results.length; 
    }, 

    /** 
    * Get the value of the result at the given index 
    */ 
    getValueAt: function(index) { 
    return this._results[index]; 
    }, 

    /** 
    * Get the comment of the result at the given index 
    */ 
    getCommentAt: function(index) { 
    return this._comments[index]; 
    }, 

    /** 
    * Get the style hint for the result at the given index 
    */ 
    getStyleAt: function(index) { 
    if (!this._comments[index]) 
     return null; // not a category label, so no special styling 

    if (index == 0) 
     return "suggestfirst"; // category label on first line of results 

    return "suggesthint"; // category label on any other line of results 
    }, 

    /** 
    * Get the image for the result at the given index 
    * The return value is expected to be an URI to the image to display 
    */ 
    getImageAt : function (index) { 
    return ""; 
    }, 

    /** 
    * Remove the value at the given index from the autocomplete results. 
    * If removeFromDb is set to true, the value should be removed from 
    * persistent storage as well. 
    */ 
    removeValueAt: function(index, removeFromDb) { 
    this._results.splice(index, 1); 
    this._comments.splice(index, 1); 
    }, 

    QueryInterface: function(aIID) { 
    if (!aIID.equals(Ci.nsIAutoCompleteResult) && !aIID.equals(Ci.nsISupports)) 
     throw Components.results.NS_ERROR_NO_INTERFACE; 
    return this; 
    } 
}; 


// Implements nsIAutoCompleteSearch 
function SimpleAutoCompleteSearch() { 
} 

SimpleAutoCompleteSearch.prototype = { 
    classID: CLASS_ID, 
    classDescription: CLASS_NAME, 
    contractID: CONTRACT_ID, 

    /* 
    * Search for a given string and notify a listener (either synchronously 
    * or asynchronously) of the result 
    * 
    * @param searchString - The string to search for 
    * @param searchParam - An extra parameter 
    * @param previousResult - A previous result to use for faster searchinig 
    * @param listener - A listener to notify when the search is complete 
    */ 
    startSearch: function(searchString, searchParam, result, listener) { 
    // This autocomplete source assumes the developer attached a JSON string 
    // to the the "autocompletesearchparam" attribute or "searchParam" property 
    // of the <textbox> element. The JSON is converted into an array and used 
    // as the source of match data. Any values that match the search string 
    // are moved into temporary arrays and passed to the AutoCompleteResult 
    if (searchParam.length > 0) { 
     var nativeJSON = Components.classes["@mozilla.org/dom/json;1"].createInstance(Ci.nsIJSON); 
     var searchResults = nativeJSON.decode(searchParam); 
     var results = []; 
     var comments = []; 
     for (i=0; i<searchResults.length; i++) { 
     if (searchResults[i].value.indexOf(searchString) == 0) { 
      results.push(searchResults[i].value); 
      if (searchResults[i].comment) 
      comments.push(searchResults[i].comment); 
      else 
      comments.push(null); 
     } 
     } 
     var newResult = new SimpleAutoCompleteResult(searchString, Ci.nsIAutoCompleteResult.RESULT_SUCCESS, 0, "", results, comments); 
     listener.onSearchResult(this, newResult); 
    } 
    }, 

    /* 
    * Stop an asynchronous search that is in progress 
    */ 
    stopSearch: function() { 
    }, 

    QueryInterface: function(aIID) { 
    if (!aIID.equals(Ci.nsIAutoCompleteSearch) && !aIID.equals(Ci.nsISupports)) 
     throw Components.results.NS_ERROR_NO_INTERFACE; 
    return this; 
    }, 
    _QueryInterface: XPCOMUtils.generateQI([Components.interfaces.nsIAutoCompleteSearch]) 
}; 

// Factory 
var SimpleAutoCompleteSearchFactory = { 
    singleton: null, 
    createInstance: function (aOuter, aIID) { 
    if (aOuter != null) 
     throw Components.results.NS_ERROR_NO_AGGREGATION; 
    if (this.singleton == null) 
     this.singleton = new SimpleAutoCompleteSearch(); 
    return this.singleton.QueryInterface(aIID); 
    } 
}; 

// Module 
var SimpleAutoCompleteSearchModule = { 
    registerSelf: function(aCompMgr, aFileSpec, aLocation, aType) { 
    aCompMgr = aCompMgr.QueryInterface(Components.interfaces.nsIComponentRegistrar); 
    aCompMgr.registerFactoryLocation(CLASS_ID, CLASS_NAME, CONTRACT_ID, aFileSpec, aLocation, aType); 
    }, 

    unregisterSelf: function(aCompMgr, aLocation, aType) { 
    aCompMgr = aCompMgr.QueryInterface(Components.interfaces.nsIComponentRegistrar); 
    aCompMgr.unregisterFactoryLocation(CLASS_ID, aLocation);   
    }, 

    getClassObject: function(aCompMgr, aCID, aIID) { 
    if (!aIID.equals(Components.interfaces.nsIFactory)) 
     throw Components.results.NS_ERROR_NOT_IMPLEMENTED; 

    if (aCID.equals(CLASS_ID)) 
     return SimpleAutoCompleteSearchFactory; 

    throw Components.results.NS_ERROR_NO_INTERFACE; 
    }, 

    canUnload: function(aCompMgr) { return true; } 
}; 

// Module initialization 
function NSGetModule(aCompMgr, aFileSpec) { return SimpleAutoCompleteSearchModule; } 

if (XPCOMUtils.generateNSGetFactory){ 
    var NSGetFactory = XPCOMUtils.generateNSGetFactory([SimpleAutoCompleteSearch]); 
} 

Я добавил этот код chrome.manifest:

component {6224daa1-71a2-4d1a-ad90-01ca1c08e323} components/simpleautocomplete.js 
contract @mozilla.org/autocomplete/search;1?name=simple-autocomplete {6224daa1-71a2-4d1a-ad90-01ca1c08e323} 

В XUL файл я добавил:

<textbox type="autocomplete" autocompletesearch="simple-autocomplete" 
autocompletesearchparam='[{"value":"param1"},{"value":"param2"}]' /> 

важное замечание: при установке атрибут autocompletesearchparam, присваивание должно содержать две одинарные кавычки, а не двойные кавычки. только значения внутри должны быть в двойных кавычках, как в xul выше.

и все.

Когда я проверил свое расширение и набрал «p» в текстовом поле с автозаполнением, всплывали слова «param1» и «param2».

Я мог бы также установить Params в файле JS следующим образом:

var searchTextField = document.getElementById("searchTextField"); 
var param1 = "Param1", param2 = "Param2"; 
paramsToSet = "["; 

paramsToSet += "{\"value\" : \"" + param1 + "\"},"; 
paramsToSet += "{\"value\" : \"" + param2 + "\"},"; 

paramsToSet = paramsToSet.substring(0, paramsToSet.length-1); // to remove the last "," 
paramsToSet += "]"; 
paramsToSet = paramsToSet.toLowerCase(); // important! 
searchTextField.setAttribute("autocompletesearchparam", paramsToSet); 

Note1: обратите внимание, что автоматическое заполнение текстового поля принимает только текст строчными буквами.

примечание2: если установка параметров в текстовое поле выполняется динамически и занимает некоторое время, например, - когда клиент печатает текст в текстовом поле, а напечатанный текст отправляется на сервер, поэтому ответ, содержащий параметры, будет прикреплен к текстовое поле, и этот процесс занимает некоторое время (примерно в секунду или половину), тогда всплывающее автоматическое заполнение не будет всплывать, потому что autocompletesearchparam был пуст, когда клиент начал вводить текст. В этом случае можно заставить автозаполнение всплывать, когда у вас есть Params, чтобы установить в текстовом поле, как это:

searchTextField.open = true;