wine/gecko
0
0
Fork 0
mirror of https://gitlab.winehq.org/wine/wine-gecko.git synced 2024-09-13 09:24:08 -07:00
Code Issues Packages Projects Releases Wiki Activity
e5ef82c729
gecko/browser/base/content/tabview/groupitems.js

2441 lines
74 KiB
JavaScript
Raw Blame History

/* ***** 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 groupItems.js.
*
* The Initial Developer of the Original Code is
* the Mozilla Foundation.
* Portions created by the Initial Developer are Copyright (C) 2010
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Ian Gilman <ian@iangilman.com>
* Aza Raskin <aza@mozilla.com>
* Michael Yoshitaka Erlewine <mitcho@mitcho.com>
* Ehsan Akhgari <ehsan@mozilla.com>
* Raymond Lee <raymond@appcoast.com>
* Tim Taubert <tim.taubert@gmx.de>
* Sean Dunn <seanedunn@yahoo.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 ***** */
// **********
// Title: groupItems.js
// ##########
// Class: GroupItem
// A single groupItem in the TabView window. Descended from <Item>.
// Note that it implements the <Subscribable> interface.
//
// ----------
// Constructor: GroupItem
//
// Parameters:
// listOfEls - an array of DOM elements for tabs to be added to this groupItem
// options - various options for this groupItem (see below). In addition, gets passed
// to <add> along with the elements provided.
//
// Possible options:
// id - specifies the groupItem's id; otherwise automatically generated
// locked - see <Item.locked>; default is {}
// userSize - see <Item.userSize>; default is null
// bounds - a <Rect>; otherwise based on the locations of the provided elements
// container - a DOM element to use as the container for this groupItem; otherwise will create
// title - the title for the groupItem; otherwise blank
// dontPush - true if this groupItem shouldn't push away on creation; default is false
// dontPush - true if this groupItem shouldn't push away or snap on creation; default is false
// immediately - true if we want all placement immediately, not with animation
function GroupItem(listOfEls, options) {
if (!options)
options = {};
this._inited = false;
this._uninited = false;
this._children = []; // an array of Items
this.defaultSize = new Point(TabItems.tabWidth * 1.5, TabItems.tabHeight * 1.5);
this.isAGroupItem = true;
this.id = options.id || GroupItems.getNextID();
this._isStacked = false;
this.expanded = null;
this.locked = (options.locked ? Utils.copy(options.locked) : {});
this.topChild = null;
this.hidden = false;
this.fadeAwayUndoButtonDelay = 15000;
this.fadeAwayUndoButtonDuration = 300;
this.keepProportional = false;
// Double click tracker
this._lastClick = 0;
this._lastClickPositions = null;
// Variable: _activeTab
// The <TabItem> for the groupItem's active tab.
this._activeTab = null;
if (Utils.isPoint(options.userSize))
this.userSize = new Point(options.userSize);
var self = this;
var rectToBe;
if (options.bounds) {
Utils.assert(Utils.isRect(options.bounds), "options.bounds must be a Rect");
rectToBe = new Rect(options.bounds);
}
if (!rectToBe) {
rectToBe = GroupItems.getBoundingBox(listOfEls);
rectToBe.inset(-30, -30);
}
var $container = options.container;
let immediately = options.immediately || $container ? true : false;
if (!$container) {
$container = iQ('<div>')
.addClass('groupItem')
.css({position: 'absolute'})
.css(rectToBe);
}
this.bounds = $container.bounds();
this.isDragging = false;
$container
.css({zIndex: -100})
.appendTo("body");
// ___ New Tab Button
this.$ntb = iQ("<div>")
.addClass('newTabButton')
.click(function() {
self.newTab();
})
.attr('title', tabviewString('groupItem.newTabButton'))
.appendTo($container);
// ___ Resizer
this.$resizer = iQ("<div>")
.addClass('resizer')
.appendTo($container)
.hide();
// ___ Titlebar
var html =
"<div class='title-container'>" +
"<input class='name' placeholder='" + this.defaultName + "'/>" +
"<div class='title-shield' />" +
"</div>";
this.$titlebar = iQ('<div>')
.addClass('titlebar')
.html(html)
.appendTo($container);
this.$closeButton = iQ('<div>')
.addClass('close')
.click(function() {
self.closeAll();
})
.appendTo($container);
// ___ Title
this.$titleContainer = iQ('.title-container', this.$titlebar);
this.$title = iQ('.name', this.$titlebar);
this.$titleShield = iQ('.title-shield', this.$titlebar);
this.setTitle(options.title);
var handleKeyDown = function(e) {
if (e.which == 13 || e.which == 27) { // return & escape
(self.$title)[0].blur();
self.$title
.addClass("transparentBorder")
.one("mouseout", function() {
self.$title.removeClass("transparentBorder");
});
e.stopPropagation();
e.preventDefault();
}
};
var handleKeyUp = function(e) {
// NOTE: When user commits or cancels IME composition, the last key
// event fires only a keyup event. Then, we shouldn't take any
// reactions but we should update our status.
self.adjustTitleSize();
self.save();
};
this.$title
.blur(function() {
self.$titleShield.show();
})
.focus(function() {
if (self.locked.title) {
(self.$title)[0].blur();
return;
}
(self.$title)[0].select();
})
.keydown(handleKeyDown)
.keyup(handleKeyUp);
if (this.locked.title)
this.$title.addClass('name-locked');
else {
this.$titleShield
.mousedown(function(e) {
self.lastMouseDownTarget = (Utils.isLeftClick(e) ? e.target : null);
})
.mouseup(function(e) {
var same = (e.target == self.lastMouseDownTarget);
self.lastMouseDownTarget = null;
if (!same)
return;
if (!self.isDragging) {
self.$titleShield.hide();
(self.$title)[0].focus();
}
});
}
// ___ Stack Expander
this.$expander = iQ("<div/>")
.addClass("stackExpander")
.appendTo($container)
.hide();
// ___ app tabs: create app tab tray and populate it
this.$appTabTray = iQ("<div/>")
.addClass("appTabTray")
.appendTo($container);
AllTabs.tabs.forEach(function(xulTab) {
if (xulTab.pinned && xulTab.ownerDocument.defaultView == gWindow)
self.addAppTab(xulTab);
});
// ___ locking
if (this.locked.bounds)
$container.css({cursor: 'default'});
if (this.locked.close)
this.$closeButton.hide();
// ___ Undo Close
this.$undoContainer = null;
this._undoButtonTimeoutId = null;
// ___ Superclass initialization
this._init($container[0]);
if (this.$debug)
this.$debug.css({zIndex: -1000});
// ___ Children
Array.prototype.forEach.call(listOfEls, function(el) {
self.add(el, options);
});
// ___ Finish Up
this._addHandlers($container);
if (!this.locked.bounds)
this.setResizable(true, immediately);
GroupItems.register(this);
// ___ Position
this.setBounds(rectToBe, immediately);
if (options.dontPush) {
this.setZ(drag.zIndex);
drag.zIndex++;
} else
// Calling snap will also trigger pushAway
this.snap(immediately);
if ($container)
this.setBounds(rectToBe, immediately);
this._inited = true;
this.save();
GroupItems.updateGroupCloseButtons();
};
// ----------
GroupItem.prototype = Utils.extend(new Item(), new Subscribable(), {
// ----------
// Variable: defaultName
// The prompt text for the title field.
defaultName: tabviewString('groupItem.defaultName'),
// -----------
// Function: setActiveTab
// Sets the active <TabItem> for this groupItem; can be null, but only
// if there are no children.
setActiveTab: function GroupItem_setActiveTab(tab) {
Utils.assertThrow((!tab && this._children.length == 0) || tab.isATabItem,
"tab must be null (if no children) or a TabItem");
this._activeTab = tab;
},
// -----------
// Function: getActiveTab
// Gets the active <TabItem> for this groupItem; can be null, but only
// if there are no children.
getActiveTab: function GroupItem_getActiveTab() {
return this._activeTab;
},
// ----------
// Function: getStorageData
// Returns all of the info worth storing about this groupItem.
getStorageData: function GroupItem_getStorageData() {
var data = {
bounds: this.getBounds(),
userSize: null,
locked: Utils.copy(this.locked),
title: this.getTitle(),
id: this.id
};
if (Utils.isPoint(this.userSize))
data.userSize = new Point(this.userSize);
return data;
},
// ----------
// Function: isEmpty
// Returns true if the tab groupItem is empty and unnamed.
isEmpty: function GroupItem_isEmpty() {
return !this._children.length && !this.getTitle();
},
// ----------
// Function: save
// Saves this groupItem to persistent storage.
save: function GroupItem_save() {
if (!this._inited || this._uninited) // too soon/late to save
return;
var data = this.getStorageData();
if (GroupItems.groupItemStorageSanity(data))
Storage.saveGroupItem(gWindow, data);
},
// ----------
// Function: deleteData
// Deletes the groupItem in the persistent storage.
deleteData: function GroupItem_deleteData() {
this._uninited = true;
Storage.deleteGroupItem(gWindow, this.id);
},
// ----------
// Function: getTitle
// Returns the title of this groupItem as a string.
getTitle: function GroupItem_getTitle() {
return this.$title ? this.$title.val() : '';
},
// ----------
// Function: setTitle
// Sets the title of this groupItem with the given string
setTitle: function GroupItem_setTitle(value) {
this.$title.val(value);
this.save();
},
// ----------
// Function: adjustTitleSize
// Used to adjust the width of the title box depending on groupItem width and title size.
adjustTitleSize: function GroupItem_adjustTitleSize() {
Utils.assert(this.bounds, 'bounds needs to have been set');
let closeButton = iQ('.close', this.container);
var dimension = UI.rtl ? 'left' : 'right';
var w = Math.min(this.bounds.width - parseInt(closeButton.width()) - parseInt(closeButton.css(dimension)),
Math.max(150, this.getTitle().length * 6));
// The * 6 multiplier calculation is assuming that characters in the title
// are approximately 6 pixels wide. Bug 586545
var css = {width: w};
this.$title.css(css);
this.$titleShield.css(css);
},
// ----------
// Function: getContentBounds
// Returns a <Rect> for the groupItem's content area (which doesn't include the title, etc).
getContentBounds: function GroupItem_getContentBounds() {
var box = this.getBounds();
var titleHeight = this.$titlebar.height();
box.top += titleHeight;
box.height -= titleHeight;
var appTabTrayWidth = this.$appTabTray.width();
box.width -= appTabTrayWidth;
if (UI.rtl) {
box.left += appTabTrayWidth;
}
// Make the computed bounds' "padding" and new tab button margin actually be
// themeable --OR-- compute this from actual bounds. Bug 586546
box.inset(6, 6);
box.height -= 33; // For new tab button
return box;
},
// ----------
// Function: setBounds
// Sets the bounds with the given <Rect>, animating unless "immediately" is false.
//
// Parameters:
// rect - a <Rect> giving the new bounds
// immediately - true if it should not animate; default false
// options - an object with additional parameters, see below
//
// Possible options:
// force - true to always update the DOM even if the bounds haven't changed; default false
setBounds: function GroupItem_setBounds(inRect, immediately, options) {
if (!Utils.isRect(inRect)) {
Utils.trace('GroupItem.setBounds: rect is not a real rectangle!', inRect);
return;
}
// Validate and conform passed in size
let validSize = GroupItems.calcValidSize(
new Point(inRect.width, inRect.height));
let rect = new Rect(inRect.left, inRect.top, validSize.x, validSize.y);
if (!options)
options = {};
var titleHeight = this.$titlebar.height();
// ___ Determine what has changed
var css = {};
var titlebarCSS = {};
var contentCSS = {};
if (rect.left != this.bounds.left || options.force)
css.left = rect.left;
if (rect.top != this.bounds.top || options.force)
css.top = rect.top;
if (rect.width != this.bounds.width || options.force) {
css.width = rect.width;
titlebarCSS.width = rect.width;
contentCSS.width = rect.width;
}
if (rect.height != this.bounds.height || options.force) {
css.height = rect.height;
contentCSS.height = rect.height - titleHeight;
}
if (Utils.isEmptyObject(css))
return;
var offset = new Point(rect.left - this.bounds.left, rect.top - this.bounds.top);
this.bounds = new Rect(rect);
// ___ Deal with children
if (css.width || css.height) {
this.arrange({animate: !immediately}); //(immediately ? 'sometimes' : true)});
} else if (css.left || css.top) {
this._children.forEach(function(child) {
if (!child.getHidden()) {
var box = child.getBounds();
child.setPosition(box.left + offset.x, box.top + offset.y, immediately);
}
});
}
// ___ Update our representation
if (immediately) {
iQ(this.container).css(css);
this.$titlebar.css(titlebarCSS);
} else {
TabItems.pausePainting();
iQ(this.container).animate(css, {
duration: 350,
easing: "tabviewBounce",
complete: function() {
TabItems.resumePainting();
}
});
this.$titlebar.animate(titlebarCSS, {
duration: 350
});
}
if (css.width) {
this.adjustTitleSize();
}
UI.clearShouldResizeItems();
this._updateDebugBounds();
this.setTrenches(rect);
this.save();
},
// ----------
// Function: setZ
// Set the Z order for the groupItem's container, as well as its children.
setZ: function GroupItem_setZ(value) {
this.zIndex = value;
iQ(this.container).css({zIndex: value});
if (this.$debug)
this.$debug.css({zIndex: value + 1});
var count = this._children.length;
if (count) {
var topZIndex = value + count + 1;
var zIndex = topZIndex;
var self = this;
this._children.forEach(function(child) {
if (child == self.topChild)
child.setZ(topZIndex + 1);
else {
child.setZ(zIndex);
zIndex--;
}
});
}
},
// ----------
// Function: close
// Closes the groupItem, removing (but not closing) all of its children.
close: function GroupItem_close() {
this.removeAll({dontClose: true});
GroupItems.unregister(this);
if (this.hidden) {
iQ(this.container).remove();
if (this.$undoContainer) {
this.$undoContainer.remove();
this.$undoContainer = null;
}
this.removeTrenches();
Items.unsquish();
this._sendToSubscribers("close");
GroupItems.updateGroupCloseButtons();
} else {
let self = this;
iQ(this.container).animate({
opacity: 0,
"-moz-transform": "scale(.3)",
}, {
duration: 170,
complete: function() {
iQ(this).remove();
self.removeTrenches();
Items.unsquish();
self._sendToSubscribers("close");
GroupItems.updateGroupCloseButtons();
}
});
}
this.deleteData();
},
// ----------
// Function: closeAll
// Closes the groupItem and all of its children.
closeAll: function GroupItem_closeAll() {
if (this._children.length > 0) {
this._children.forEach(function(child) {
iQ(child.container).hide();
});
iQ(this.container).animate({
opacity: 0,
"-moz-transform": "scale(.3)",
}, {
duration: 170,
complete: function() {
iQ(this).hide();
}
});
this._createUndoButton();
} else {
if (!this.locked.close)
this.close();
}
this._makeClosestTabActive();
},
// ----------
// Function: _makeClosestTabActive
// Make the closest tab external to this group active.
// Used when closing the group.
_makeClosestTabActive: function GroupItem__makeClosestTabActive() {
let closeCenter = this.getBounds().center();
// Find closest tab to make active
let closestTabItem = UI.getClosestTab(closeCenter);
UI.setActiveTab(closestTabItem);
// set the active group or orphan tabitem.
if (closestTabItem) {
if (closestTabItem.parent) {
GroupItems.setActiveGroupItem(closestTabItem.parent);
} else {
GroupItems.setActiveOrphanTab(closestTabItem);
GroupItems.setActiveGroupItem(null);
}
} else {
GroupItems.setActiveGroupItem(null);
GroupItems.setActiveOrphanTab(null);
}
},
// ----------
// Function: _unhide
// Shows the hidden group.
_unhide: function GroupItem__unhide() {
let self = this;
this._cancelFadeAwayUndoButtonTimer();
this.hidden = false;
this.$undoContainer.remove();
this.$undoContainer = null;
iQ(this.container).show().animate({
"-moz-transform": "scale(1)",
"opacity": 1
}, {
duration: 170,
complete: function() {
self._children.forEach(function(child) {
iQ(child.container).show();
});
}
});
GroupItems.updateGroupCloseButtons();
self._sendToSubscribers("groupShown", { groupItemId: self.id });
},
// ----------
// Function: closeHidden
// Removes the group item, its children and its container.
closeHidden: function GroupItem_closeHidden() {
let self = this;
this._cancelFadeAwayUndoButtonTimer();
// When the last non-empty groupItem is closed and there are no orphan or
// pinned tabs then create a new group with a blank tab.
let remainingGroups = GroupItems.groupItems.filter(function (groupItem) {
return (groupItem != self && groupItem.getChildren().length);
});
if (!gBrowser._numPinnedTabs && !GroupItems.getOrphanedTabs().length &&
!remainingGroups.length) {
let emptyGroups = GroupItems.groupItems.filter(function (groupItem) {
return (groupItem != self && !groupItem.getChildren().length);
});
let group = (emptyGroups.length ? emptyGroups[0] : GroupItems.newGroup());
group.newTab();
}
// when "TabClose" event is fired, the browser tab is about to close and our
// item "close" event is fired. And then, the browser tab gets closed.
// In other words, the group "close" event is fired before all browser
// tabs in the group are closed. The below code would fire the group "close"
// event only after all browser tabs in that group are closed.
let shouldRemoveTabItems = [];
let toClose = this._children.concat();
toClose.forEach(function(child) {
child.removeSubscriber(self, "close");
let removed = child.close();
if (removed) {
shouldRemoveTabItems.push(child);
} else {
// child.removeSubscriber() must be called before child.close(),
// therefore we call child.addSubscriber() if the tab is not removed.
child.addSubscriber(self, "close", function() {
self.remove(child);
});
}
});
if (shouldRemoveTabItems.length != toClose.length) {
// remove children without the assiciated tab and show the group item
shouldRemoveTabItems.forEach(function(child) {
self.remove(child, { dontArrange: true });
});
this.$undoContainer.fadeOut(function() { self._unhide() });
} else {
this.close();
}
},
// ----------
// Function: _fadeAwayUndoButton
// Fades away the undo button
_fadeAwayUndoButton: function GroupItem__fadeAwayUdoButton() {
let self = this;
if (this.$undoContainer) {
// if there is one or more orphan tabs or there is more than one group
// and other groupS are not empty, fade away the undo button.
let shouldFadeAway = GroupItems.getOrphanedTabs().length > 0;
if (!shouldFadeAway && GroupItems.groupItems.length > 1) {
shouldFadeAway =
GroupItems.groupItems.some(function(groupItem) {
return (groupItem != self && groupItem.getChildren().length > 0);
});
}
if (shouldFadeAway) {
self.$undoContainer.animate({
color: "transparent",
opacity: 0
}, {
duration: this._fadeAwayUndoButtonDuration,
complete: function() { self.closeHidden(); }
});
}
}
},
// ----------
// Function: _createUndoButton
// Makes the affordance for undo a close group action
_createUndoButton: function GroupItem__createUndoButton() {
let self = this;
this.$undoContainer = iQ("<div/>")
.addClass("undo")
.attr("type", "button")
.text(tabviewString("groupItem.undoCloseGroup"))
.appendTo("body");
let undoClose = iQ("<span/>")
.addClass("close")
.appendTo(this.$undoContainer);
this.$undoContainer.css({
left: this.bounds.left + this.bounds.width/2 - iQ(self.$undoContainer).width()/2,
top: this.bounds.top + this.bounds.height/2 - iQ(self.$undoContainer).height()/2,
"-moz-transform": "scale(.1)",
opacity: 0
});
this.hidden = true;
// hide group item and show undo container.
setTimeout(function() {
self.$undoContainer.animate({
"-moz-transform": "scale(1)",
"opacity": 1
}, {
easing: "tabviewBounce",
duration: 170,
complete: function() {
self._sendToSubscribers("groupHidden", { groupItemId: self.id });
}
});
}, 50);
// add click handlers
this.$undoContainer.click(function(e) {
// Only do this for clicks on this actual element.
if (e.target.nodeName != self.$undoContainer[0].nodeName)
return;
self.$undoContainer.fadeOut(function() { self._unhide(); });
});
undoClose.click(function() {
self.$undoContainer.fadeOut(function() { self.closeHidden(); });
});
this.setupFadeAwayUndoButtonTimer();
// Cancel the fadeaway if you move the mouse over the undo
// button, and restart the countdown once you move out of it.
this.$undoContainer.mouseover(function() {
self._cancelFadeAwayUndoButtonTimer();
});
this.$undoContainer.mouseout(function() {
self.setupFadeAwayUndoButtonTimer();
});
GroupItems.updateGroupCloseButtons();
},
// ----------
// Sets up fade away undo button timeout.
setupFadeAwayUndoButtonTimer: function() {
let self = this;
if (!this._undoButtonTimeoutId) {
this._undoButtonTimeoutId = setTimeout(function() {
self._fadeAwayUndoButton();
}, this.fadeAwayUndoButtonDelay);
}
},
// ----------
// Cancels the fade away undo button timeout.
_cancelFadeAwayUndoButtonTimer: function() {
clearTimeout(this._undoButtonTimeoutId);
this._undoButtonTimeoutId = null;
},
// ----------
// Function: add
// Adds an item to the groupItem.
// Parameters:
//
// a - The item to add. Can be an <Item>, a DOM element or an iQ object.
// The latter two must refer to the container of an <Item>.
// options - An object with optional settings for this call.
//
// Options:
//
// index - (int) if set, add this tab at this index
// immediately - (bool) if true, no animation will be used
// dontArrange - (bool) if true, will not trigger an arrange on the group
add: function GroupItem_add(a, options) {
try {
var item;
var $el;
if (a.isAnItem) {
item = a;
$el = iQ(a.container);
} else {
$el = iQ(a);
item = Items.item($el);
}
Utils.assertThrow(!item.parent || item.parent == this,
"shouldn't already be in another groupItem");
item.removeTrenches();
if (!options)
options = {};
var self = this;
var wasAlreadyInThisGroupItem = false;
var oldIndex = this._children.indexOf(item);
if (oldIndex != -1) {
this._children.splice(oldIndex, 1);
wasAlreadyInThisGroupItem = true;
}
// Insert the tab into the right position.
var index = ("index" in options) ? options.index : this._children.length;
this._children.splice(index, 0, item);
item.setZ(this.getZ() + 1);
$el.addClass("tabInGroupItem");
if (!wasAlreadyInThisGroupItem) {
item.droppable(false);
item.groupItemData = {};
item.addSubscriber(this, "close", function() {
self.remove(item);
if (self._children.length > 0 && self._activeTab) {
GroupItems.setActiveGroupItem(self);
UI.setActiveTab(self._activeTab);
}
});
item.setParent(this);
if (typeof item.setResizable == 'function')
item.setResizable(false, options.immediately);
// if it is visually active, set it as the active tab.
if (iQ(item.container).hasClass("focus"))
this.setActiveTab(item);
// if it matches the selected tab or no active tab and the browser
// tab is hidden, the active group item would be set.
if (item.tab == gBrowser.selectedTab ||
(!GroupItems.getActiveGroupItem() && !item.tab.hidden))
GroupItems.setActiveGroupItem(this);
}
if (!options.dontArrange)
this.arrange({animate: !options.immediately});
this._sendToSubscribers("childAdded",{ groupItemId: this.id, item: item });
UI.setReorderTabsOnHide(this);
} catch(e) {
Utils.log('GroupItem.add error', e);
}
},
// ----------
// Function: remove
// Removes an item from the groupItem.
// Parameters:
//
// a - The item to remove. Can be an <Item>, a DOM element or an iQ object.
// The latter two must refer to the container of an <Item>.
// options - An optional object with settings for this call. See below.
//
// Possible options:
// dontArrange - don't rearrange the remaining items
// dontClose - don't close the group even if it normally would
// immediately - don't animate
remove: function GroupItem_remove(a, options) {
try {
var $el;
var item;
if (a.isAnItem) {
item = a;
$el = iQ(item.container);
} else {
$el = iQ(a);
item = Items.item($el);
}
if (!options)
options = {};
var index = this._children.indexOf(item);
if (index != -1)
this._children.splice(index, 1);
if (item == this._activeTab || !this._activeTab) {
if (this._children.length > 0)
this._activeTab = this._children[0];
else
this._activeTab = null;
}
item.setParent(null);
item.removeClass("tabInGroupItem");
item.removeClass("stacked");
item.isStacked = false;
item.setHidden(false);
item.removeClass("stack-trayed");
item.setRotation(0);
item.droppable(true);
item.removeSubscriber(this, "close");
if (typeof item.setResizable == 'function')
item.setResizable(true, options.immediately);
if (this._children.length == 0 && !this.locked.close && !this.getTitle() &&
!options.dontClose) {
if (!GroupItems.getUnclosableGroupItemId()) {
this.close();
this._makeClosestTabActive();
} else {
// this.close(); this line is causing the leak but the leak doesn't happen after re-enabling it
}
} else if (!options.dontArrange) {
this.arrange({animate: !options.immediately});
}
this._sendToSubscribers("childRemoved",{ groupItemId: this.id, item: item });
} catch(e) {
Utils.log(e);
}
},
// ----------
// Function: removeAll
// Removes all of the groupItem's children.
// The optional "options" param is passed to each remove call.
removeAll: function GroupItem_removeAll(options) {
let self = this;
let newOptions = {dontArrange: true};
if (options)
Utils.extend(newOptions, options);
let toRemove = this._children.concat();
toRemove.forEach(function(child) {
self.remove(child, newOptions);
});
},
// ----------
// Handles error event for loading app tab's fav icon.
_onAppTabError : function(event) {
iQ(".appTabIcon", this.$appTabTray).each(function(icon) {
let $icon = iQ(icon);
if ($icon.data("xulTab") == event.target) {
$icon.attr("src", Utils.defaultFaviconURL);
return true;
}
});
},
// ----------
// Adds the given xul:tab as an app tab in this group's apptab tray
addAppTab: function GroupItem_addAppTab(xulTab) {
let self = this;
xulTab.addEventListener("error", this._onAppTabError, false);
// add the icon
let iconUrl = xulTab.image || Utils.defaultFaviconURL;
let $appTab = iQ("<img>")
.addClass("appTabIcon")
.attr("src", iconUrl)
.data("xulTab", xulTab)
.appendTo(this.$appTabTray)
.click(function(event) {
if (!Utils.isLeftClick(event))
return;
GroupItems.setActiveGroupItem(self);
UI.goToTab(iQ(this).data("xulTab"));
});
// adjust the tray
let columnWidth = $appTab.width();
if (parseInt(this.$appTabTray.css("width")) != columnWidth) {
this.$appTabTray.css({width: columnWidth});
this.arrange();
}
},
// ----------
// Removes the given xul:tab as an app tab in this group's apptab tray
removeAppTab: function GroupItem_removeAppTab(xulTab) {
// remove the icon
iQ(".appTabIcon", this.$appTabTray).each(function(icon) {
let $icon = iQ(icon);
if ($icon.data("xulTab") != xulTab)
return;
$icon.remove();
});
// adjust the tray
if (!iQ(".appTabIcon", this.$appTabTray).length) {
this.$appTabTray.css({width: 0});
this.arrange();
}
xulTab.removeEventListener("error", this._onAppTabError, false);
},
// ----------
// Function: hideExpandControl
// Hide the control which expands a stacked groupItem into a quick-look view.
hideExpandControl: function GroupItem_hideExpandControl() {
this.$expander.hide();
},
// ----------
// Function: showExpandControl
// Show the control which expands a stacked groupItem into a quick-look view.
showExpandControl: function GroupItem_showExpandControl() {
let parentBB = this.getBounds();
let childBB = this.getChild(0).getBounds();
let padding = 7;
this.$expander
.show()
.css({
left: parentBB.width/2 - this.$expander.width()/2
});
},
// ----------
// Function: shouldStack
// Returns true if the groupItem, given "count", should stack (instead of
// grid).
shouldStack: function GroupItem_shouldStack(count) {
if (count <= 1)
return false;
var bb = this.getContentBounds();
var options = {
return: 'widthAndColumns',
count: count || this._children.length,
hideTitle: false
};
let arrObj = Items.arrange(null, bb, options);
let shouldStack = arrObj.childWidth < TabItems.minTabWidth * 1.35;
this._columns = shouldStack ? null : arrObj.columns;
return shouldStack;
},
// ----------
// Function: arrange
// Lays out all of the children.
//
// Parameters:
// options - passed to <Items.arrange> or <_stackArrange>, except those below
//
// Options:
// addTab - (boolean) if true, we add one to the child count
// oldDropIndex - if set, we will only set any bounds if the dropIndex has
// changed
// dropPos - (<Point>) a position where a tab is currently positioned, above
// this group.
// animate - (boolean) if true, movement of children will be animated.
//
// Returns:
// dropIndex - an index value for where an item would be dropped, if
// options.dropPos is given.
arrange: function GroupItem_arrange(options) {
if (!options)
options = {};
let childrenToArrange = [];
this._children.forEach(function(child) {
if (child.isDragging)
options.addTab = true;
else
childrenToArrange.push(child);
});
if (GroupItems._arrangePaused) {
GroupItems.pushArrange(this, options);
return false;
}
let shouldStack = this.shouldStack(childrenToArrange.length + (options.addTab ? 1 : 0));
let box = this.getContentBounds();
// if we should stack and we're not expanded
if (shouldStack && !this.expanded) {
this.showExpandControl();
this._stackArrange(childrenToArrange, box, options);
return false;
} else {
this.hideExpandControl();
// a dropIndex is returned
return this._gridArrange(childrenToArrange, box, options);
}
},
// ----------
// Function: _stackArrange
// Arranges the children in a stack.
//
// Parameters:
// childrenToArrange - array of <TabItem> children
// bb - <Rect> to arrange within
// options - see below
//
// Possible "options" properties:
// animate - whether to animate; default: true.
_stackArrange: function GroupItem__stackArrange(childrenToArrange, bb, options) {
if (!options)
options = {};
var animate = "animate" in options ? options.animate : true;
var count = childrenToArrange.length;
if (!count)
return;
let itemAspect = TabItems.tabHeight / TabItems.tabWidth;
let zIndex = this.getZ() + count + 1;
let maxRotation = 35; // degress
let scale = 0.7;
let newTabsPad = 10;
let bbAspect = bb.height / bb.width;
let numInPile = 6;
let angleDelta = 3.5; // degrees
// compute size of the entire stack, modulo rotation.
let size;
if (bbAspect > itemAspect) { // Tall, thin groupItem
size = TabItems.calcValidSize(new Point(bb.width * scale, -1),
{hideTitle:true});
} else { // Short, wide groupItem
size = TabItems.calcValidSize(new Point(-1, bb.height * scale),
{hideTitle:true});
}
// x is the left margin that the stack will have, within the content area (bb)
// y is the vertical margin
var x = (bb.width - size.x) / 2;
var y = Math.min(size.x, (bb.height - size.y) / 2);
var box = new Rect(bb.left + x, bb.top + y, size.x, size.y);
var self = this;
var children = [];
childrenToArrange.forEach(function GroupItem__stackArrange_order(child) {
// Children are still considered stacked even if they're hidden later.
child.addClass("stacked");
child.isStacked = true;
if (numInPile-- > 0) {
child.setHidden(false);
if (child == self.topChild)
children.unshift(child);
else
children.push(child);
} else {
child.setHidden(true);
}
});
let angleAccum = 0;
children.forEach(function GroupItem__stackArrange_apply(child, index) {
if (!child.locked.bounds) {
child.setZ(zIndex);
zIndex--;
// Force a recalculation of height because we've changed how the title
// is shown.
child.setBounds(box, !animate, {force:true});
child.setRotation((UI.rtl ? -1 : 1) * angleAccum);
angleAccum += angleDelta;
}
});
self._isStacked = true;
},
// ----------
// Function: _gridArrange
// Arranges the children into a grid.
//
// Parameters:
// childrenToArrange - array of <TabItem> children
// box - <Rect> to arrange within
// options - see below
//
// Possible "options" properties:
// animate - whether to animate; default: true.
// z - (int) a z-index to assign the children
// columns - the number of columns to use in the layout, if known in advance
//
// Returns:
// dropIndex - (int) the index at which a dragged item (if there is one) should be added
// if it is dropped. Otherwise (boolean) false.
_gridArrange: function GroupItem__gridArrange(childrenToArrange, box, options) {
this.topChild = null;
let arrangeOptions;
if (this.expanded) {
// if we're expanded, we actually want to use the expanded tray's bounds.
box = new Rect(this.expanded.bounds);
box.inset(8, 8);
arrangeOptions = Utils.extend({}, options, {z: 99999});
} else {
this._isStacked = false;
arrangeOptions = Utils.extend({}, options, {
columns: this._columns
});
childrenToArrange.forEach(function(child) {
child.removeClass("stacked");
child.isStacked = false;
child.setHidden(false);
});
}
if (!childrenToArrange.length)
return false;
// Items.arrange will determine where/how the child items should be
// placed, but will *not* actually move them for us. This is our job.
let result = Items.arrange(childrenToArrange, box, arrangeOptions);
let {dropIndex, rects, columns} = result;
if ("oldDropIndex" in options && options.oldDropIndex === dropIndex)
return dropIndex;
this._columns = columns;
let index = 0;
let self = this;
childrenToArrange.forEach(function GroupItem_arrange_children_each(child, i) {
// If dropIndex spacing is active and this is a child after index,
// bump it up one so we actually use the correct rect
// (and skip one for the dropPos)
if (self._dropSpaceActive && index === dropIndex)
index++;
if (!child.locked.bounds) {
child.setBounds(rects[index], !options.animate);
child.setRotation(0);
if (arrangeOptions.z)
child.setZ(arrangeOptions.z);
}
index++;
});
return dropIndex;
},
// ----------
// Function: childHit
// Called by one of the groupItem's children when the child is clicked on.
//
// Returns an object:
// shouldZoom - true if the browser should launch into the tab represented by the child
// callback - called after the zoom animation is complete
childHit: function GroupItem_childHit(child) {
var self = this;
// ___ normal click
if (!this._isStacked || this.expanded) {
return {
shouldZoom: true,
callback: function() {
self.collapse();
}
};
}
GroupItems.setActiveGroupItem(self);
return { shouldZoom: true };
},
expand: function GroupItem_expand() {
var self = this;
// ___ we're stacked, and command is held down so expand
GroupItems.setActiveGroupItem(self);
let activeTab = this.topChild || this.getChildren()[0];
UI.setActiveTab(activeTab);
var startBounds = this.getChild(0).getBounds();
var $tray = iQ("<div>").css({
top: startBounds.top,
left: startBounds.left,
width: startBounds.width,
height: startBounds.height,
position: "absolute",
zIndex: 99998
}).appendTo("body");
$tray[0].id = "expandedTray";
var w = 180;
var h = w * (TabItems.tabHeight / TabItems.tabWidth) * 1.1;
var padding = 20;
var col = Math.ceil(Math.sqrt(this._children.length));
var row = Math.ceil(this._children.length/col);
var overlayWidth = Math.min(window.innerWidth - (padding * 2), w*col + padding*(col+1));
var overlayHeight = Math.min(window.innerHeight - (padding * 2), h*row + padding*(row+1));
var pos = {left: startBounds.left, top: startBounds.top};
pos.left -= overlayWidth / 3;
pos.top -= overlayHeight / 3;
if (pos.top < 0)
pos.top = 20;
if (pos.left < 0)
pos.left = 20;
if (pos.top + overlayHeight > window.innerHeight)
pos.top = window.innerHeight - overlayHeight - 20;
if (pos.left + overlayWidth > window.innerWidth)
pos.left = window.innerWidth - overlayWidth - 20;
$tray
.animate({
width: overlayWidth,
height: overlayHeight,
top: pos.top,
left: pos.left
}, {
duration: 200,
easing: "tabviewBounce",
complete: function GroupItem_expand_animate_complete() {
self._sendToSubscribers("expanded");
}
})
.addClass("overlay");
this._children.forEach(function(child) {
child.addClass("stack-trayed");
child.setHidden(false);
});
var $shield = iQ('<div>')
.addClass('shield')
.css({
zIndex: 99997
})
.appendTo('body')
.click(function() { // just in case
self.collapse();
});
// There is a race-condition here. If there is
// a mouse-move while the shield is coming up
// it will collapse, which we don't want. Thus,
// we wait a little bit before adding this event
// handler.
setTimeout(function() {
$shield.mouseover(function() {
self.collapse();
});
}, 200);
this.expanded = {
$tray: $tray,
$shield: $shield,
bounds: new Rect(pos.left, pos.top, overlayWidth, overlayHeight)
};
this.arrange();
},
// ----------
// Function: collapse
// Collapses the groupItem from the expanded "tray" mode.
collapse: function GroupItem_collapse() {
if (this.expanded) {
var z = this.getZ();
var box = this.getBounds();
let self = this;
this.expanded.$tray
.css({
zIndex: z + 1
})
.animate({
width: box.width,
height: box.height,
top: box.top,
left: box.left,
opacity: 0
}, {
duration: 350,
easing: "tabviewBounce",
complete: function GroupItem_collapse_animate_complete() {
iQ(this).remove();
self._sendToSubscribers("collapsed");
}
});
this.expanded.$shield.remove();
this.expanded = null;
this._children.forEach(function(child) {
child.removeClass("stack-trayed");
});
this.arrange({z: z + 2});
}
},
// ----------
// Function: _addHandlers
// Helper routine for the constructor; adds various event handlers to the container.
_addHandlers: function GroupItem__addHandlers(container) {
let self = this;
// Create new tab and zoom in on it after a double click
container.mousedown(function(e) {
if (Date.now() - self._lastClick <= UI.DBLCLICK_INTERVAL &&
(self._lastClickPositions.x - UI.DBLCLICK_OFFSET) <= e.clientX &&
(self._lastClickPositions.x + UI.DBLCLICK_OFFSET) >= e.clientX &&
(self._lastClickPositions.y - UI.DBLCLICK_OFFSET) <= e.clientY &&
(self._lastClickPositions.y + UI.DBLCLICK_OFFSET) >= e.clientY) {
self.newTab();
self._lastClick = 0;
self._lastClickPositions = null;
} else {
self._lastClick = Date.now();
self._lastClickPositions = new Point(e.clientX, e.clientY);
}
});
var dropIndex = false;
var dropSpaceTimer = null;
// When the _dropSpaceActive flag is turned on on a group, and a tab is
// dragged on top, a space will open up.
this._dropSpaceActive = false;
this.dropOptions.over = function GroupItem_dropOptions_over(event) {
iQ(this.container).addClass("acceptsDrop");
};
this.dropOptions.move = function GroupItem_dropOptions_move(event) {
let oldDropIndex = dropIndex;
let dropPos = drag.info.item.getBounds().center();
let options = {dropPos: dropPos,
addTab: self._dropSpaceActive && drag.info.item.parent != self,
oldDropIndex: oldDropIndex};
let newDropIndex = self.arrange(options);
// If this is a new drop index, start a timer!
if (newDropIndex !== oldDropIndex) {
dropIndex = newDropIndex;
if (this._dropSpaceActive)
return;
if (dropSpaceTimer) {
clearTimeout(dropSpaceTimer);
dropSpaceTimer = null;
}
dropSpaceTimer = setTimeout(function GroupItem_arrange_evaluateDropSpace() {
// Note that dropIndex's scope is GroupItem__addHandlers, but
// newDropIndex's scope is GroupItem_dropOptions_move. Thus,
// dropIndex may change with other movement events before we come
// back and check this. If it's still the same dropIndex, activate
// drop space display!
if (dropIndex === newDropIndex) {
self._dropSpaceActive = true;
dropIndex = self.arrange({dropPos: dropPos,
addTab: drag.info.item.parent != self,
animate: true});
}
dropSpaceTimer = null;
}, 250);
}
};
this.dropOptions.drop = function GroupItem_dropOptions_drop(event) {
iQ(this.container).removeClass("acceptsDrop");
let options = {};
if (this._dropSpaceActive)
this._dropSpaceActive = false;
if (dropSpaceTimer) {
clearTimeout(dropSpaceTimer);
dropSpaceTimer = null;
// If we drop this item before the timed rearrange was executed,
// we won't have an accurate dropIndex value. Get that now.
let dropPos = drag.info.item.getBounds().center();
dropIndex = self.arrange({dropPos: dropPos,
addTab: drag.info.item.parent != self,
animate: true});
}
// remove the item from its parent if that's not the current groupItem.
// this may occur when dragging too quickly so the out event is not fired.
var groupItem = drag.info.item.parent;
if (groupItem && self !== groupItem)
groupItem.remove(drag.info.$el, {dontClose: true});
if (dropIndex !== false)
options = {index: dropIndex};
this.add(drag.info.$el, options);
GroupItems.setActiveGroupItem(this);
dropIndex = false;
};
this.dropOptions.out = function GroupItem_dropOptions_out(event) {
dropIndex = false;
if (this._dropSpaceActive)
this._dropSpaceActive = false;
if (dropSpaceTimer) {
clearTimeout(dropSpaceTimer);
dropSpaceTimer = null;
}
self.arrange();
var groupItem = drag.info.item.parent;
if (groupItem)
groupItem.remove(drag.info.$el, {dontClose: true});
iQ(this.container).removeClass("acceptsDrop");
}
if (!this.locked.bounds)
this.draggable();
this.droppable(true);
this.$expander.click(function() {
self.expand();
});
},
// ----------
// Function: setResizable
// Sets whether the groupItem is resizable and updates the UI accordingly.
setResizable: function GroupItem_setResizable(value, immediately) {
this.resizeOptions.minWidth = GroupItems.minGroupWidth;
this.resizeOptions.minHeight = GroupItems.minGroupHeight;
if (value) {
immediately ? this.$resizer.show() : this.$resizer.fadeIn();
this.resizable(true);
} else {
immediately ? this.$resizer.hide() : this.$resizer.fadeOut();
this.resizable(false);
}
},
// ----------
// Function: newTab
// Creates a new tab within this groupItem.
newTab: function GroupItem_newTab(url) {
GroupItems.setActiveGroupItem(this);
let newTab = gBrowser.loadOneTab(url || "about:blank", {inBackground: true});
// TabItems will have handled the new tab and added the tabItem property.
// We don't have to check if it's an app tab (and therefore wouldn't have a
// TabItem), since we've just created it.
newTab._tabViewTabItem.zoomIn(!url);
},
// ----------
// Function: reorderTabItemsBasedOnTabOrder
// Reorders the tabs in a groupItem based on the arrangment of the tabs
// shown in the tab bar. It does it by sorting the children
// of the groupItem by the positions of their respective tabs in the
// tab bar.
reorderTabItemsBasedOnTabOrder: function GroupItem_reorderTabItemsBasedOnTabOrder() {
this._children.sort(function(a,b) a.tab._tPos - b.tab._tPos);
this.arrange({animate: false});
// this.arrange calls this.save for us
},
// Function: reorderTabsBasedOnTabItemOrder
// Reorders the tabs in the tab bar based on the arrangment of the tabs
// shown in the groupItem.
reorderTabsBasedOnTabItemOrder: function GroupItem_reorderTabsBasedOnTabItemOrder() {
let indices;
let tabs = this._children.map(function (tabItem) tabItem.tab);
tabs.forEach(function (tab, index) {
if (!indices)
indices = tabs.map(function (tab) tab._tPos);
let start = index ? indices[index - 1] + 1 : 0;
let end = index + 1 < indices.length ? indices[index + 1] - 1 : Infinity;
let targetRange = new Range(start, end);
if (!targetRange.contains(tab._tPos)) {
gBrowser.moveTabTo(tab, start);
indices = null;
}
});
},
// ----------
// Function: setTopChild
// Sets the <Item> that should be displayed on top when in stack mode.
setTopChild: function GroupItem_setTopChild(topChild) {
this.topChild = topChild;
this.arrange({animate: false});
// this.arrange calls this.save for us
},
// ----------
// Function: getChild
// Returns the nth child tab or null if index is out of range.
//
// Parameters:
// index - the index of the child tab to return, use negative
// numbers to index from the end (-1 is the last child)
getChild: function GroupItem_getChild(index) {
if (index < 0)
index = this._children.length + index;
if (index >= this._children.length || index < 0)
return null;
return this._children[index];
},
// ----------
// Function: getChildren
// Returns all children.
getChildren: function GroupItem_getChildren() {
return this._children;
}
});
// ##########
// Class: GroupItems
// Singleton for managing all <GroupItem>s.
let GroupItems = {
groupItems: [],
nextID: 1,
_inited: false,
_activeGroupItem: null,
_activeOrphanTab: null,
_cleanupFunctions: [],
_arrangePaused: false,
_arrangesPending: [],
_removingHiddenGroups: false,
_delayedModUpdates: [],
minGroupHeight: 110,
minGroupWidth: 125,
// ----------
// Function: init
init: function GroupItems_init() {
let self = this;
// setup attr modified handler, and prepare for its uninit
function handleAttrModified(xulTab) {
self._handleAttrModified(xulTab);
}
// make sure any closed tabs are removed from the delay update list
function handleClose(xulTab) {
let idx = self._delayedModUpdates.indexOf(xulTab);
if (idx != -1)
self._delayedModUpdates.splice(idx, 1);
}
AllTabs.register("attrModified", handleAttrModified);
AllTabs.register("close", handleClose);
this._cleanupFunctions.push(function() {
AllTabs.unregister("attrModified", handleAttrModified);
AllTabs.unregister("close", handleClose);
});
},
// ----------
// Function: uninit
uninit : function GroupItems_uninit () {
// call our cleanup functions
this._cleanupFunctions.forEach(function(func) {
func();
});
this._cleanupFunctions = [];
// additional clean up
this.groupItems = null;
},
// ----------
// Function: newGroup
// Creates a new empty group.
newGroup: function () {
let bounds = new Rect(20, 20, 250, 200);
return new GroupItem([], {bounds: bounds, immediately: true});
},
// ----------
// Function: pauseArrange
// Bypass arrange() calls and collect for resolution in
// resumeArrange()
pauseArrange: function GroupItems_pauseArrange() {
Utils.assert(this._arrangePaused == false,
"pauseArrange has been called while already paused");
Utils.assert(this._arrangesPending.length == 0,
"There are bypassed arrange() calls that haven't been resolved");
this._arrangePaused = true;
},
// ----------
// Function: pushArrange
// Push an arrange() call and its arguments onto an array
// to be resolved in resumeArrange()
pushArrange: function GroupItems_pushArrange(groupItem, options) {
Utils.assert(this._arrangePaused,
"Ensure pushArrange() called while arrange()s aren't paused");
let i;
for (i = 0; i < this._arrangesPending.length; i++)
if (this._arrangesPending[i].groupItem === groupItem)
break;
let arrangeInfo = {
groupItem: groupItem,
options: options
};
if (i < this._arrangesPending.length)
this._arrangesPending[i] = arrangeInfo;
else
this._arrangesPending.push(arrangeInfo);
},
// ----------
// Function: resumeArrange
// Resolve bypassed and collected arrange() calls
resumeArrange: function GroupItems_resumeArrange() {
this._arrangePaused = false;
for (let i = 0; i < this._arrangesPending.length; i++) {
let g = this._arrangesPending[i];
g.groupItem.arrange(g.options);
}
this._arrangesPending = [];
},
// ----------
// Function: _handleAttrModified
// watch for icon changes on app tabs
_handleAttrModified: function GroupItems__handleAttrModified(xulTab) {
if (!UI.isTabViewVisible()) {
if (this._delayedModUpdates.indexOf(xulTab) == -1) {
this._delayedModUpdates.push(xulTab);
}
} else
this._updateAppTabIcons(xulTab);
},
// ----------
// Function: flushTabUpdates
// Update apptab icons based on xulTabs which have been updated
// while the TabView hasn't been visible
flushAppTabUpdates: function GroupItems_flushAppTabUpdates() {
let self = this;
this._delayedModUpdates.forEach(function(xulTab) {
self._updateAppTabIcons(xulTab);
});
this._delayedModUpdates = [];
},
// ----------
// Function: _updateAppTabIcons
// Update images of any apptab icons that point to passed in xultab
_updateAppTabIcons: function GroupItems__updateAppTabIcons(xulTab) {
if (xulTab.ownerDocument.defaultView != gWindow || !xulTab.pinned)
return;
let iconUrl = xulTab.image || Utils.defaultFaviconURL;
this.groupItems.forEach(function(groupItem) {
iQ(".appTabIcon", groupItem.$appTabTray).each(function(icon) {
let $icon = iQ(icon);
if ($icon.data("xulTab") != xulTab)
return;
if (iconUrl != $icon.attr("src"))
$icon.attr("src", iconUrl);
});
});
},
// ----------
// Function: addAppTab
// Adds the given xul:tab to the app tab tray in all groups
addAppTab: function GroupItems_addAppTab(xulTab) {
this.groupItems.forEach(function(groupItem) {
groupItem.addAppTab(xulTab);
});
this.updateGroupCloseButtons();
},
// ----------
// Function: removeAppTab
// Removes the given xul:tab from the app tab tray in all groups
removeAppTab: function GroupItems_removeAppTab(xulTab) {
this.groupItems.forEach(function(groupItem) {
groupItem.removeAppTab(xulTab);
});
this.updateGroupCloseButtons();
},
// ----------
// Function: getNextID
// Returns the next unused groupItem ID.
getNextID: function GroupItems_getNextID() {
var result = this.nextID;
this.nextID++;
this._save();
return result;
},
// ----------
// Function: getStorageData
// Returns an object for saving GroupItems state to persistent storage.
getStorageData: function GroupItems_getStorageData() {
var data = {nextID: this.nextID, groupItems: []};
this.groupItems.forEach(function(groupItem) {
data.groupItems.push(groupItem.getStorageData());
});
return data;
},
// ----------
// Function: saveAll
// Saves GroupItems state, as well as the state of all of the groupItems.
saveAll: function GroupItems_saveAll() {
this._save();
this.groupItems.forEach(function(groupItem) {
groupItem.save();
});
},
// ----------
// Function: _save
// Saves GroupItems state.
_save: function GroupItems__save() {
if (!this._inited) // too soon to save now
return;
let activeGroupId = this._activeGroupItem ? this._activeGroupItem.id : null;
Storage.saveGroupItemsData(
gWindow, { nextID: this.nextID, activeGroupId: activeGroupId });
},
// ----------
// Function: getBoundingBox
// Given an array of DOM elements, returns a <Rect> with (roughly) the union of their locations.
getBoundingBox: function GroupItems_getBoundingBox(els) {
var bounds = [iQ(el).bounds() for each (el in els)];
var left = Math.min.apply({},[ b.left for each (b in bounds) ]);
var top = Math.min.apply({},[ b.top for each (b in bounds) ]);
var right = Math.max.apply({},[ b.right for each (b in bounds) ]);
var bottom = Math.max.apply({},[ b.bottom for each (b in bounds) ]);
return new Rect(left, top, right-left, bottom-top);
},
// ----------
// Function: reconstitute
// Restores to stored state, creating groupItems as needed.
// If no data, sets up blank slate (including "new tabs" groupItem).
reconstitute: function GroupItems_reconstitute(groupItemsData, groupItemData) {
try {
let activeGroupId;
if (groupItemsData) {
if (groupItemsData.nextID)
this.nextID = Math.max(this.nextID, groupItemsData.nextID);
if (groupItemsData.activeGroupId)
activeGroupId = groupItemsData.activeGroupId;
}
if (groupItemData) {
var toClose = this.groupItems.concat();
for (var id in groupItemData) {
let data = groupItemData[id];
if (this.groupItemStorageSanity(data)) {
let groupItem = this.groupItem(data.id);
if (groupItem) {
groupItem.userSize = data.userSize;
groupItem.setTitle(data.title);
groupItem.setBounds(data.bounds, true);
let index = toClose.indexOf(groupItem);
if (index != -1)
toClose.splice(index, 1);
} else {
var options = {
dontPush: true,
immediately: true
};
new GroupItem([], Utils.extend({}, data, options));
}
}
}
toClose.forEach(function(groupItem) {
groupItem.close();
});
}
// set active group item
if (activeGroupId) {
let activeGroupItem = this.groupItem(activeGroupId);
if (activeGroupItem)
this.setActiveGroupItem(activeGroupItem);
}
this._inited = true;
this._save(); // for nextID
} catch(e) {
Utils.log("error in recons: "+e);
}
},
// ----------
// Function: load
// Loads the storage data for groups.
// Returns true if there was global group data.
load: function GroupItems_load() {
let groupItemsData = Storage.readGroupItemsData(gWindow);
let groupItemData = Storage.readGroupItemData(gWindow);
this.reconstitute(groupItemsData, groupItemData);
return (groupItemsData && !Utils.isEmptyObject(groupItemsData));
},
// ----------
// Function: groupItemStorageSanity
// Given persistent storage data for a groupItem, returns true if it appears to not be damaged.
groupItemStorageSanity: function GroupItems_groupItemStorageSanity(groupItemData) {
// TODO: check everything
// Bug 586555
var sane = true;
if (!Utils.isRect(groupItemData.bounds)) {
Utils.log('GroupItems.groupItemStorageSanity: bad bounds', groupItemData.bounds);
sane = false;
}
return sane;
},
// ----------
// Function: register
// Adds the given <GroupItem> to the list of groupItems we're tracking.
register: function GroupItems_register(groupItem) {
Utils.assert(groupItem, 'groupItem');
Utils.assert(this.groupItems.indexOf(groupItem) == -1, 'only register once per groupItem');
this.groupItems.push(groupItem);
UI.updateTabButton();
},
// ----------
// Function: unregister
// Removes the given <GroupItem> from the list of groupItems we're tracking.
unregister: function GroupItems_unregister(groupItem) {
var index = this.groupItems.indexOf(groupItem);
if (index != -1)
this.groupItems.splice(index, 1);
if (groupItem == this._activeGroupItem)
this._activeGroupItem = null;
this._arrangesPending = this._arrangesPending.filter(function (pending) {
return groupItem != pending.groupItem;
});
UI.updateTabButton();
},
// ----------
// Function: groupItem
// Given some sort of identifier, returns the appropriate groupItem.
// Currently only supports groupItem ids.
groupItem: function GroupItems_groupItem(a) {
var result = null;
this.groupItems.forEach(function(candidate) {
if (candidate.id == a)
result = candidate;
});
return result;
},
// ----------
// Function: removeAll
// Removes all tabs from all groupItems (which automatically closes all unnamed groupItems).
removeAll: function GroupItems_removeAll() {
var toRemove = this.groupItems.concat();
toRemove.forEach(function(groupItem) {
groupItem.removeAll();
});
},
// ----------
// Function: newTab
// Given a <TabItem>, files it in the appropriate groupItem.
newTab: function GroupItems_newTab(tabItem, options) {
let activeGroupItem = this.getActiveGroupItem();
// 1. Active group
// 2. Active orphan
// 3. First visible non-app tab (that's not the tab in question), whether it's an
// orphan or not (make a new group if it's an orphan, add it to the group if it's
// not)
// 4. First group
// 5. First orphan that's not the tab in question
// 6. At this point there should be no groups or tabs (except for app tabs and the
// tab in question): make a new group
if (activeGroupItem) {
activeGroupItem.add(tabItem, options);
return;
}
let orphanTabItem = this.getActiveOrphanTab();
if (!orphanTabItem) {
let targetGroupItem;
// find first visible non-app tab in the tabbar.
gBrowser.visibleTabs.some(function(tab) {
if (!tab.pinned && tab != tabItem.tab) {
if (tab._tabViewTabItem) {
if (!tab._tabViewTabItem.parent) {
// the first visible tab is an orphan tab, set the orphan tab, and
// create a new group for orphan tab and new tabItem
orphanTabItem = tab._tabViewTabItem;
} else if (!tab._tabViewTabItem.parent.hidden) {
// the first visible tab belongs to a group, add the new tabItem to
// that group
targetGroupItem = tab._tabViewTabItem.parent;
}
}
return true;
}
return false;
});
let visibleGroupItems;
if (!orphanTabItem) {
if (targetGroupItem) {
// add the new tabItem to the first group item
targetGroupItem.add(tabItem);
this.setActiveGroupItem(targetGroupItem);
return;
} else {
// find the first visible group item
visibleGroupItems = this.groupItems.filter(function(groupItem) {
return (!groupItem.hidden);
});
if (visibleGroupItems.length > 0) {
visibleGroupItems[0].add(tabItem);
this.setActiveGroupItem(visibleGroupItems[0]);
return;
}
}
let orphanedTabs = this.getOrphanedTabs();
// set the orphan tab, and create a new group for orphan tab and
// new tabItem
if (orphanedTabs.length > 0)
orphanTabItem = orphanedTabs[0];
}
}
// create new group for orphan tab and new tabItem
let tabItems;
let newGroupItemBounds;
// the orphan tab would be the same as tabItem when all tabs are app tabs
// and a new tab is created.
if (orphanTabItem && orphanTabItem.tab != tabItem.tab) {
newGroupItemBounds = orphanTabItem.getBounds();
tabItems = [orphanTabItem, tabItem];
} else {
tabItem.setPosition(60, 60, true);
newGroupItemBounds = tabItem.getBounds();
tabItems = [tabItem];
}
newGroupItemBounds.inset(-40,-40);
let newGroupItem = new GroupItem(tabItems, { bounds: newGroupItemBounds });
newGroupItem.snap();
this.setActiveGroupItem(newGroupItem);
},
// ----------
// Function: getActiveGroupItem
// Returns the active groupItem. Active means its tabs are
// shown in the tab bar when not in the TabView interface.
getActiveGroupItem: function GroupItems_getActiveGroupItem() {
return this._activeGroupItem;
},
// ----------
// Function: setActiveGroupItem
// Sets the active groupItem, thereby showing only the relevant tabs and
// setting the groupItem which will receive new tabs.
//
// Paramaters:
// groupItem - the active <GroupItem> or <null> if no groupItem is active
// (which means we have an orphaned tab selected)
setActiveGroupItem: function GroupItems_setActiveGroupItem(groupItem) {
if (this._activeGroupItem)
iQ(this._activeGroupItem.container).removeClass('activeGroupItem');
if (groupItem !== null) {
if (groupItem)
iQ(groupItem.container).addClass('activeGroupItem');
// if a groupItem is active, we surely are not in an orphaned tab.
this.setActiveOrphanTab(null);
}
this._activeGroupItem = groupItem;
this._save();
},
// ----------
// Function: getActiveOrphanTab
// Returns the active orphan tab, in cases when there is no active groupItem.
getActiveOrphanTab: function GroupItems_getActiveOrphanTab() {
return this._activeOrphanTab;
},
// ----------
// Function: setActiveOrphanTab
// In cases where an orphan tab (not in a groupItem) is active by itself,
// this function is called and the "active orphan tab" is set.
//
// Paramaters:
// groupItem - the active <TabItem> or <null>
setActiveOrphanTab: function GroupItems_setActiveOrphanTab(tabItem) {
this._activeOrphanTab = tabItem;
},
// ----------
// Function: _updateTabBar
// Hides and shows tabs in the tab bar based on the active groupItem or
// currently active orphan tabItem
_updateTabBar: function GroupItems__updateTabBar() {
if (!window.UI)
return; // called too soon
if (!this._activeGroupItem && !this._activeOrphanTab) {
Utils.assert(false, "There must be something to show in the tab bar!");
return;
}
let tabItems = this._activeGroupItem == null ?
[this._activeOrphanTab] : this._activeGroupItem._children;
gBrowser.showOnlyTheseTabs(tabItems.map(function(item) item.tab));
},
// ----------
// Function: updateActiveGroupItemAndTabBar
// Sets active TabItem and GroupItem, and updates tab bar appropriately.
updateActiveGroupItemAndTabBar: function GroupItems_updateActiveGroupItemAndTabBar(tabItem) {
Utils.assertThrow(tabItem && tabItem.isATabItem, "tabItem must be a TabItem");
let groupItem = tabItem.parent;
this.setActiveGroupItem(groupItem);
if (groupItem)
groupItem.setActiveTab(tabItem);
else
this.setActiveOrphanTab(tabItem);
this._updateTabBar();
},
// ----------
// Function: getOrphanedTabs
// Returns an array of all tabs that aren't in a groupItem.
getOrphanedTabs: function GroupItems_getOrphanedTabs() {
var tabs = TabItems.getItems();
tabs = tabs.filter(function(tab) {
return tab.parent == null;
});
return tabs;
},
// ----------
// Function: getNextGroupItemTab
// Paramaters:
// reverse - the boolean indicates the direction to look for the next groupItem.
// Returns the <tabItem>. If nothing is found, return null.
getNextGroupItemTab: function GroupItems_getNextGroupItemTab(reverse) {
var groupItems = Utils.copy(GroupItems.groupItems);
var activeGroupItem = GroupItems.getActiveGroupItem();
var activeOrphanTab = GroupItems.getActiveOrphanTab();
var tabItem = null;
if (reverse)
groupItems = groupItems.reverse();
if (!activeGroupItem) {
if (groupItems.length > 0) {
groupItems.some(function(groupItem) {
if (!groupItem.hidden) {
// restore the last active tab in the group
let activeTab = groupItem.getActiveTab();
if (activeTab) {
tabItem = activeTab;
return true;
}
// if no tab is active, use the first one
var child = groupItem.getChild(0);
if (child) {
tabItem = child;
return true;
}
}
return false;
});
}
} else {
var currentIndex;
groupItems.some(function(groupItem, index) {
if (!groupItem.hidden && groupItem == activeGroupItem) {
currentIndex = index;
return true;
}
return false;
});
var firstGroupItems = groupItems.slice(currentIndex + 1);
firstGroupItems.some(function(groupItem) {
if (!groupItem.hidden) {
// restore the last active tab in the group
let activeTab = groupItem.getActiveTab();
if (activeTab) {
tabItem = activeTab;
return true;
}
// if no tab is active, use the first one
var child = groupItem.getChild(0);
if (child) {
tabItem = child;
return true;
}
}
return false;
});
if (!tabItem) {
var orphanedTabs = GroupItems.getOrphanedTabs();
if (orphanedTabs.length > 0)
tabItem = orphanedTabs[0];
}
if (!tabItem) {
var secondGroupItems = groupItems.slice(0, currentIndex);
secondGroupItems.some(function(groupItem) {
if (!groupItem.hidden) {
// restore the last active tab in the group
let activeTab = groupItem.getActiveTab();
if (activeTab) {
tabItem = activeTab;
return true;
}
// if no tab is active, use the first one
var child = groupItem.getChild(0);
if (child) {
tabItem = child;
return true;
}
}
return false;
});
}
}
return tabItem;
},
// ----------
// Function: moveTabToGroupItem
// Used for the right click menu in the tab strip; moves the given tab
// into the given group. Does nothing if the tab is an app tab.
// Paramaters:
// tab - the <xul:tab>.
// groupItemId - the <groupItem>'s id. If nothing, create a new <groupItem>.
moveTabToGroupItem : function GroupItems_moveTabToGroupItem (tab, groupItemId) {
if (tab.pinned)
return;
Utils.assertThrow(tab._tabViewTabItem, "tab must be linked to a TabItem");
// given tab is already contained in target group
if (tab._tabViewTabItem.parent && tab._tabViewTabItem.parent.id == groupItemId)
return;
let shouldUpdateTabBar = false;
let shouldShowTabView = false;
let groupItem;
// switch to the appropriate tab first.
if (gBrowser.selectedTab == tab) {
if (gBrowser.visibleTabs.length > 1) {
gBrowser._blurTab(tab);
shouldUpdateTabBar = true;
} else {
shouldShowTabView = true;
}
} else {
shouldUpdateTabBar = true
}
// remove tab item from a groupItem
if (tab._tabViewTabItem.parent)
tab._tabViewTabItem.parent.remove(tab._tabViewTabItem);
// add tab item to a groupItem
if (groupItemId) {
groupItem = GroupItems.groupItem(groupItemId);
groupItem.add(tab._tabViewTabItem);
UI.setReorderTabItemsOnShow(groupItem);
} else {
let pageBounds = Items.getPageBounds();
pageBounds.inset(20, 20);
let box = new Rect(pageBounds);
box.width = 250;
box.height = 200;
new GroupItem([ tab._tabViewTabItem ], { bounds: box });
}
if (shouldUpdateTabBar)
this._updateTabBar();
else if (shouldShowTabView) {
tab._tabViewTabItem.setZoomPrep(false);
UI.showTabView();
}
},
// ----------
// Function: removeHiddenGroups
// Removes all hidden groups' data and its browser tabs.
removeHiddenGroups: function GroupItems_removeHiddenGroups() {
if (this._removingHiddenGroups)
return;
this._removingHiddenGroups = true;
let groupItems = this.groupItems.concat();
groupItems.forEach(function(groupItem) {
if (groupItem.hidden)
groupItem.closeHidden();
});
this._removingHiddenGroups = false;
},
// ----------
// Function: getUnclosableGroupItemId
// If there's only one (non-hidden) group, and there are app tabs present,
// returns that group.
// Return the <GroupItem>'s Id
getUnclosableGroupItemId: function GroupItems_getUnclosableGroupItemId() {
let unclosableGroupItemId = null;
if (gBrowser._numPinnedTabs > 0) {
let hiddenGroupItems =
this.groupItems.concat().filter(function(groupItem) {
return !groupItem.hidden;
});
if (hiddenGroupItems.length == 1)
unclosableGroupItemId = hiddenGroupItems[0].id;
}
return unclosableGroupItemId;
},
// ----------
// Function: updateGroupCloseButtons
// Updates group close buttons.
updateGroupCloseButtons: function GroupItems_updateGroupCloseButtons() {
let unclosableGroupItemId = this.getUnclosableGroupItemId();
if (unclosableGroupItemId) {
let groupItem = this.groupItem(unclosableGroupItemId);
if (groupItem) {
groupItem.$closeButton.hide();
}
} else {
this.groupItems.forEach(function(groupItem) {
groupItem.$closeButton.show();
});
}
},
// ----------
// Function: calcValidSize
// Basic measure rules. Assures that item is a minimum size.
calcValidSize: function GroupItems_calcValidSize(size, options) {
Utils.assert(Utils.isPoint(size), 'input is a Point');
Utils.assert((size.x>0 || size.y>0) && (size.x!=0 && size.y!=0),
"dimensions are valid:"+size.x+","+size.y);
return new Point(
Math.max(size.x, GroupItems.minGroupWidth),
Math.max(size.y, GroupItems.minGroupHeight));
}
};
Reference in New Issue View Git Blame Copy Permalink