ServicePaneHelper.jsm

Go to the documentation of this file.

/*
 *=BEGIN SONGBIRD GPL
 *
 * This file is part of the Songbird web player.
 *
 * Copyright(c) 2005-2010 POTI, Inc.
 * http://www.songbirdnest.com
 *
 * This file may be licensed under the terms of of the
 * GNU General Public License Version 2 (the ``GPL'').
 *
 * Software distributed under the License is distributed
 * on an ``AS IS'' basis, WITHOUT WARRANTY OF ANY KIND, either
 * express or implied. See the GPL for the specific language
 * governing rights and limitations.
 *
 * You should have received a copy of the GPL along with this
 * program. If not, go to http://www.gnu.org/licenses/gpl.html
 * or write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 *=END SONGBIRD GPL
 */

EXPORTED_SYMBOLS = [ "ServicePaneHelper" ];

const Cc = Components.classes;
const Ci = Components.interfaces;
const Cr = Components.results;
const Ce = Components.Exception;
const Cu = Components.utils;

function getBadgesForNode(node)
{
  let attr = node.getAttribute("badges");
  if (attr)
    return attr.split(/\s+/);
  else
    return [];
}

var badgeIndex = 0;

function ServicePaneBadge(node, id) {
  if (!id)
    throw "Badge ID is a mandatory parameter";
  if (id && /\s/.test(id))
    throw "Spaces are not allowed in badge ID";

  this.__defineGetter__("node", function() node);
  this.__defineGetter__("id", function() id);
}
ServicePaneBadge.prototype = {
  get label() {
    return this.node.getAttribute("badge_" + this.id + "_label");
  },
  set label(value) {
    this.node.setAttribute("badge_" + this.id + "_label", value);
    return value;
  },

  get image() {
    return this.node.getAttribute("badge_" + this.id + "_image");
  },
  set image(value) {
    this.node.setAttribute("badge_" + this.id + "_image", value);
    return value;
  },

  get visible() {
    let badges = getBadgesForNode(this.node);
    return (badges.indexOf(this.id) >= 0);
  },
  set visible(val) {
    let badges = getBadgesForNode(this.node);
    let currentIndex = badges.indexOf(this.id);
    if (val) {
      if (currentIndex < 0)
        this.append();
    }
    else {
      if (currentIndex >= 0) {
        badges.splice(currentIndex, 1);
        this.node.setAttribute("badges", badges.length ? badges.join(" ") : null);
      }
    }
    return false;
  },

  append: function()
  {
    this.insertBefore(null);
  },

  insertBefore: function(id) {
    if (id && /\s/.test(id))
      throw "No spaces allowed in badge ID";

    let badges = getBadgesForNode(this.node);

    let currentIndex = badges.indexOf(this.id);
    if (currentIndex >= 0)
      badges.splice(currentIndex, 1);

    let newIndex = (id ? badges.indexOf(id) : -1);
    if (newIndex < 0)
      newIndex = badges.length;
    badges.splice(newIndex, 0, this.id);

    this.node.setAttribute("badges", badges.join(" "));
  },

  remove: function() {
    this.visible = false;
    this.node.removeAttribute("badge_" + this.id + "_label");
    this.node.removeAttribute("badge_" + this.id + "_image");
  }
};

var ServicePaneHelper = {
  getBadge: function(node, badgeID) {
    if (!badgeID) {
      // Generate badge ID automatically if none given, use NUL character to
      // avoid clashes with user-supplied IDs
      badgeID = "badge\x00" + badgeIndex++;
    } else if (/\x00/.test(badgeID)) {
      // NUL characters are reserved for generated IDs
      throw "No NUL characters allowed in badge ID";
    }

    return new ServicePaneBadge(node, badgeID);
  },

  getAllBadges: function(node) {
    let badges = getBadgesForNode(node);
    return (new ServicePaneBadge(node, badgeID) for each (badgeID in badges));
  }
};