7aedb8ed7a
Please note that this functionality has never really mattered for the Firefox PDF Viewer, the GENERIC viewer, or even the "simpleviewer"/"singlepageviewer" component-examples. Hence, in practice this means that only the "pageviewer" component-example[1] have ever really utilized this. Using factories to initialize various layers in the viewer, rather than simply invoking the relevant code directly, seems (at least to me) like a somewhat roundabout way of doing things. Not only does this lead to more code, both to write and maintain, but since many of the layers have common parameters (e.g. an `AnnotationStorage`-instance) there's also some duplication. Hence this patch, which removes the `annotationEditorLayerFactory` and instead uses a lookup-function in the `PDFPageView`-class to access the external viewer-properties as necessary. Note that this should even be an improvement for the "pageviewer" component-example, since most layers will now work by default rather than require manual configuration. --- [1] In practice we generally suggest using the "simpleviewer", or "singlepageviewer", since it does *most* things out-of-the-box and given that a lot of functionality really require *a viewer* and not just a single page in order to work.
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
|
|
const div = (this.div = document.createElement("div"));
|
|
div.className = "annotationEditorLayer";
|
|
div.tabIndex = 0;
|
|
this.pageDiv.append(div);
|
|
|
|
this.annotationEditorLayer = new AnnotationEditorLayer({
|
|
uiManager: this.#uiManager,
|
|
div,
|
|
accessibilityManager: this.accessibilityManager,
|
|
pageIndex: this.pdfPage.pageNumber - 1,
|
|
l10n: this.l10n,
|
|
viewport: clonedViewport,
|
|
});
|
|
|
|
const parameters = {
|
|
viewport: clonedViewport,
|
|
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 };
|