Move private variables/methods into local declarations not exported by AllTabs and change the interface to .register("change") instead of .onChange() for bug 584532.

--HG--
rename : browser/base/content/AllTabs.js => browser/base/content/tabview/modules/AllTabs.js
extra : rebase_source : 267110a1a1dd8cc8d4188f20285d688b2b901aa1
This commit is contained in:
Edward Lee 2010-08-09 17:19:04 -07:00
parent 20a7760e76
commit 43b7d40966
6 changed files with 176 additions and 242 deletions

View File

@ -54,7 +54,6 @@ DIRS += content/test
endif
EXTRA_JS_MODULES = \
content/AllTabs.js \
content/openLocationLastURL.jsm \
content/NetworkPrioritizer.jsm \
content/stylePanel.jsm \

View File

@ -1,220 +0,0 @@
/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is TabView AllTabs.
*
* The Initial Developer of the Original Code is
* Mozilla Foundation.
* Portions created by the Initial Developer are Copyright (C) 2010
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Edward Lee <edilee@mozilla.com>
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
const Cc = Components.classes;
const Ci = Components.interfaces;
const Cu = Components.utils;
const Cr = Components.results;
Cu.import("resource://gre/modules/Services.jsm");
let EXPORTED_SYMBOLS = ["AllTabs"];
let AllTabs = {
//////////////////////////////////////////////////////////////////////////////
//// Public
//////////////////////////////////////////////////////////////////////////////
/**
* Get an array of all tabs from all tabbrowser windows.
*
* @usage let numAllTabs = AllTabs.tabs.length;
* AllTabs.tabs.forEach(handleAllTabs);
*/
get tabs() {
// Get tabs from each browser window and flatten them into one array
let browserWindows = AllTabs.allBrowserWindows;
return Array.concat.apply({}, browserWindows.map(function(browserWindow) {
return Array.slice(browserWindow.gBrowser.tabs);
}));
},
/**
* Attach a callback for when a tab's attributes change such as title, busy
* state, icon, etc.
*
* There is also an unbind method off of this method to remove the callback.
*
* @param callback
* Callback that gets called with the tab being changed as "this" and
* the event as the first argument.
* @usage AllTabs.onChange(handleChange);
* AllTabs.onChange.unbind(handleChange);
*/
get onChange() AllTabs.makeBind("onChange"),
/**
* Attach a callback for when a tab is closed.
*
* There is also an unbind method off of this method to remove the callback.
*
* @param callback
* Callback that gets called with the tab being closed as "this" and
* the event as the first argument.
* @usage AllTabs.onClose(handleClose);
* AllTabs.onClose.unbind(handleClose);
*/
get onClose() AllTabs.makeBind("onClose"),
/**
* Attach a callback for when a tab is moved.
*
* There is also an unbind method off of this method to remove the callback.
*
* @param callback
* Callback that gets called with the tab being moved as "this" and
* the event as the first argument.
* @usage AllTabs.onMove(handleMove);
* AllTabs.onMove.unbind(handleMove);
*/
get onMove() AllTabs.makeBind("onMove"),
/**
* Attach a callback for when a tab is opened.
*
* There is also an unbind method off of this method to remove the callback.
*
* @param callback
* Callback that gets called with the tab being opened as "this" and
* the event as the first argument.
* @usage AllTabs.onOpen(handleOpen);
* AllTabs.onOpen.unbind(handleOpen);
*/
get onOpen() AllTabs.makeBind("onOpen"),
/**
* Attach a callback for when a tab is selected.
*
* There is also an unbind method off of this method to remove the callback.
*
* @param callback
* Callback that gets called with the tab being selected as "this" and
* the event as the first argument.
* @usage AllTabs.onSelect(handleSelect);
* AllTabs.onSelect.unbind(handleSelect);
*/
get onSelect() AllTabs.makeBind("onSelect"),
//////////////////////////////////////////////////////////////////////////////
//// Private
//////////////////////////////////////////////////////////////////////////////
get allBrowserWindows() {
let browserWindows = [];
let windows = Services.wm.getEnumerator("navigator:browser");
while (windows.hasMoreElements())
browserWindows.push(windows.getNext());
return browserWindows;
},
eventMap: {
TabAttrModified: "onChange",
TabClose: "onClose",
TabMove: "onMove",
TabOpen: "onOpen",
TabSelect: "onSelect",
},
registerBrowserWindow: function registerBrowserWindow(browserWindow) {
// Add a listener for each tab even to trigger the matching topic
[i for (i in Iterator(AllTabs.eventMap))].forEach(function([tabEvent, topic]) {
browserWindow.addEventListener(tabEvent, function(event) {
AllTabs.trigger(topic, event.originalTarget, event);
}, true);
});
},
listeners: {},
makeBind: function makeBind(topic) {
delete AllTabs[topic];
AllTabs.listeners[topic] = [];
// Allow adding listeners to this topic
AllTabs[topic] = function bind(callback) {
AllTabs.listeners[topic].push(callback);
};
// Allow removing listeners from this topic
AllTabs[topic].unbind = function unbind(callback) {
let index = AllTabs.listeners[topic].indexOf(callback);
if (index != -1)
AllTabs.listeners[topic].splice(index, 1);
};
return AllTabs[topic];
},
trigger: function trigger(topic, tab, event) {
// Make sure we've gotten listeners before trying to call
let listeners = AllTabs.listeners[topic];
if (listeners == null)
return;
// Make a copy of the listeners, so it can't change as we call back
listeners.slice().forEach(function(callback) {
try {
callback.call(tab, event);
}
// Ignore failures from the callback
catch(ex) {}
});
},
//////////////////////////////////////////////////////////////////////////////
//// nsIObserver
//////////////////////////////////////////////////////////////////////////////
observe: function observe(subject, topic, data) {
switch (topic) {
case "domwindowopened":
subject.addEventListener("load", function() {
subject.removeEventListener("load", arguments.callee, false);
// Now that the window has loaded, only register on browser windows
let doc = subject.document.documentElement;
if (doc.getAttribute("windowtype") == "navigator:browser")
AllTabs.registerBrowserWindow(subject);
}, false);
break;
}
},
};
// Register listeners on all browser windows and future ones
AllTabs.allBrowserWindows.forEach(AllTabs.registerBrowserWindow);
Services.obs.addObserver(AllTabs, "domwindowopened", false);

