path: root/comm/mail/components/compose/content/dialogs/EdAdvancedEdit.js

/* 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/. */

/* import-globals-from ../editorUtilities.js */
/* import-globals-from EdAEAttributes.js */
/* import-globals-from EdAECSSAttributes.js */
/* import-globals-from EdAEHTMLAttributes.js */
/* import-globals-from EdAEJSEAttributes.js */
/* import-globals-from EdDialogCommon.js */

/** ************         GLOBALS         */
var gElement = null; // handle to actual element edited

var HTMLAttrs = []; // html attributes
var CSSAttrs = []; // css attributes
var JSEAttrs = []; // js events

var HTMLRAttrs = []; // removed html attributes
var JSERAttrs = []; // removed js events

/* Set false to allow changing selection in tree
   without doing "onselect" handler actions
*/
var gDoOnSelectTree = true;
var gUpdateTreeValue = true;

/** ************ INITIALISATION && SETUP */

document.addEventListener("dialogaccept", onAccept);
document.addEventListener("dialogcancel", onCancel);

/**
 * function   : void Startup();
 * parameters : none
 * returns    : none
 * desc.      : startup and initialisation, prepares dialog.
 */
function Startup() {
  var editor = GetCurrentEditor();

  // Element to edit is passed in
  if (!editor || !window.arguments[1]) {
    dump("Advanced Edit: No editor or element to edit not supplied\n");
    window.close();
    return;
  }
  // This is the return value for the parent,
  // who only needs to know if OK was clicked
  window.opener.AdvancedEditOK = false;

  // The actual element edited (not a copy!)
  gElement = window.arguments[1];

  // place the tag name in the header
  var tagLabel = document.getElementById("tagLabel");
  tagLabel.setAttribute("value", "<" + gElement.localName + ">");

  // Create dialog object to store controls for easy access
  gDialog.AddHTMLAttributeNameInput = document.getElementById(
    "AddHTMLAttributeNameInput"
  );

  gDialog.AddHTMLAttributeValueMenulist = document.getElementById(
    "AddHTMLAttributeValueMenulist"
  );
  gDialog.AddHTMLAttributeValueTextbox = document.getElementById(
    "AddHTMLAttributeValueTextbox"
  );
  gDialog.AddHTMLAttributeValueInput = gDialog.AddHTMLAttributeValueTextbox;

  gDialog.AddHTMLAttributeTree = document.getElementById("HTMLATree");
  gDialog.AddCSSAttributeNameInput = document.getElementById(
    "AddCSSAttributeNameInput"
  );
  gDialog.AddCSSAttributeValueInput = document.getElementById(
    "AddCSSAttributeValueInput"
  );
  gDialog.AddCSSAttributeTree = document.getElementById("CSSATree");
  gDialog.AddJSEAttributeNameList = document.getElementById(
    "AddJSEAttributeNameList"
  );
  gDialog.AddJSEAttributeValueInput = document.getElementById(
    "AddJSEAttributeValueInput"
  );
  gDialog.AddJSEAttributeTree = document.getElementById("JSEATree");
  gDialog.okButton = document.querySelector("dialog").getButton("accept");

  // build the attribute trees
  BuildHTMLAttributeTable();
  BuildCSSAttributeTable();
  BuildJSEAttributeTable();

  // Build attribute name arrays for menulists
  BuildJSEAttributeNameList();
  BuildHTMLAttributeNameList();
  // No menulists for CSS panel (yet)

  // Set focus to Name editable menulist in HTML panel
  SetTextboxFocus(gDialog.AddHTMLAttributeNameInput);

  // size the dialog properly
  window.sizeToContent();

  SetWindowLocation();
}

/**
 * function   : bool onAccept ( void );
 * parameters : none
 * returns    : boolean true to close the window
 * desc.      : event handler for ok button
 */
function onAccept() {
  var editor = GetCurrentEditor();
  editor.beginTransaction();
  try {
    // Update our gElement attributes
    UpdateHTMLAttributes();
    UpdateCSSAttributes();
    UpdateJSEAttributes();
  } catch (ex) {
    dump(ex);
  }
  editor.endTransaction();

  window.opener.AdvancedEditOK = true;
  SaveWindowLocation();
}

// Helpers for removing and setting attributes
// Use editor transactions if modifying the element already in the document
// (Temporary element from a property dialog won't have a parent node)
function doRemoveAttribute(attrib) {
  try {
    var editor = GetCurrentEditor();
    if (gElement.parentNode) {
      editor.removeAttribute(gElement, attrib);
    } else {
      gElement.removeAttribute(attrib);
    }
  } catch (ex) {}
}

function doSetAttribute(attrib, value) {
  try {
    var editor = GetCurrentEditor();
    if (gElement.parentNode) {
      editor.setAttribute(gElement, attrib, value);
    } else {
      gElement.setAttribute(attrib, value);
    }
  } catch (ex) {}
}

/**
 * function   : bool CheckAttributeNameSimilarity ( string attName, array attArray );
 * parameters : attribute to look for, array of current attributes
 * returns    : true if attribute already exists, false if it does not
 * desc.      : checks to see if any other attributes by the same name as the arg supplied
 *              already exist.
 */
