Files
react-native-devtools-frontend/front_end/elements/ElementsTreeElementHighlighter.js
T
Changhao Han 95949e4c8a Refactor away ad hoc treeElementSymbol field in DOMNode
Previously, several classes in the elements module set and access
an ad hoc field named `Symbol("treeElement")` on DOMNode. This is
dynamic and not part of DOMNode, and prevents proper typing. This CL
removes this behavior and make this DOMNode->TreeElement relationship
the responsibility of the ElementsTreeOutline, refactoring it away
from DOMNode.

Backend CL to temporarily disable tests: https://crrev.com/c/2439071

Change-Id: I3b3dcc9c3333bea1631fb9a781a39b7d48e9bbb7
Reviewed-on: https://chromium-review.googlesource.com/c/devtools/devtools-frontend/+/2438385
Reviewed-by: Mathias Bynens <mathias@chromium.org>
Reviewed-by: Alex Rudenko <alexrudenko@chromium.org>
Commit-Queue: Changhao Han <changhaohan@chromium.org>
Auto-Submit: Changhao Han <changhaohan@chromium.org>
2020-10-01 06:56:37 +00:00

110 lines
3.6 KiB
JavaScript

// Copyright (c) 2015 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
// @ts-nocheck
// TODO(crbug.com/1011811): Enable TypeScript compiler checks
import * as Common from '../common/common.js';
import * as SDK from '../sdk/sdk.js';
import * as UI from '../ui/ui.js';
import {ElementsTreeOutline} from './ElementsTreeOutline.js';
/**
* @unrestricted
*/
export class ElementsTreeElementHighlighter {
/**
* @param {!ElementsTreeOutline} treeOutline
*/
constructor(treeOutline) {
this._throttler = new Common.Throttler.Throttler(100);
this._treeOutline = treeOutline;
this._treeOutline.addEventListener(UI.TreeOutline.Events.ElementExpanded, this._clearState, this);
this._treeOutline.addEventListener(UI.TreeOutline.Events.ElementCollapsed, this._clearState, this);
this._treeOutline.addEventListener(ElementsTreeOutline.Events.SelectedNodeChanged, this._clearState, this);
SDK.SDKModel.TargetManager.instance().addModelListener(
SDK.OverlayModel.OverlayModel, SDK.OverlayModel.Events.HighlightNodeRequested, this._highlightNode, this);
SDK.SDKModel.TargetManager.instance().addModelListener(
SDK.OverlayModel.OverlayModel, SDK.OverlayModel.Events.InspectModeWillBeToggled, this._clearState, this);
}
/**
* @param {!Common.EventTarget.EventTargetEvent} event
*/
_highlightNode(event) {
if (!Common.Settings.Settings.instance().moduleSetting('highlightNodeOnHoverInOverlay').get()) {
return;
}
const domNode = /** @type {!SDK.DOMModel.DOMNode} */ (event.data);
this._throttler.schedule(callback.bind(this));
this._pendingHighlightNode =
this._treeOutline === ElementsTreeOutline.forDOMModel(domNode.domModel()) ? domNode : null;
/**
* @this {ElementsTreeElementHighlighter}
*/
function callback() {
this._highlightNodeInternal(this._pendingHighlightNode);
delete this._pendingHighlightNode;
return Promise.resolve();
}
}
/**
* @param {?SDK.DOMModel.DOMNode} node
*/
_highlightNodeInternal(node) {
this._isModifyingTreeOutline = true;
let treeElement = null;
if (this._currentHighlightedElement) {
let currentTreeElement = this._currentHighlightedElement;
while (currentTreeElement !== this._alreadyExpandedParentElement) {
if (currentTreeElement.expanded) {
currentTreeElement.collapse();
}
currentTreeElement = currentTreeElement.parent;
}
}
delete this._currentHighlightedElement;
delete this._alreadyExpandedParentElement;
if (node) {
let deepestExpandedParent = node;
const treeElementByNode = this._treeOutline.treeElementByNode;
while (
deepestExpandedParent &&
(!treeElementByNode.has(deepestExpandedParent) || !treeElementByNode.get(deepestExpandedParent).expanded)) {
deepestExpandedParent = deepestExpandedParent.parentNode;
}
this._alreadyExpandedParentElement =
deepestExpandedParent ? treeElementByNode.get(deepestExpandedParent) : this._treeOutline.rootElement();
treeElement = this._treeOutline.createTreeElementFor(node);
}
this._currentHighlightedElement = treeElement;
this._treeOutline.setHoverEffect(treeElement);
if (treeElement) {
treeElement.reveal(true);
}
this._isModifyingTreeOutline = false;
}
_clearState() {
if (this._isModifyingTreeOutline) {
return;
}
delete this._currentHighlightedElement;
delete this._alreadyExpandedParentElement;
delete this._pendingHighlightNode;
}
}