View File

@ -0,0 +1,159 @@
/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is TabView AllTabs.
*
* The Initial Developer of the Original Code is
* Mozilla Foundation.
* Portions created by the Initial Developer are Copyright (C) 2010
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Edward Lee <edilee@mozilla.com>
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
const Cc = Components.classes;
const Ci = Components.interfaces;
const Cu = Components.utils;
const Cr = Components.results;
Cu.import("resource://gre/modules/Services.jsm");
let EXPORTED_SYMBOLS = ["AllTabs"];
let AllTabs = {
/**
* Get an array of all tabs from all tabbrowser windows.
*
* @usage let numAllTabs = AllTabs.tabs.length;
* AllTabs.tabs.forEach(handleAllTabs);
*/
get tabs() {
// Get tabs from each browser window and flatten them into one array
return Array.concat.apply(null, browserWindows.map(function(browserWindow) {
return Array.slice(browserWindow.gBrowser.tabs);
}));
},
/**
* Attach a callback for a given tab event.
*
* @param eventName
* Name of the corresponding Tab* Event; one of "attrModified",
* "close", "move", "open", "select".
* @param callback
* Callback that gets called with the tab as the first argument and
* the event as the second argument.
* @usage AllTabs.register("change", function handleChange(tab, event) {});
*/
register: function register(eventName, callback) {
// Either create the first entry or add additional callbacks
let listeners = eventListeners[eventName];
if (listeners == null)
eventListeners[eventName] = [callback];
else
listeners.push(callback);
},
/**
* Remove a callback for a given tab event.
*
* @param eventName
* Name of the corresponding Tab* Event; one of "attrModified",
* "close", "move", "open", "select".
* @param callback
* The callback given for the original AllTabs.register call.
* @usage AllTabs.unregister("close", handleClose);
*/
unregister: function unregister(eventName, callback) {
// Nothing to remove for this event
let listeners = eventListeners[eventName];
if (listeners == null)
return;
// Can only remove a callback if we have it
let index = listeners.indexOf(callback);
if (index == -1)
return;
listeners.splice(index, 1);
}
};
__defineGetter__("browserWindows", function browserWindows() {
let browserWindows = [];
let windows = Services.wm.getEnumerator("navigator:browser");
while (windows.hasMoreElements())
browserWindows.push(windows.getNext());
return browserWindows;
});
let events = ["attrModified", "close", "move", "open", "select"];
let eventListeners = {};
function registerBrowserWindow(browserWindow) {
events.forEach(function(eventName) {
let tabEvent = "Tab" + eventName[0].toUpperCase() + eventName.slice(1);
browserWindow.addEventListener(tabEvent, function(event) {
// Make sure we've gotten listeners before trying to call
let listeners = eventListeners[eventName];
if (listeners == null)
return;
let tab = event.originalTarget;
// Make a copy of the listeners, so it can't change as we call back
listeners.slice().forEach(function(callback) {
try {
callback(tab, event);
}
// Ignore failures from the callback
catch(ex) {}
});
}, true);
});
}
let observer = {
observe: function observe(subject, topic, data) {
switch (topic) {
case "domwindowopened":
subject.addEventListener("load", function() {
subject.removeEventListener("load", arguments.callee, false);
// Now that the window has loaded, only register on browser windows
let doc = subject.document.documentElement;
if (doc.getAttribute("windowtype") == "navigator:browser")
registerBrowserWindow(subject);
}, false);
break;
}
}
};
// Register listeners on all browser windows and future ones
browserWindows.forEach(registerBrowserWindow);
Services.obs.addObserver(observer, "domwindowopened", false);

