xref: /aosp_15_r20/development/tools/winscope/src/viewers/common/abstract_viewer_input_method.ts (revision 90c8c64db3049935a07c6143d7fd006e26f8ecca)
1/*
2 * Copyright (C) 2022 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17import {Store} from 'common/store';
18import {WinscopeEvent} from 'messaging/winscope_event';
19import {Trace} from 'trace/trace';
20import {Traces} from 'trace/traces';
21import {TRACE_INFO} from 'trace/trace_info';
22import {HierarchyTreeNode} from 'trace/tree_node/hierarchy_tree_node';
23import {AbstractPresenterInputMethod} from 'viewers/common/abstract_presenter_input_method';
24import {ImeUiData} from 'viewers/common/ime_ui_data';
25import {ViewerEvents} from 'viewers/common/viewer_events';
26import {View, Viewer, ViewType} from 'viewers/viewer';
27
28export abstract class AbstractViewerInputMethod implements Viewer {
29  private readonly trace: Trace<HierarchyTreeNode>;
30  protected readonly htmlElement: HTMLElement;
31  protected readonly presenter: AbstractPresenterInputMethod;
32  protected readonly view: View;
33
34  protected imeUiCallback = (uiData: ImeUiData) => {
35    (this.htmlElement as any).inputData = uiData;
36  };
37
38  constructor(trace: Trace<HierarchyTreeNode>, traces: Traces, storage: Store) {
39    this.trace = trace;
40    this.htmlElement = document.createElement('viewer-input-method');
41    this.presenter = this.initializePresenter(trace, traces, storage);
42    this.addViewerEventListeners();
43    this.view = new View(
44      ViewType.TRACE_TAB,
45      this.getTraces(),
46      this.htmlElement,
47      TRACE_INFO[trace.type].name,
48    );
49  }
50
51  async onWinscopeEvent(event: WinscopeEvent) {
52    await this.presenter.onAppEvent(event);
53  }
54
55  setEmitEvent() {
56    // do nothing
57  }
58
59  getViews(): View[] {
60    return [this.view];
61  }
62
63  getTraces(): Array<Trace<HierarchyTreeNode>> {
64    return [this.trace];
65  }
66
67  protected addViewerEventListeners() {
68    this.presenter.addEventListeners(this.htmlElement);
69    this.htmlElement.addEventListener(
70      ViewerEvents.AdditionalPropertySelected,
71      async (event) =>
72        await this.presenter.onAdditionalPropertySelected(
73          (event as CustomEvent).detail.selectedItem,
74        ),
75    );
76  }
77
78  protected abstract initializePresenter(
79    trace: Trace<HierarchyTreeNode>,
80    traces: Traces,
81    storage: Store,
82  ): AbstractPresenterInputMethod;
83}
84