mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-10-30 05:35:31 +00:00
c003484018
MozReview-Commit-ID: 9B0RaOJjTxc --HG-- extra : rebase_source : e54638698e900df15136e70a88c8df80032ea70b
143 lines
4.2 KiB
JavaScript
143 lines
4.2 KiB
JavaScript
/* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this file,
|
|
* You can obtain one at http://mozilla.org/MPL/2.0/. */
|
|
|
|
"use strict";
|
|
|
|
const { classes: Cc, interfaces: Ci, utils: Cu } = Components;
|
|
Cu.import("resource://gre/modules/XPCOMUtils.jsm");
|
|
Cu.import("resource://gre/modules/Services.jsm");
|
|
Cu.import("resource://gre/modules/Messaging.jsm");
|
|
|
|
this.EXPORTED_SYMBOLS = ["BrowserActions"];
|
|
|
|
var BrowserActions = {
|
|
_browserActions: {},
|
|
|
|
_initialized: false,
|
|
|
|
_nextMenuId: 0,
|
|
|
|
/**
|
|
* Registers the listeners only if they have not been initialized
|
|
* already and there is at least one browser action.
|
|
*/
|
|
_maybeRegisterListeners() {
|
|
if (!this._initialized && Object.keys(this._browserActions).length) {
|
|
this._initialized = true;
|
|
EventDispatcher.instance.registerListener(this, "Menu:BrowserActionClicked");
|
|
}
|
|
},
|
|
|
|
/**
|
|
* Unregisters the listeners if they are already initizliaed and
|
|
* all of the browser actions have been removed.
|
|
*/
|
|
_maybeUnregisterListeners() {
|
|
if (this._initialized && !Object.keys(this._browserActions).length) {
|
|
this._initialized = false;
|
|
EventDispatcher.instance.unregisterListener(this, "Menu:BrowserActionClicked");
|
|
}
|
|
},
|
|
|
|
/**
|
|
* Called when a browser action is clicked on.
|
|
* @param {string} event The name of the event, which should always
|
|
* be "Menu:BrowserActionClicked".
|
|
* @param {Object} data An object containing information about the
|
|
* browser action, which in this case should contain an `item`
|
|
* property which is browser action's ID.
|
|
*/
|
|
onEvent(event, data) {
|
|
if (event !== "Menu:BrowserActionClicked") {
|
|
throw new Error(`Expected "Menu:BrowserActionClicked" event - received "${event}" instead`);
|
|
}
|
|
|
|
let browserAction = this._browserActions[data.item];
|
|
if (!browserAction) {
|
|
throw new Error(`No browser action found with id ${data.item}`);
|
|
}
|
|
browserAction.onClicked();
|
|
},
|
|
|
|
/**
|
|
* Registers a new browser action.
|
|
* @param {Object} browserAction The browser action to add.
|
|
*/
|
|
register(browserAction) {
|
|
EventDispatcher.instance.sendRequest({
|
|
type: "Menu:AddBrowserAction",
|
|
id: this._nextMenuId++,
|
|
uuid: browserAction.uuid,
|
|
name: browserAction.name,
|
|
});
|
|
|
|
this._browserActions[browserAction.uuid] = browserAction;
|
|
|
|
this._maybeRegisterListeners();
|
|
},
|
|
|
|
/**
|
|
* Updates the browser action with the specified UUID.
|
|
* @param {string} uuid The UUID of the browser action.
|
|
* @param {Object} options The properties to update.
|
|
*/
|
|
update(uuid, options) {
|
|
if (options.name) {
|
|
EventDispatcher.instance.sendRequest({
|
|
type: "Menu:UpdateBrowserAction",
|
|
uuid,
|
|
options,
|
|
});
|
|
}
|
|
},
|
|
|
|
/**
|
|
* Retrieves the name currently used for the browser action with the
|
|
* specified UUID. Used for testing only.
|
|
* @param {string} uuid The UUID of the browser action.
|
|
* @returns {string} the name currently used for the browser action.
|
|
*/
|
|
getNameForActiveTab(uuid) {
|
|
return this._browserActions[uuid].activeName;
|
|
},
|
|
|
|
/**
|
|
* Checks to see if the browser action is shown. Used for testing only.
|
|
* @param {string} uuid The UUID of the browser action.
|
|
* @returns {boolean} true if the browser action is shown; false otherwise.
|
|
*/
|
|
isShown(uuid) {
|
|
return !!this._browserActions[uuid];
|
|
},
|
|
|
|
/**
|
|
* Synthesizes a click on the browser action. Used for testing only.
|
|
* @param {string} uuid The UUID of the browser action.
|
|
*/
|
|
synthesizeClick(uuid) {
|
|
let browserAction = this._browserActions[uuid];
|
|
if (!browserAction) {
|
|
throw new Error(`No BrowserAction with UUID ${uuid} was found`);
|
|
}
|
|
browserAction.onClicked();
|
|
},
|
|
|
|
/**
|
|
* Unregisters the browser action with the specified ID.
|
|
* @param {string} uuid The UUID of the browser action.
|
|
*/
|
|
unregister(uuid) {
|
|
let browserAction = this._browserActions[uuid];
|
|
if (!browserAction) {
|
|
throw new Error(`No BrowserAction with UUID ${uuid} was found`);
|
|
}
|
|
EventDispatcher.instance.sendRequest({
|
|
type: "Menu:RemoveBrowserAction",
|
|
uuid,
|
|
});
|
|
delete this._browserActions[uuid];
|
|
this._maybeUnregisterListeners();
|
|
}
|
|
}
|