Bug 729220 - Allow editing of attribute names in the HTML panel of the Page Inspector; r=prouget

Bug 729220 - Allow editing of attribute names in the HTML panel of the Page Inspector; r=prouget
This commit is contained in:
Rob Campbell 2012-03-09 12:49:00 +02:00
parent 7e6c989d84
commit b539e1b534
4 changed files with 311 additions and 25 deletions

View File

@ -309,7 +309,7 @@ TreePanel.prototype = {
/**
* Handle double-click events in the html tree panel.
* (double-clicking an attribute value allows it to be edited)
* Double-clicking an attribute name or value allows it to be edited.
* @param aEvent
* The mouse event.
*/
@ -322,19 +322,33 @@ TreePanel.prototype = {
let target = aEvent.target;
if (!this.hasClass(target, "editable")) {
return;
}
let repObj = this.getRepObject(target);
if (this.hasClass(target, "nodeValue")) {
let repObj = this.getRepObject(target);
let attrName = target.getAttribute("data-attributeName");
let attrVal = target.innerHTML;
this.editAttributeValue(target, repObj, attrName, attrVal);
this.editAttribute(target, repObj, attrName, attrVal);
}
if (this.hasClass(target, "nodeName")) {
let attrName = target.innerHTML;
let attrValNode = target.nextSibling.nextSibling; // skip 2 (=)
if (attrValNode)
this.editAttribute(target, repObj, attrName, attrValNode.innerHTML);
}
},
/**
* Starts the editor for an attribute value.
* Starts the editor for an attribute name or value.
* @param aAttrObj
* The DOM object representing the attribute value in the HTML Tree
* The DOM object representing the attribute name or value in the HTML
* Tree.
* @param aRepObj
* The original DOM (target) object being inspected/edited
* @param aAttrName
@ -342,8 +356,8 @@ TreePanel.prototype = {
* @param aAttrVal
* The current value of the attribute being edited
*/
editAttributeValue:
function TP_editAttributeValue(aAttrObj, aRepObj, aAttrName, aAttrVal)
editAttribute:
function TP_editAttribute(aAttrObj, aRepObj, aAttrName, aAttrVal)
{
let editor = this.treeBrowserDocument.getElementById("attribute-editor");
let editorInput =
@ -357,7 +371,8 @@ TreePanel.prototype = {
this.editingContext = {
attrObj: aAttrObj,
repObj: aRepObj,
attrName: aAttrName
attrName: aAttrName,
attrValue: aAttrVal
};
// highlight attribute-value node in tree while editing
@ -367,7 +382,7 @@ TreePanel.prototype = {
this.addClass(editor, "editing");
// offset the editor below the attribute-value node being edited
let editorVeritcalOffset = 2;
let editorVerticalOffset = 2;
// keep the editor comfortably within the bounds of the viewport
let editorViewportBoundary = 5;
@ -384,7 +399,7 @@ TreePanel.prototype = {
// center the editor against the attribute value
((editorDims.width - attrDims.width) / 2);
let editorTop = attrDims.top + this.treeIFrame.contentWindow.scrollY +
attrDims.height + editorVeritcalOffset;
attrDims.height + editorVerticalOffset;
// but, make sure the editor stays within the visible viewport
editorLeft = Math.max(0, Math.min(
@ -403,8 +418,13 @@ TreePanel.prototype = {
editor.style.top = editorTop + "px";
// set and select the text
editorInput.value = aAttrVal;
editorInput.select();
if (this.hasClass(aAttrObj, "nodeValue")) {
editorInput.value = aAttrVal;
editorInput.select();
} else {
editorInput.value = aAttrName;
editorInput.select();
}
// listen for editor specific events
this.bindEditorEvent(editor, "click", function(aEvent) {
@ -510,15 +530,32 @@ TreePanel.prototype = {
{
let editorInput =
this.treeBrowserDocument.getElementById("attribute-editor-input");
let dirty = false;
// set the new attribute value on the original target DOM element
this.editingContext.repObj.setAttribute(this.editingContext.attrName,
editorInput.value);
if (this.hasClass(this.editingContext.attrObj, "nodeValue")) {
// set the new attribute value on the original target DOM element
this.editingContext.repObj.setAttribute(this.editingContext.attrName,
editorInput.value);
// update the HTML tree attribute value
this.editingContext.attrObj.innerHTML = editorInput.value;
// update the HTML tree attribute value
this.editingContext.attrObj.innerHTML = editorInput.value;
dirty = true;
}
this.IUI.isDirty = true;
if (this.hasClass(this.editingContext.attrObj, "nodeName")) {
// remove the original attribute from the original target DOM element
this.editingContext.repObj.removeAttribute(this.editingContext.attrName);
// set the new attribute value on the original target DOM element
this.editingContext.repObj.setAttribute(editorInput.value,
this.editingContext.attrValue);
// update the HTML tree attribute value
this.editingContext.attrObj.innerHTML = editorInput.value;
dirty = true;
}
this.IUI.isDirty = dirty;
this.IUI.nodeChanged(this.registrationObject);
// event notification

View File

@ -58,6 +58,7 @@ _BROWSER_FILES = \
browser_inspector_bug_665880.js \
browser_inspector_bug_674871.js \
browser_inspector_editor.js \
browser_inspector_editor_name.js \
browser_inspector_bug_566084_location_changed.js \
browser_inspector_infobar.js \
browser_inspector_bug_690361.js \

View File

@ -3,13 +3,8 @@
/* ***** BEGIN LICENSE BLOCK *****
/* Any copyright is dedicated to the Public Domain.
* http://creativecommons.org/publicdomain/zero/1.0/
*
* Contributor(s):
* Rob Campbell <rcampbell@mozilla.com>
* Mihai Sucan <mihai.sucan@gmail.com>
* Kyle Simpson <ksimpson@mozilla.com>
*
* ***** END LICENSE BLOCK ***** */
* ***** END LICENSE BLOCK *****
*/
let doc;
let div;

View File

@ -0,0 +1,253 @@
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=2 et sw=2 tw=80: */
/* ***** BEGIN LICENSE BLOCK *****
/* Any copyright is dedicated to the Public Domain.
* http://creativecommons.org/publicdomain/zero/1.0/
* ***** END LICENSE BLOCK *****
*/
let doc;
let div;
let editorTestSteps;
function doNextStep() {
editorTestSteps.next();
}
function setupEditorTests()
{
div = doc.createElement("div");
div.setAttribute("id", "foobar");
div.setAttribute("class", "barbaz");
doc.body.appendChild(div);
Services.obs.addObserver(setupHTMLPanel, InspectorUI.INSPECTOR_NOTIFICATIONS.OPENED, false);
InspectorUI.toggleInspectorUI();
}
function setupHTMLPanel()
{
Services.obs.removeObserver(setupHTMLPanel, InspectorUI.INSPECTOR_NOTIFICATIONS.OPENED);
Services.obs.addObserver(runEditorTests, InspectorUI.INSPECTOR_NOTIFICATIONS.TREEPANELREADY, false);
InspectorUI.toggleHTMLPanel();
}
function runEditorTests()
{
Services.obs.removeObserver(runEditorTests, InspectorUI.INSPECTOR_NOTIFICATIONS.TREEPANELREADY);
InspectorUI.stopInspecting();
InspectorUI.inspectNode(doc.body, true);
// setup generator for async test steps
editorTestSteps = doEditorTestSteps();
// add step listeners
Services.obs.addObserver(doNextStep, InspectorUI.INSPECTOR_NOTIFICATIONS.EDITOR_OPENED, false);
Services.obs.addObserver(doNextStep, InspectorUI.INSPECTOR_NOTIFICATIONS.EDITOR_CLOSED, false);
Services.obs.addObserver(doNextStep, InspectorUI.INSPECTOR_NOTIFICATIONS.EDITOR_SAVED, false);
// start the tests
doNextStep();
}
function highlighterTrap()
{
// bug 696107
InspectorUI.highlighter.removeListener("nodeselected", highlighterTrap);
ok(false, "Highlighter moved. Shouldn't be here!");
finishUp();
}
function doEditorTestSteps()
{
let treePanel = InspectorUI.treePanel;
let editor = treePanel.treeBrowserDocument.getElementById("attribute-editor");
let editorInput = treePanel.treeBrowserDocument.getElementById("attribute-editor-input");
// Step 1: grab and test the attribute-name nodes in the HTML panel, then open editor
let nodes = treePanel.treeBrowserDocument.querySelectorAll(".nodeName.editable");
let attrNameNode_id = nodes[0]
let attrNameNode_class = nodes[1];
is(attrNameNode_id.innerHTML, "id", "Step 1: we have the correct `id` attribute-name node in the HTML panel");
is(attrNameNode_class.innerHTML, "class", "we have the correct `class` attribute-name node in the HTML panel");
// double-click the `id` attribute-name node to open the editor
executeSoon(function() {
// firing 2 clicks right in a row to simulate a double-click
EventUtils.synthesizeMouse(attrNameNode_id, 2, 2, {clickCount: 2}, attrNameNode_id.ownerDocument.defaultView);
});
yield; // End of Step 1
// Step 2: validate editing session, enter new attribute value into editor, and save input
ok(InspectorUI.treePanel.editingContext, "Step 2: editor session started");
let selection = InspectorUI.selection;
ok(selection, "Selection is: " + selection);
let editorVisible = editor.classList.contains("editing");
ok(editorVisible, "editor popup visible");
// check if the editor popup is "near" the correct position
let editorDims = editor.getBoundingClientRect();
let attrNameNodeDims = attrNameNode_id.getBoundingClientRect();
let editorPositionOK = (editorDims.left >= (attrNameNodeDims.left - editorDims.width - 5)) &&
(editorDims.right <= (attrNameNodeDims.right + editorDims.width + 5)) &&
(editorDims.top >= (attrNameNodeDims.top - editorDims.height - 5)) &&
(editorDims.bottom <= (attrNameNodeDims.bottom + editorDims.height + 5));
ok(editorPositionOK, "editor position acceptable");
// check to make sure the attribute-value node being edited is properly highlighted
let attrNameNodeHighlighted = attrNameNode_id.classList.contains("editingAttributeValue");
ok(attrNameNodeHighlighted, "`id` attribute-name node is editor-highlighted");
is(treePanel.editingContext.repObj, div, "editor session has correct reference to div");
is(treePanel.editingContext.attrObj, attrNameNode_id, "editor session has correct reference to `id` attribute-name node in HTML panel");
is(treePanel.editingContext.attrName, "id", "editor session knows correct attribute-name");
editorInput.value = "burp";
editorInput.focus();
InspectorUI.highlighter.addListener("nodeselected", highlighterTrap);
// hit <enter> to save the textbox value
executeSoon(function() {
// Extra key to test that keyboard handlers have been removed. bug 696107.
EventUtils.synthesizeKey("VK_LEFT", {}, attrNameNode_id.ownerDocument.defaultView);
EventUtils.synthesizeKey("VK_RETURN", {}, attrNameNode_id.ownerDocument.defaultView);
});
// two `yield` statements, to trap both the "SAVED" and "CLOSED" events that will be triggered
yield;
yield; // End of Step 2
// remove this from previous step
InspectorUI.highlighter.removeListener("nodeselected", highlighterTrap);
// Step 3: validate that the previous editing session saved correctly, then open editor on `class` attribute value
ok(!treePanel.editingContext, "Step 3: editor session ended");
editorVisible = editor.classList.contains("editing");
ok(!editorVisible, "editor popup hidden");
attrNameNodeHighlighted = attrNameNode_id.classList.contains("editingAttributeValue");
ok(!attrNameNodeHighlighted, "`id` attribute-value node is no longer editor-highlighted");
is(div.getAttribute("burp"), "foobar", "`id` attribute-name successfully updated");
is(attrNameNode_id.innerHTML, "burp", "attribute-name node in HTML panel successfully updated");
// double-click the `class` attribute-value node to open the editor
executeSoon(function() {
// firing 2 clicks right in a row to simulate a double-click
EventUtils.synthesizeMouse(attrNameNode_class, 2, 2, {clickCount: 2}, attrNameNode_class.ownerDocument.defaultView);
});
yield; // End of Step 3
// Step 4: enter value into editor, then hit <escape> to discard it
ok(treePanel.editingContext, "Step 4: editor session started");
editorVisible = editor.classList.contains("editing");
ok(editorVisible, "editor popup visible");
is(treePanel.editingContext.attrObj, attrNameNode_class, "editor session has correct reference to `class` attribute-name node in HTML panel");
is(treePanel.editingContext.attrName, "class", "editor session knows correct attribute-name");
editorInput.value = "Hello World";
editorInput.focus();
// hit <escape> to discard the inputted value
executeSoon(function() {
EventUtils.synthesizeKey("VK_ESCAPE", {}, attrNameNode_class.ownerDocument.defaultView);
});
yield; // End of Step 4
// Step 5: validate that the previous editing session discarded correctly, then open editor on `id` attribute value again
ok(!treePanel.editingContext, "Step 5: editor session ended");
editorVisible = editor.classList.contains("editing");
ok(!editorVisible, "editor popup hidden");
is(div.getAttribute("class"), "barbaz", "`class` attribute-name *not* updated");
is(attrNameNode_class.innerHTML, "class", "attribute-name node in HTML panel *not* updated");
// double-click the `id` attribute-name node to open the editor
executeSoon(function() {
// firing 2 clicks right in a row to simulate a double-click
EventUtils.synthesizeMouse(attrNameNode_id, 2, 2, {clickCount: 2}, attrNameNode_id.ownerDocument.defaultView);
});
yield; // End of Step 5
// Step 6: validate that editor opened again, then test double-click inside of editor (should do nothing)
ok(treePanel.editingContext, "Step 6: editor session started");
editorVisible = editor.classList.contains("editing");
ok(editorVisible, "editor popup visible");
// double-click on the editor input box
executeSoon(function() {
// firing 2 clicks right in a row to simulate a double-click
EventUtils.synthesizeMouse(editorInput, 2, 2, {clickCount: 2}, editorInput.ownerDocument.defaultView);
// since the previous double-click is supposed to do nothing,
// wait a brief moment, then move on to the next step
executeSoon(function() {
doNextStep();
});
});
yield; // End of Step 6
// Step 7: validate that editing session is still correct, then enter a value and try a click
// outside of editor (should cancel the editing session)
ok(treePanel.editingContext, "Step 7: editor session still going");
editorVisible = editor.classList.contains("editing");
ok(editorVisible, "editor popup still visible");
editorInput.value = "all your base are belong to us";
// single-click the `class` attribute-value node
executeSoon(function() {
EventUtils.synthesizeMouse(attrNameNode_class, 2, 2, {}, attrNameNode_class.ownerDocument.defaultView);
});
yield; // End of Step 7
// Step 8: validate that the editor was closed and that the editing was not saved
ok(!treePanel.editingContext, "Step 8: editor session ended");
editorVisible = editor.classList.contains("editing");
ok(!editorVisible, "editor popup hidden");
is(div.getAttribute("burp"), "foobar", "`id` attribute-name *not* updated");
is(attrNameNode_id.innerHTML, "burp", "attribute-value node in HTML panel *not* updated");
// End of Step 8
executeSoon(finishUp);
}
function finishUp() {
// end of all steps, so clean up
Services.obs.removeObserver(doNextStep, InspectorUI.INSPECTOR_NOTIFICATIONS.EDITOR_OPENED, false);
Services.obs.removeObserver(doNextStep, InspectorUI.INSPECTOR_NOTIFICATIONS.EDITOR_CLOSED, false);
Services.obs.removeObserver(doNextStep, InspectorUI.INSPECTOR_NOTIFICATIONS.EDITOR_SAVED, false);
doc = div = null;
InspectorUI.closeInspectorUI();
gBrowser.removeCurrentTab();
finish();
}
function test()
{
waitForExplicitFinish();
gBrowser.selectedTab = gBrowser.addTab();
gBrowser.selectedBrowser.addEventListener("load", function() {
gBrowser.selectedBrowser.removeEventListener("load", arguments.callee, true);
doc = content.document;
waitForFocus(setupEditorTests, content);
}, true);
content.location = "data:text/html,basic tests for html panel attribute-value editor";
}