View File

@ -606,7 +606,6 @@ window.TabItem.prototype = Utils.extend(new Item(), new Subscribable(), {
// Function: zoomOut
// Handles the zoom down animation after returning to TabView.
// It is expected that this routine will be called from the chrome thread
// (in response to AllTabs.onFocus()).
//
// Parameters:
// complete - a function to call after the zoom down animation
@ -706,11 +705,10 @@ window.TabItems = {
var self = this;
// When a tab is opened, create the TabItem
AllTabs.onOpen(function() {
if (this.ownerDocument.defaultView != gWindow)
AllTabs.register("open", function(tab) {
if (tab.ownerDocument.defaultView != gWindow)
return;
var tab = this;
Utils.timeout(function() { // Marshal event from chrome thread to DOM thread
self.link(tab);
}, 1);
@ -718,22 +716,20 @@ window.TabItems = {
// When a tab's content is loaded, show the canvas and hide the cached data
// if necessary.
AllTabs.onChange(function() {
if (this.ownerDocument.defaultView != gWindow)
AllTabs.register("attrModified", function(tab) {
if (tab.ownerDocument.defaultView != gWindow)
return;
let tab = this;
Utils.timeout(function() { // Marshal event from chrome thread to DOM thread
self.update(tab);
}, 1);
});
// When a tab is closed, unlink.
AllTabs.onClose(function() {
if (this.ownerDocument.defaultView != gWindow)
AllTabs.register("close", function(tab) {
if (tab.ownerDocument.defaultView != gWindow)
return;
var tab = this;
Utils.timeout(function() { // Marshal event from chrome thread to DOM thread
self.unlink(tab);
}, 1);

View File

@ -2,9 +2,9 @@
// The file should be removed before we ship.
#include profile.js
Components.utils.import("resource://gre/modules/tabview/AllTabs.js");
Components.utils.import("resource://gre/modules/tabview/groups.js");
Components.utils.import("resource://gre/modules/tabview/utils.js");
Components.utils.import("resource://gre/modules/AllTabs.js");
Components.utils.import("resource://gre/modules/Services.jsm");
Components.utils.import("resource://gre/modules/XPCOMUtils.jsm");

View File

@ -380,13 +380,13 @@ var UIManager = {
_addTabActionHandlers: function() {
var self = this;
AllTabs.onClose(function() {
if (this.ownerDocument.defaultView != gWindow)
AllTabs.register("close", function(tab) {
if (tab.ownerDocument.defaultView != gWindow)
return;
if (self._isTabViewVisible()) {
// just closed the selected tab in the TabView interface.
if (self._currentTab == this)
if (self._currentTab == tab)
self._closedSelectedTabInTabView = true;
} else {
// if not closing the last tab
@ -405,8 +405,8 @@ var UIManager = {
// for the tab focus event to pick up.
self._closedLastVisibleTab = true;
// remove the zoom prep.
if (this && this.tabItem)
this.tabItem.setZoomPrep(false);
if (tab && tab.tabItem)
tab.tabItem.setZoomPrep(false);
self.showTabView();
}
// ToDo: When running unit tests, everything happens so quick so
@ -422,8 +422,8 @@ var UIManager = {
return false;
});
AllTabs.onMove(function() {
if (this.ownerDocument.defaultView != gWindow)
AllTabs.register("move", function(tab) {
if (tab.ownerDocument.defaultView != gWindow)
return;
Utils.timeout(function() { // Marshal event from chrome thread to DOM thread
@ -433,11 +433,11 @@ var UIManager = {
}, 1);
});
AllTabs.onSelect(function() {
if (this.ownerDocument.defaultView != gWindow)
AllTabs.register("select", function(tab) {
if (tab.ownerDocument.defaultView != gWindow)
return;
self.tabOnFocus(this);
self.tabOnFocus(tab);
});
},