Magic-Mirror/gecko-dev
1
0
Fork 0
mirror of https://github.com/mozilla/gecko-dev.git synced 2024-11-07 20:17:37 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
1ec1a6333c
gecko-dev/suite/common/sidebar/sidebarOverlay.js

1031 lines
34 KiB
JavaScript
Raw Blame History

/* -*- Mode: Java; tab-width: 4; insert-tabs-mode: nil; c-basic-offset: 2 -*-
*
* 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 Mozilla Communicator client code, released
* March 31, 1998.
*
* The Initial Developer of the Original Code is Netscape
* Communications Corporation. Portions created by Netscape are
* Copyright (C) 1998-1999 Netscape Communications Corporation. All
* Rights Reserved.
*/
// xul/id summary:
//
// <box> sidebar-box
// <splitter> sidebar-panels-splitter
// <box> sidebar-panels-splitter-box*
// <sidebarheader> sidebar-title-box
// <menubutton> sidebar-panel-picker*
// <menupopup> sidebar-panel-picker-popup
// <box> sidebar-panels
// <template> sidebar-template*
// <box> sidebar-iframe-no-panels
// <splitter> sidebar-splitter
// <menupopup> menu_View_Popup*
// <menuitem> sidebar-menu
//////////////////////////////////////////////////////////////
// Global variables
//////////////////////////////////////////////////////////////
// Uncomment for debug output
const SB_DEBUG = false;
// The rdf service
const RDF_URI = 'component://netscape/rdf/rdf-service';
var RDF = Components.classes[RDF_URI].getService();
RDF = RDF.QueryInterface(Components.interfaces.nsIRDFService);
const NC = "http://home.netscape.com/NC-rdf#";
// The directory services property to find panels.rdf
const PANELS_RDF_FILE = "UPnls";
const SIDEBAR_VERSION = "0.1";
// The default sidebar:
var sidebarObj = new Object;
sidebarObj.never_built = true;
//////////////////////////////////////////////////////////////////////
// sbPanelList Class
//
// Wrapper around DOM representation of the sidebar. This UI event
// handlers and the sidebar datasource observers call into this. This
// class is responsible for keeping the DOM state of the sidebar up to
// date.
// This class does not make any changes to the sidebar rdf datasource.
//////////////////////////////////////////////////////////////////////
function sbPanelList(container_id)
{
debug("sbPanelList("+container_id+")");
this.node = document.getElementById(container_id);
this.childNodes = this.node.childNodes;
}
sbPanelList.prototype.get_panel_from_id =
function (id)
{
debug("get_panel_from_id(" + id + ")");
var index = 0;
var header = null;
if (id && id != '') {
for (var ii=2; ii < this.node.childNodes.length; ii += 2) {
header = this.node.childNodes.item(ii);
if (header.getAttribute('id') == id) {
debug("get_panel_from_id: Found at index, " + ii);
index = ii;
break;
}
}
}
if (index > 0) {
return new sbPanel(id, header, index);
} else {
return null;
}
}
sbPanelList.prototype.get_panel_from_header_node =
function (node)
{
return this.get_panel_from_id(node.getAttribute('id'));
}
sbPanelList.prototype.get_panel_from_header_index =
function (index)
{
return this.get_panel_from_header_node(this.node.childNodes.item(index));
}
sbPanelList.prototype.find_last =
function (panels)
{
debug("pick_default_panel: length=" + this.node.childNodes.length);
for (var ii=(this.node.childNodes.length - 1); ii >= 2; ii -= 2) {
var panel = this.get_panel_from_header_index(ii);
if (!panel.is_excluded()) {
return panel;
}
}
return null;
}
sbPanelList.prototype.select =
function (panel, force_reload)
{
if (!force_reload && panel.is_selected()) {
return;
}
// select(): Open this panel and possibly reload it.
if (this.node.getAttribute('last-selected-panel') != panel.id) {
// "last-selected-panel" is used as a global variable.
// this.update() will reference "last-selected-panel".
// This way the value can be persisted in localstore.rdf.
this.node.setAttribute('last-selected-panel', panel.id);
}
this.update(force_reload);
}
sbPanelList.prototype.exclude =
function (panel)
{
if (this.node.getAttribute('last-selected-panel') == panel.id) {
this.select_default_panel();
} else {
this.update(false);
}
}
sbPanelList.prototype.select_default_panel =
function ()
{
var default_panel = null
// First, check the XUL for the "defaultpanel" attribute of "sidebar-box".
var sidebar_container = document.getElementById('sidebar-box');
var content_default_id = sidebar_container.getAttribute('defaultpanel');
if (content_default_id != '') {
var content = sidebarObj.panels.get_panel_from_id(content_default_id);
if (content && !content.is_excluded()) {
default_panel = content;
}
}
// Second, try to use the panel persisted in 'last-selected-panel'.
if (!default_panel) {
var last_selected_id = this.node.getAttribute('last-selected-panel');
if (last_selected_id != '') {
var last = sidebarObj.panels.get_panel_from_id(last_selected_id);
if (last && !last.is_excluded()) {
default_panel = last;
}
}
}
// Finally, just use the last one in the list.
if (!default_panel) {
default_panel = this.find_last();
}
if (default_panel) {
this.node.setAttribute('last-selected-panel', default_panel.id);
}
this.update(false);
}
sbPanelList.prototype.refresh =
function ()
{
var last_selected_id = this.node.getAttribute('last-selected-panel');
var last_selected = sidebarObj.panels.get_panel_from_id(last_selected_id);
if (last_selected && last_selected.is_selected()) {
// The desired panel is already selected
this.update(false);
} else {
this.select_default_panel();
}
}
// panel_loader(): called from a timer that is set in sbPanelList.update()
// Removes the "Loading..." screen when the panel has finished loading.
function panel_loader() {
debug("panel_loader()");
this.removeEventListener("load", panel_loader, true);
this.removeAttribute('collapsed');
this.setAttribute('loadstate','loaded');
this.parentNode.firstChild.setAttribute('hidden','true');
}
sbPanelList.prototype.update =
function (force_reload)
{
// This function requires that the attribute 'last-selected-panel'
// holds the id of a non-excluded panel. If it doesn't, no panel will
// be selected. The attribute is used instead of a funciton
// parameter to allow the value to be persisted in localstore.rdf.
var selected_id = this.node.getAttribute('last-selected-panel');
if (sidebar_is_collapsed()) {
sidebarObj.collapsed = true;
} else {
sidebarObj.collapsed = false;
}
var have_set_top = 0;
var have_set_after_selected = 0;
var is_after_selected = 0;
var last_header = 0;
for (var ii=2; ii < this.node.childNodes.length; ii += 2) {
var header = this.node.childNodes.item(ii);
var content = this.node.childNodes.item(ii+1);
var id = header.getAttribute('id');
var panel = new sbPanel(id, header, ii);
if (panel.is_excluded()) {
debug("item("+ii/2+") excluded");
header.setAttribute('hidden','true');
content.setAttribute('hidden','true');
} else {
last_header = header;
header.removeAttribute('last-panel');
if (!have_set_top) {
header.setAttribute('top-panel','true');
have_set_top = 1
} else {
header.removeAttribute('top-panel');
}
if (!have_set_after_selected && is_after_selected) {
header.setAttribute('first-panel-after-selected','true');
have_set_after_selected = 1
} else {
header.removeAttribute('first-panel-after-selected');
}
header.removeAttribute('hidden');
// Pick sandboxed, or unsandboxed iframe
var iframe = panel.get_iframe();
var load_state;
if (selected_id == id) {
is_after_selected = 1
debug("item("+ii/2+") selected");
header.setAttribute('selected', 'true');
content.removeAttribute('hidden');
content.removeAttribute('collapsed');
if (sidebarObj.collapsed && panel.is_sandboxed()) {
debug(" set src=about:blank");
iframe.setAttribute('src', 'about:blank');
} else {
var saved_src = iframe.getAttribute('content');
var src = iframe.getAttribute('src');
if (saved_src != src) {
debug(" set src="+saved_src);
iframe.setAttribute('src', saved_src);
}
}
load_state = content.getAttribute('loadstate');
if (load_state == 'never loaded') {
iframe.removeAttribute('hidden');
iframe.setAttribute('loadstate', 'loading');
iframe.addEventListener('load', panel_loader, true);
}
} else {
debug("item("+ii/2+")");
header.removeAttribute('selected');
content.setAttribute('collapsed','true');
load_state = content.getAttribute('loadstate');
if (load_state == 'loading') {
iframe.removeEventListener("load", panel_loader, true);
content.setAttribute('hidden','true');
iframe.setAttribute('loadstate', 'never loaded');
}
if (panel.is_sandboxed()) {
iframe.setAttribute('src', 'about:blank');
}
}
}
}
if (last_header) {
last_header.setAttribute('last-panel','true');
}
var no_panels_iframe = document.getElementById('sidebar-iframe-no-panels');
if (have_set_top) {
no_panels_iframe.setAttribute('hidden','true');
// The hide and show of 'sidebar-panels' should not be needed,
// but some old profiles may have this persisted as hidden (50973).
this.node.removeAttribute('hidden');
} else {
no_panels_iframe.removeAttribute('hidden');
this.node.setAttribute('hidden','true');
}
}
//////////////////////////////////////////////////////////////////////
// sbPanel Class
//
// Like sbPanelList, this class is a wrapper around DOM representation
// of individual panels in the sidebar. This UI event handlers and the
// sidebar datasource observers call into this. This class is
// responsible for keeping the DOM state of the sidebar up to date.
// This class does not make any changes to the sidebar rdf datasource.
//////////////////////////////////////////////////////////////////////
function sbPanel(id, header, index)
{
// This constructor should only be called by sbPanelList class.
// To create a panel instance, use the helper functions in sbPanelList:
// sb_panel.get_panel_from_id(id)
// sb_panel.get_panel_from_header_node(dom_node)
// sb_panel.get_panel_from_header_index(index)
this.id = id;
this.header = header;
this.index = index;
this.parent = sidebarObj.panels;
}
sbPanel.prototype.get_header =
function ()
{
return this.header;
}
sbPanel.prototype.get_content =
function ()
{
return this.get_header().nextSibling;
}
sbPanel.prototype.is_sandboxed =
function ()
{
if (typeof this.sandboxed == "undefined") {
var content = this.get_content();
var unsandboxed_iframe = content.childNodes.item(1);
this.sandboxed = !unsandboxed_iframe.getAttribute('content').match(/^chrome:/);
}
return this.sandboxed;
}
sbPanel.prototype.get_iframe =
function ()
{
if (typeof this.iframe == "undefined") {
var content = this.get_content();
if (this.is_sandboxed()) {
var unsandboxed_iframe = content.childNodes.item(1);
this.iframe = unsandboxed_iframe;
} else {
var sandboxed_iframe = content.childNodes.item(2);
this.iframe = sandboxed_iframe;
}
}
return this.iframe;
}
// This exclude function is used on panels and on the panel picker menu.
// That is why it is hanging out in the global name space instead of
// minding its own business in the class.
function sb_panel_is_excluded(node)
{
var exclude = node.getAttribute('exclude');
return ( exclude && exclude != '' &&
exclude.indexOf(sidebarObj.component) != -1 );
}
sbPanel.prototype.is_excluded =
function ()
{
return sb_panel_is_excluded(this.get_header());
}
sbPanel.prototype.is_selected =
function (panel_id)
{
return 'true' == this.get_header().getAttribute('selected');
}
sbPanel.prototype.select =
function (force_reload)
{
this.parent.select(this, force_reload);
}
sbPanel.prototype.stop_load =
function ()
{
var iframe = this.get_iframe();
var content = this.get_content();
var load_state = iframe.getAttribute('loadstate');
if (load_state == "loading") {
debug("Stop the presses");
iframe.removeEventListener("load", panel_loader, true);
content.setAttribute("loadstate", "stopped");
iframe.setAttribute('src', 'about:blank');
}
}
sbPanel.prototype.exclude =
function ()
{
// Exclusion is handled by the datasource,
// but we need to make sure this panel is no longer selected.
this.get_header().removeAttribute('selected');
this.parent.exclude(this);
}
sbPanel.prototype.reload =
function ()
{
if (!this.is_excluded()) {
this.select(true);
}
}
//////////////////////////////////////////////////////////////////
// Panels' RDF Datasource Observer
//
// This observer will ensure that the Sidebar UI stays current
// when the datasource changes.
// - When "refresh" is asserted, the sidebar refreshed.
// Currently this happens when a panel is included/excluded or
// added/removed (the later comes from the customize dialog).
// - When "refresh_panel" is asserted, the targeted panel is reloaded.
// Currently this happens when the customize panel dialog is closed.
//////////////////////////////////////////////////////////////////
var panel_observer = {
onAssert : function(ds,src,prop,target) {
//debug ("observer: assert");
// "refresh" is asserted by select menu and by customize.js.
if (prop == RDF.GetResource(NC + "refresh")) {
sidebarObj.panels.refresh();
} else if (prop == RDF.GetResource(NC + "refresh_panel")) {
var panel_id = target.QueryInterface(Components.interfaces.nsIRDFLiteral).Value;
var panel = sidebarObj.panels.get_panel_from_id(panel_id);
panel.reload();
}
},
onUnassert : function(ds,src,prop,target) {
//debug ("observer: unassert");
},
onChange : function(ds,src,prop,old_target,new_target) {
//debug ("observer: change");
},
onMove : function(ds,old_src,new_src,prop,target) {
//debug ("observer: move");
},
beginUpdateBatch : function(ds) {
//debug ("observer: beginUpdateBatch");
},
endUpdateBatch : function(ds) {
//debug ("observer: endUpdateBatch");
}
};
// Use an assertion to pass a "refresh" event to all the sidebars.
// They use observers to watch for this assertion (see above).
function refresh_all_sidebars() {
sidebarObj.datasource.Assert(RDF.GetResource(sidebarObj.resource),
RDF.GetResource(NC + "refresh"),
RDF.GetLiteral("true"),
true);
sidebarObj.datasource.Unassert(RDF.GetResource(sidebarObj.resource),
RDF.GetResource(NC + "refresh"),
RDF.GetLiteral("true"));
}
//////////////////////////////////////////////////////////////
// Sidebar Init
//////////////////////////////////////////////////////////////
function sidebar_overlay_init() {
sidebarObj.panels = new sbPanelList('sidebar-panels');
sidebarObj.datasource_uri = get_sidebar_datasource_uri();
sidebarObj.resource = 'urn:sidebar:current-panel-list';
sidebarObj.master_datasources = "";
sidebarObj.master_datasources = get_remote_datasource_url();
sidebarObj.master_datasources += " chrome://communicator/content/sidebar/local-panels.rdf";
sidebarObj.master_resource = 'urn:sidebar:master-panel-list';
sidebarObj.component = document.firstChild.getAttribute('windowtype');
debug("sidebarObj.component is " + sidebarObj.component);
// Initialize the display
var sidebar_element = document.getElementById('sidebar-box');
var sidebar_menuitem = document.getElementById('sidebar-menu');
if (sidebar_is_hidden()) {
if (sidebar_menuitem) {
sidebar_menuitem.setAttribute('checked', 'false');
}
} else {
if (sidebar_menuitem) {
sidebar_menuitem.setAttribute('checked', 'true');
}
if (sidebarObj.never_built) {
sidebarObj.never_built = false;
debug("sidebar = " + sidebarObj);
debug("sidebarObj.resource = " + sidebarObj.resource);
debug("sidebarObj.datasource_uri = " + sidebarObj.datasource_uri);
// Show the header for the panels area. Use a splitter if there
// is stuff over the panels area.
var sidebar_panels_splitter = document.getElementById('sidebar-panels-splitter');
if (sidebar_element.firstChild != sidebar_panels_splitter) {
debug("Showing the panels splitter");
sidebar_panels_splitter.removeAttribute('hidden');
}
// Add the user's current panel choices to the template builder,
// which will aggregate it with the other datasources that describe
// the individual panel's title, customize URL, and content URL.
var panels = document.getElementById('sidebar-panels');
panels.database.AddDataSource(RDF.GetDataSource(sidebarObj.datasource_uri));
debug("Adding observer to database.");
panels.database.AddObserver(panel_observer);
// XXX This is a hack to force re-display
panels.setAttribute('ref', sidebarObj.resource);
}
if (sidebar_is_collapsed()) {
sidebarObj.collapsed = true;
} else {
sidebarObj.collapsed = false;
}
sidebar_open_default_panel(100, 0);
}
}
function sidebar_overlay_destruct() {
var panels = document.getElementById('sidebar-panels');
debug("Removing observer from database.");
panels.database.RemoveObserver(panel_observer);
}
function sidebar_open_default_panel(wait, tries) {
var panels = document.getElementById('sidebar-panels');
debug("sidebar_open_default_panel("+wait+","+tries+")");
// Make sure the sidebar exists before trying to refresh it.
if (panels.childNodes.length <= 2) {
if (tries < 3) {
// No children yet, try again later
setTimeout('sidebar_open_default_panel('+(wait*2)+','+(tries+1)+')',wait);
return;
} else {
sidebar_fixup_datasource();
}
}
sidebarObj.panels.refresh();
}
//////////////////////////////////////////////////////////////
// Sidebar File and Datasource functions
//////////////////////////////////////////////////////////////
function sidebar_get_panels_file() {
try {
var locator_service = Components.classes["component://netscape/file/directory_service"].getService();
if (locator_service)
locator_service = locator_service.QueryInterface(Components.interfaces.nsIProperties);
// Use the fileLocator to look in the profile directory to find
// 'panels.rdf', which is the database of the user's currently
// selected panels.
// If <profile>/panels.rdf doesn't exist, GetFileLocation() will copy
// bin/defaults/profile/panels.rdf to <profile>/panels.rdf
var sidebar_file = locator_service.get(PANELS_RDF_FILE, Components.interfaces.nsIFile);
if (!sidebar_file.exists()) {
// This should not happen, as GetFileLocation() should copy
// defaults/panels.rdf to the users profile directory
debug("Sidebar panels file does not exist");
throw("Panels file does not exist");
}
return sidebar_file;
} catch (ex) {
// This should not happen
debug("Error: Unable to grab panels file.\n");
throw(ex);
}
return null;
}
function sidebar_revert_to_default_panels() {
try {
var sidebar_file = sidebar_get_panels_file();
// Calling delete() with array notation (workaround for bug 37406).
sidebar_file["delete"](false);
// Since we just removed the panels file,
// this should copy the defaults over.
sidebar_file = sidebar_get_panels_file();
debug("sidebar defaults reloaded");
var datasource = RDF.GetDataSource(sidebarObj.datasource_uri);
datasource.QueryInterface(Components.interfaces.nsIRDFRemoteDataSource).Refresh(true);
} catch (ex) {
debug("Error: Unable to reload panel defaults file.\n");
}
return null;
}
function get_sidebar_datasource_uri() {
try {
var sidebar_file = sidebar_get_panels_file();
var file_url = Components.classes["component://netscape/network/standard-url"].createInstance(Components.interfaces.nsIFileURL);
file_url.file = sidebar_file;
return file_url.spec;
} catch (ex) {
// This should not happen
debug("Error: Unable to load panels file.\n");
}
return null;
}
// Get the template for the available panels url from preferences.
// Replace variables in the url:
// %LOCALE% --> Application locale (e.g. en-us).
// %VERSION% --> Sidebar file format version (e.g. 0.0).
function get_remote_datasource_url() {
var url = '';
var prefs = Components.classes['component://netscape/preferences'];
if (prefs) {
prefs = prefs.getService();
}
if (prefs) {
prefs = prefs.QueryInterface(Components.interfaces.nsIPref);
}
if (prefs) {
var locale;
try {
url = prefs.CopyCharPref("sidebar.customize.all_panels.url");
url = url.replace(/%SIDEBAR_VERSION%/g, SIDEBAR_VERSION);
} catch(ex) {
debug("Unable to get remote url pref. What now? "+ex);
}
try {
locale = prefs.CopyCharPref("intl.content.langcode");
} catch(ex) {
try {
debug("No lang code pref, intl.content.langcode.");
debug("Use locale from user agent string instead");
var locale_progid = 'component://netscape/intl/nslocaleservice';
var syslocale = Components.classes[locale_progid].getService();
syslocale = syslocale.QueryInterface(Components.interfaces.nsILocaleService);
locale = syslocale.GetLocaleComponentForUserAgent();
} catch(ex) {
debug("Unable to get system locale. What now? "+ex);
}
}
locale = locale.toLowerCase();
url = url.replace(/%LOCALE%/g, locale);
debug("Remote url is " + url);
}
return url;
}
function sidebar_fixup_datasource() {
var datasource = RDF.GetDataSource(sidebarObj.datasource_uri);
var resource = RDF.GetResource(sidebarObj.resource);
var panel_list = datasource.GetTarget(resource,
RDF.GetResource(NC+"panel-list"),
true);
if (!panel_list) {
debug("Sidebar datasource is an old format or busted\n");
sidebar_revert_to_default_panels();
} else {
// The datasource is ok, but it just has no panels.
// sidebar_refresh() will display some helper content.
// Do nothing here.
}
}
//////////////////////////////////////////////////////////////
// Sidebar Interface for XUL
//////////////////////////////////////////////////////////////
// Change the sidebar content to the selected panel.
// Called when a panel title is clicked.
function SidebarSelectPanel(header, should_popopen, should_unhide) {
debug("SidebarSelectPanel("+header+","+should_popopen+","+should_unhide+")");
var panel = sidebarObj.panels.get_panel_from_header_node(header);
if (!panel) {
return false;
}
var popopen = false;
var unhide = false;
if (panel.is_excluded()) {
return false;
}
if (sidebar_is_hidden()) {
if (should_unhide) {
unhide = true;
} else {
return false;
}
}
if (sidebar_is_collapsed()) {
if (should_popopen) {
popopen = true;
} else {
return false;
}
}
if (unhide) SidebarShowHide();
if (popopen) SidebarExpandCollapse();
if (!panel.is_selected()) panel.select(false);
return true;
}
function SidebarStopPanelLoad(header) {
var panel = sidebarObj.panels.get_panel_from_header_node(header);
panel.stop_load();
}
// No one is calling this right now.
function SidebarReload() {
sidebarObj.panels.refresh();
}
// Set up a lame hack to avoid opening two customize
// windows on a double click.
var gDisableCustomize = false;
function enable_customize() {
gDisableCustomize = false;
}
// Bring up the Sidebar customize dialog.
function SidebarCustomize() {
// Use a single sidebar customize dialog
var cwindowManager = Components.classes['component://netscape/rdf/datasource?name=window-mediator'].getService();
var iwindowManager = Components.interfaces.nsIWindowMediator;
var windowManager = cwindowManager.QueryInterface(iwindowManager);
var customizeWindow = windowManager.getMostRecentWindow('sidebar:customize');
if (customizeWindow) {
debug("Reuse existing customize dialog");
customizeWindow.focus();
} else {
debug("Open a new customize dialog");
if (false == gDisableCustomize) {
debug("First time creating customize dialog");
gDisableCustomize = true;
var panels = document.getElementById('sidebar-panels');
customizeWindow = window.openDialog(
'chrome://communicator/content/sidebar/customize.xul',
'_blank','centerscreen,chrome,resizable',
sidebarObj.master_datasources,
sidebarObj.master_resource,
sidebarObj.datasource_uri,
sidebarObj.resource);
setTimeout(enable_customize, 2000);
}
}
}
function sidebar_is_collapsed() {
var sidebar_splitter = document.getElementById('sidebar-splitter');
return (sidebar_splitter &&
sidebar_splitter.getAttribute('state') == 'collapsed');
}
function SidebarExpandCollapse() {
var sidebar_splitter = document.getElementById('sidebar-splitter');
var sidebar_box = document.getElementById('sidebar-box');
if (sidebar_splitter.getAttribute('state') == 'collapsed') {
debug("Expanding the sidebar");
sidebar_splitter.removeAttribute('state');
sidebar_box.removeAttribute('collapsed');
} else {
debug("Collapsing the sidebar");
sidebar_splitter.setAttribute('state', 'collapsed');
sidebar_box.setAttribute('collapsed', 'true');
}
}
// sidebar_is_hidden() - Helper funciton for SidebarShowHide().
function sidebar_is_hidden() {
var sidebar_title = document.getElementById('sidebar-title-box');
var sidebar_box = document.getElementById('sidebar-box');
return sidebar_box.getAttribute('hidden') == 'true'
|| sidebar_title.getAttribute('hidden') == 'true';
}
// Show/Hide the entire sidebar.
// Envoked by the "View / My Sidebar" menu option.
function SidebarShowHide() {
var sidebar_box = document.getElementById('sidebar-box');
var title_box = document.getElementById('sidebar-title-box');
var sidebar_panels_splitter = document.getElementById('sidebar-panels-splitter');
var sidebar_panels_splitter_box = document.getElementById('sidebar-panels-splitter-box');
var sidebar_splitter = document.getElementById('sidebar-splitter');
if (sidebar_is_hidden()) {
debug("Showing the sidebar");
sidebar_box.removeAttribute('hidden');
title_box.removeAttribute('hidden');
sidebar_panels_splitter_box.removeAttribute('hidden');
sidebar_splitter.removeAttribute('hidden');
if (sidebar_box.firstChild != sidebar_panels_splitter) {
debug("Showing the panels splitter");
sidebar_panels_splitter.removeAttribute('hidden');
}
sidebar_overlay_init();
} else {
debug("Hiding the sidebar");
var hide_everything = sidebar_panels_splitter.getAttribute('hidden') == 'true';
if (hide_everything) {
debug("Hide everything");
sidebar_box.setAttribute('hidden', 'true');
sidebar_splitter.setAttribute('hidden', 'true');
} else {
sidebar_panels_splitter.setAttribute('hidden', 'true');
}
title_box.setAttribute('hidden', 'true');
sidebar_panels_splitter_box.setAttribute('hidden', 'true');
}
// Immediately save persistent values
document.persist('sidebar-title-box', 'hidden');
persist_width();
}
function SidebarBuildPickerPopup() {
var menu = document.getElementById('sidebar-panel-picker-popup');
menu.database.AddDataSource(RDF.GetDataSource(sidebarObj.datasource_uri));
menu.setAttribute('ref', sidebarObj.resource);
for (var ii=3; ii < menu.childNodes.length; ii++) {
var panel_menuitem = menu.childNodes.item(ii);
if (sb_panel_is_excluded(panel_menuitem)) {
debug(ii+": "+panel_menuitem.getAttribute('value')+ ": excluded; uncheck.");
panel_menuitem.removeAttribute('checked');
} else {
debug(ii+": "+panel_menuitem.getAttribute('value')+ ": included; check.");
panel_menuitem.setAttribute('checked', 'true');
}
}
}
function SidebarTogglePanel(panel_menuitem) {
// Create a "container" wrapper around the current panels to
// manipulate the RDF:Seq more easily.
sidebarObj.datasource = RDF.GetDataSource(sidebarObj.datasource_uri);
var panel_id = panel_menuitem.getAttribute('id');
var panel = sidebarObj.panels.get_panel_from_id(panel_id);
var panel_exclude = panel_menuitem.getAttribute('exclude')
if (panel_exclude == '') {
// Nothing excluded for this panel yet, so add this component to the list.
debug("Excluding " + panel_id + " from " + sidebarObj.component);
sidebarObj.datasource.Assert(RDF.GetResource(panel_id),
RDF.GetResource(NC + "exclude"),
RDF.GetLiteral(sidebarObj.component),
true);
panel.exclude();
} else {
// Panel has an exclude string, but it may or may not have the
// current component listed in the string.
debug("Current exclude string: " + panel_exclude);
var new_exclude = panel_exclude;
if (sb_panel_is_excluded(panel_menuitem)) {
debug("Plucking this component out of the exclude list");
replace_pat = new RegExp(sidebarObj.component + "\s*");
new_exclude = new_exclude.replace(replace_pat,'');
new_exclude = new_exclude.replace(/^\s+/,'');
panel.select(false);
} else {
debug("Adding this component to the exclude list");
new_exclude = new_exclude + " " + sidebarObj.component;
panel.exclude();
}
if (new_exclude == '') {
debug("Removing exclude list");
sidebarObj.datasource.Unassert(RDF.GetResource(panel_id),
RDF.GetResource(NC + "exclude"),
RDF.GetLiteral(sidebarObj.component));
} else {
debug("New exclude string: " + new_exclude);
exclude_target =
sidebarObj.datasource.GetTarget(RDF.GetResource(panel_id),
RDF.GetResource(NC + "exclude"),
true);
sidebarObj.datasource.Change(RDF.GetResource(panel_id),
RDF.GetResource(NC + "exclude"),
exclude_target,
RDF.GetLiteral(new_exclude));
}
}
// force all the sidebars to update
refresh_all_sidebars();
// Write the modified panels out.
sidebarObj.datasource.QueryInterface(Components.interfaces.nsIRDFRemoteDataSource).Flush();
}
//////////////////////////////////////////////////////////////
// Sidebar Hacks and Work-arounds
//////////////////////////////////////////////////////////////
// SidebarCleanUpExpandCollapse() - Respond to grippy click.
function SidebarCleanUpExpandCollapse() {
// XXX Mini hack. Persist isn't working too well. Force the persist,
// but wait until the change has commited.
setTimeout("document.persist('sidebar-box', 'collapsed');",100);
setTimeout("sidebarObj.panels.refresh();",100);
}
function PersistHeight() {
// XXX Mini hack. Persist isn't working too well. Force the persist,
// but wait until the last drag has been committed.
// May want to do something smarter here like only force it if the
// height has really changed.
setTimeout("document.persist('sidebar-panels-splitter-box','height');",100);
}
function persist_width() {
// XXX Partial workaround for bug #19488.
var sidebar_box = document.getElementById('sidebar-box');
var width = sidebar_box.getAttribute('width');
if (width && (width > 410 || width < 100)) {
sidebar_box.setAttribute('width',168);
debug("Forcing sidebar width to 168. It was too narror or too wide)");
}
// XXX Mini hack. Persist isn't working too well. Force the persist,
// but wait until the width change has commited.
setTimeout("document.persist('sidebar-box', 'width');",100);
}
function SidebarFinishClick() {
// XXX Semi-hack for bug #16516.
// If we had the proper drag event listener, we would not need this
// timeout. The timeout makes sure the width is written to disk after
// the sidebar-box gets the newly dragged width.
setTimeout("persist_width()",100);
var is_collapsed = document.getElementById('sidebar-box').getAttribute('collapsed') == 'true' ? true : false;
debug("collapsed: " + is_collapsed);
if (is_collapsed != sidebarObj.collapsed) {
sidebarObj.panels.refresh();
}
}
///////////////////////////////////////////////////////////////
// Handy Debug Tools
//////////////////////////////////////////////////////////////
if (!SB_DEBUG) {
debug = function (s) {};
dump_attributes = function (node, depth) {};
dump_tree = function (node) {};
var _dump_tree_recur = function (node, depth, index) {};
} else {
debug = function (s) { dump("-*- sbOverlay: " + s + "\n"); };
dump_attributes = function (node, depth) {
var attributes = node.attributes;
var indent = "| | | | | | | | | | | | | | | | | | | | | | | | | | | | . ";
if (!attributes || attributes.length == 0) {
debug(indent.substr(indent.length - depth*2) + "no attributes");
}
for (var ii=0; ii < attributes.length; ii++) {
var attr = attributes.item(ii);
debug(indent.substr(indent.length - depth*2) + attr.name +
"=" + attr.value);
}
}
dump_tree = function (node) {
_dump_tree_recur(node, 0, 0);
}
_dump_tree_recur = function (node, depth, index) {
if (!node) {
debug("dump_tree: node is null");
}
var indent = "| | | | | | | | | | | | | | | | | | | | | | | | | | | | + ";
debug(indent.substr(indent.length - depth*2) + index +
" " + node.nodeName);
if (node.nodeName != "#text") {
dump_attributes(node, depth);
}
var kids = node.childNodes;
for (var ii=0; ii < kids.length; ii++) {
_dump_tree_recur(kids[ii], depth + 1, ii);
}
}
}
//////////////////////////////////////////////////////////////
// Install the load/unload handlers
//////////////////////////////////////////////////////////////
addEventListener("load", sidebar_overlay_init, false);
addEventListener("unload", sidebar_overlay_destruct, false);
Reference in New Issue View Git Blame Copy Permalink