1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
|
/* 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/. */
this.EXPORTED_SYMBOLS = ["SummaryFrameManager"];
/**
* The SummaryFrameManager manages the source attribute of iframes which can
* be multi-purposed. For example, the thread/multimessage summary and the
* folder summary both use it. The SummaryFrameManager takes care of
* causing the content file to be reloaded as necessary, and manages event
* handlers, so that the right callback is called when the specified
* document is loaded.
*
* @param aFrame the iframe that we're managing
*/
function SummaryFrameManager(aFrame) {
this.iframe = aFrame;
this.iframe.addEventListener("DOMContentLoaded", this._onLoad.bind(this),
true);
this.pendingCallback = null;
this.pendingOrLoadedUrl = this.iframe.docShell
? this.iframe.contentDocument.location.href
: "about:blank";
this.callback = null;
this.url = "";
}
SummaryFrameManager.prototype = {
/**
* Clear the summary frame.
*/
clear: function() {
this.loadAndCallback("about:blank");
},
/**
* Load the specified URL if necessary, and cause the specified callback to be
* called either when the document is loaded, or immediately if the document
* is already loaded.
*
* @param aUrl the URL to load
* @param aCallback the callback to run when the URL has loaded; this function
* is passed a single boolean indicating if the URL was changed
*/
loadAndCallback: function(aUrl, aCallback) {
this.url = aUrl;
if (this.pendingOrLoadedUrl != aUrl) {
// We're changing the document. Stash the callback that we want to call
// when it's done loading
this.pendingCallback = aCallback;
this.callback = null; // clear it
this.iframe.contentDocument.location.href = aUrl;
this.pendingOrLoadedUrl = aUrl;
}
else {
// We're being called, but the document has been set already -- either
// we've already received the DOMContentLoaded event, in which case we can
// just call the callback directly, or we're still loading in which case
// we should just wait for the dom event handler, but update the callback.
if (!this.pendingCallback) {
this.callback = aCallback;
if (this.callback) {
this.callback(false);
}
}
else {
this.pendingCallback = aCallback;
}
}
},
_onLoad: function(event) {
try {
// Make sure we're responding to the summary frame being loaded, and not
// some subnode.
if (event.originalTarget != this.iframe.contentDocument)
return;
this.callback = this.pendingCallback;
this.pendingCallback = null;
if (this.pendingOrLoadedUrl != this.iframe.contentDocument.location.href)
Components.utils.reportError(
"Please do not load stuff in the multimessage browser directly, "+
"use the SummaryFrameManager instead.");
else if (this.callback)
this.callback(true);
}
catch (e) {
Components.utils.reportError(e);
}
}
};
|