function CheckAttributeNameSimilarity(attName, attArray) {
  for (var i = 0; i < attArray.length; i++) {
    if (attName.toLowerCase() == attArray[i].toLowerCase()) {
      return true;
    }
  }
  return false;
}

/**
 * function   : bool UpdateExistingAttribute ( string attName, string attValue, string treeChildrenId );
 * parameters : attribute to look for, new value, ID of <treeChildren> node in XUL tree
 * returns    : true if attribute already exists in tree, false if it does not
 * desc.      : checks to see if any other attributes by the same name as the arg supplied
 *              already exist while setting the associated value if different from current value
 */
function UpdateExistingAttribute(attName, attValue, treeChildrenId) {
  var treeChildren = document.getElementById(treeChildrenId);
  if (!treeChildren) {
    return false;
  }

  var name;
  var i;
  attName = TrimString(attName).toLowerCase();
  attValue = TrimString(attValue);

  for (i = 0; i < treeChildren.children.length; i++) {
    var item = treeChildren.children[i];
    name = GetTreeItemAttributeStr(item);
    if (name.toLowerCase() == attName) {
      // Set the text in the "value' column treecell
      SetTreeItemValueStr(item, attValue);

      // Select item just changed,
      //  but don't trigger the tree's onSelect handler
      gDoOnSelectTree = false;
      try {
        selectTreeItem(treeChildren, item);
      } catch (e) {}
      gDoOnSelectTree = true;

      return true;
    }
  }
  return false;
}

/**
 * function   : string GetAndSelectExistingAttributeValue ( string attName, string treeChildrenId );
 * parameters : attribute to look for, ID of <treeChildren> node in XUL tree
 * returns    : value in from the tree or empty string if name not found
 */
function GetAndSelectExistingAttributeValue(attName, treeChildrenId) {
  if (!attName) {
    return "";
  }

  var treeChildren = document.getElementById(treeChildrenId);
  var name;
  var i;

  for (i = 0; i < treeChildren.children.length; i++) {
    var item = treeChildren.children[i];
    name = GetTreeItemAttributeStr(item);
    if (name.toLowerCase() == attName.toLowerCase()) {
      // Select item in the tree
      //  but don't trigger the tree's onSelect handler
      gDoOnSelectTree = false;
      try {
        selectTreeItem(treeChildren, item);
      } catch (e) {}
      gDoOnSelectTree = true;

      // Get the text in the "value' column treecell
      return GetTreeItemValueStr(item);
    }
  }

  // Attribute doesn't exist in tree, so remove selection
  gDoOnSelectTree = false;
  try {
    treeChildren.parentNode.view.selection.clearSelection();
  } catch (e) {}
  gDoOnSelectTree = true;

  return "";
}

/* Tree structure:
  <treeItem>
    <treeRow>
      <treeCell> // Name Cell
      <treeCell  // Value Cell
*/
function GetTreeItemAttributeStr(treeItem) {
  if (treeItem) {
    return TrimString(
      treeItem.firstElementChild.firstElementChild.getAttribute("label")
    );
  }

  return "";
}

function GetTreeItemValueStr(treeItem) {
  if (treeItem) {
    return TrimString(
      treeItem.firstElementChild.lastElementChild.getAttribute("label")
    );
  }

  return "";
}

function SetTreeItemValueStr(treeItem, value) {
  if (treeItem && GetTreeItemValueStr(treeItem) != value) {
    treeItem.firstElementChild.lastElementChild.setAttribute("label", value);
  }
}

function IsNotTreeHeader(treeCell) {
  if (treeCell) {
    return treeCell.parentNode.parentNode.nodeName != "treehead";
  }

  return false;
}

function RemoveNameFromAttArray(attName, attArray) {
  for (var i = 0; i < attArray.length; i++) {
    if (attName.toLowerCase() == attArray[i].toLowerCase()) {
      // Remove 1 array item
      attArray.splice(i, 1);
      break;
    }
  }
}

// adds a generalised treeitem.
function AddTreeItem(name, value, treeChildrenId, attArray) {
  attArray[attArray.length] = name;
  var treeChildren = document.getElementById(treeChildrenId);
  var treeitem = document.createXULElement("treeitem");
  var treerow = document.createXULElement("treerow");

  var attrCell = document.createXULElement("treecell");
  attrCell.setAttribute("class", "propertylist");
  attrCell.setAttribute("label", name);

  var valueCell = document.createXULElement("treecell");
  valueCell.setAttribute("class", "propertylist");
  valueCell.setAttribute("label", value);

  treerow.appendChild(attrCell);
  treerow.appendChild(valueCell);
  treeitem.appendChild(treerow);
  treeChildren.appendChild(treeitem);

  // Select item just added, but suppress calling the onSelect handler.
  gDoOnSelectTree = false;
  try {
    selectTreeItem(treeChildren, treeitem);
  } catch (e) {}
  gDoOnSelectTree = true;

  return treeitem;
}

function selectTreeItem(treeChildren, item) {
  var index = treeChildren.parentNode.view.getIndexOfItem(item);
  treeChildren.parentNode.view.selection.select(index);
}

function getSelectedItem(tree) {
  if (tree.view.selection.count == 1) {
    return tree.view.getItemAtIndex(tree.currentIndex);
  }
  return null;
}