bed1a1baa1
It doesn't seem necessary to have a *separate* `destroy` method given that the `cancel` method always invokes it unconditionally.
In the `PDFPageView.reset` method we currently attempt to call `destroy` directly, however that'll never actually happen since either:
- We're keeping the annotationEditorLayer, in which case we're just hiding the layer and nothing more (and the relevant branch is never entered).
- We're removing the annotationEditorLayer, in which case the `PDFPageView.cancelRendering` method has already cancelled *and* nulled it (and there's thus nothing left to `destroy` here).
*Please note:* Hopefully I'm not overlooking something obvious here, since both reading through the code *and* also adding `console.log(this.annotationEditorLayer);` [before this line](9d4aadbf7a/web/pdf_page_view.js (L438)) suggests that it's indeed unnecessary.
126 lines
3.4 KiB
JavaScript
126 lines
3.4 KiB
JavaScript
/* Copyright 2022 Mozilla Foundation
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
/** @typedef {import("../src/display/api").PDFPageProxy} PDFPageProxy */
|
|
// eslint-disable-next-line max-len
|
|
/** @typedef {import("../src/display/display_utils").PageViewport} PageViewport */
|
|
// eslint-disable-next-line max-len
|
|
/** @typedef {import("../src/display/editor/tools.js").AnnotationEditorUIManager} AnnotationEditorUIManager */
|
|
// eslint-disable-next-line max-len
|
|
/** @typedef {import("./text_accessibility.js").TextAccessibilityManager} TextAccessibilityManager */
|
|
/** @typedef {import("./interfaces").IL10n} IL10n */
|
|
|
|
import { AnnotationEditorLayer } from "pdfjs-lib";
|
|
import { NullL10n } from "./l10n_utils.js";
|
|
|
|
/**
|
|
* @typedef {Object} AnnotationEditorLayerBuilderOptions
|
|
* @property {AnnotationEditorUIManager} [uiManager]
|
|
* @property {HTMLDivElement} pageDiv
|
|
* @property {PDFPageProxy} pdfPage
|
|
* @property {IL10n} l10n
|
|
* @property {TextAccessibilityManager} [accessibilityManager]
|
|
*/
|
|
|
|
class AnnotationEditorLayerBuilder {
|
|
#uiManager;
|
|
|
|
/**
|
|
* @param {AnnotationEditorLayerBuilderOptions} options
|
|
*/
|
|
constructor(options) {
|
|
this.pageDiv = options.pageDiv;
|
|
this.pdfPage = options.pdfPage;
|
|
this.accessibilityManager = options.accessibilityManager;
|
|
this.l10n = options.l10n || NullL10n;
|
|
this.annotationEditorLayer = null;
|
|
this.div = null;
|
|
this._cancelled = false;
|
|
this.#uiManager = options.uiManager;
|
|
}
|
|
|
|
/**
|
|
* @param {PageViewport} viewport
|
|
* @param {string} intent (default value is 'display')
|
|
*/
|
|
async render(viewport, intent = "display") {
|
|
if (intent !== "display") {
|
|
return;
|
|
}
|
|
|
|
if (this._cancelled) {
|
|
return;
|
|
}
|
|
|
|
const clonedViewport = viewport.clone({ dontFlip: true });
|
|
if (this.div) {
|
|
this.annotationEditorLayer.update({ viewport: clonedViewport });
|
|
this.show();
|
|
return;
|
|
}
|
|
|
|
// Create an AnnotationEditor layer div
|
|
this.div = document.createElement("div");
|
|
this.div.className = "annotationEditorLayer";
|
|
this.div.tabIndex = 0;
|
|
this.pageDiv.append(this.div);
|
|
|
|
this.annotationEditorLayer = new AnnotationEditorLayer({
|
|
uiManager: this.#uiManager,
|
|
div: this.div,
|
|
accessibilityManager: this.accessibilityManager,
|
|
pageIndex: this.pdfPage.pageNumber - 1,
|
|
l10n: this.l10n,
|
|
viewport: clonedViewport,
|
|
});
|
|
|
|
const parameters = {
|
|
viewport: clonedViewport,
|
|
div: this.div,
|
|
annotations: null,
|
|
intent,
|
|
};
|
|
|
|
this.annotationEditorLayer.render(parameters);
|
|
}
|
|
|
|
cancel() {
|
|
this._cancelled = true;
|
|
|
|
if (!this.div) {
|
|
return;
|
|
}
|
|
this.pageDiv = null;
|
|
this.annotationEditorLayer.destroy();
|
|
this.div.remove();
|
|
}
|
|
|
|
hide() {
|
|
if (!this.div) {
|
|
return;
|
|
}
|
|
this.div.hidden = true;
|
|
}
|
|
|
|
show() {
|
|
if (!this.div) {
|
|
return;
|
|
}
|
|
this.div.hidden = false;
|
|
}
|
|
}
|
|
|
|
export { AnnotationEditorLayerBuilder };
|