de36b2aaba
Note that Prettier, purposely, has only limited [configuration options](https://prettier.io/docs/en/options.html). The configuration file is based on [the one in `mozilla central`](https://searchfox.org/mozilla-central/source/.prettierrc) with just a few additions (to avoid future breakage if the defaults ever changes). Prettier is being used for a couple of reasons: - To be consistent with `mozilla-central`, where Prettier is already in use across the tree. - To ensure a *consistent* coding style everywhere, which is automatically enforced during linting (since Prettier is used as an ESLint plugin). This thus ends "all" formatting disussions once and for all, removing the need for review comments on most stylistic matters. Many ESLint options are now redundant, and I've tried my best to remove all the now unnecessary options (but I may have missed some). Note also that since Prettier considers the `printWidth` option as a guide, rather than a hard rule, this patch resorts to a small hack in the ESLint config to ensure that *comments* won't become too long. *Please note:* This patch is generated automatically, by appending the `--fix` argument to the ESLint call used in the `gulp lint` task. It will thus require some additional clean-up, which will be done in a *separate* commit. (On a more personal note, I'll readily admit that some of the changes Prettier makes are *extremely* ugly. However, in the name of consistency we'll probably have to live with that.)
143 lines
3.9 KiB
JavaScript
143 lines
3.9 KiB
JavaScript
/* Copyright 2014 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.
|
|
*/
|
|
|
|
import { AnnotationLayer } from "pdfjs-lib";
|
|
import { NullL10n } from "./ui_utils";
|
|
import { SimpleLinkService } from "./pdf_link_service";
|
|
|
|
/**
|
|
* @typedef {Object} AnnotationLayerBuilderOptions
|
|
* @property {HTMLDivElement} pageDiv
|
|
* @property {PDFPage} pdfPage
|
|
* @property {string} [imageResourcesPath] - Path for image resources, mainly
|
|
* for annotation icons. Include trailing slash.
|
|
* @property {boolean} renderInteractiveForms
|
|
* @property {IPDFLinkService} linkService
|
|
* @property {DownloadManager} downloadManager
|
|
* @property {IL10n} l10n - Localization service.
|
|
*/
|
|
|
|
class AnnotationLayerBuilder {
|
|
/**
|
|
* @param {AnnotationLayerBuilderOptions} options
|
|
*/
|
|
constructor({
|
|
pageDiv,
|
|
pdfPage,
|
|
linkService,
|
|
downloadManager,
|
|
imageResourcesPath = "",
|
|
renderInteractiveForms = false,
|
|
l10n = NullL10n,
|
|
}) {
|
|
this.pageDiv = pageDiv;
|
|
this.pdfPage = pdfPage;
|
|
this.linkService = linkService;
|
|
this.downloadManager = downloadManager;
|
|
this.imageResourcesPath = imageResourcesPath;
|
|
this.renderInteractiveForms = renderInteractiveForms;
|
|
this.l10n = l10n;
|
|
|
|
this.div = null;
|
|
this._cancelled = false;
|
|
}
|
|
|
|
/**
|
|
* @param {PageViewport} viewport
|
|
* @param {string} intent (default value is 'display')
|
|
*/
|
|
render(viewport, intent = "display") {
|
|
this.pdfPage.getAnnotations({ intent }).then(annotations => {
|
|
if (this._cancelled) {
|
|
return;
|
|
}
|
|
|
|
let parameters = {
|
|
viewport: viewport.clone({ dontFlip: true }),
|
|
div: this.div,
|
|
annotations,
|
|
page: this.pdfPage,
|
|
imageResourcesPath: this.imageResourcesPath,
|
|
renderInteractiveForms: this.renderInteractiveForms,
|
|
linkService: this.linkService,
|
|
downloadManager: this.downloadManager,
|
|
};
|
|
|
|
if (this.div) {
|
|
// If an annotationLayer already exists, refresh its children's
|
|
// transformation matrices.
|
|
AnnotationLayer.update(parameters);
|
|
} else {
|
|
// Create an annotation layer div and render the annotations
|
|
// if there is at least one annotation.
|
|
if (annotations.length === 0) {
|
|
return;
|
|
}
|
|
this.div = document.createElement("div");
|
|
this.div.className = "annotationLayer";
|
|
this.pageDiv.appendChild(this.div);
|
|
parameters.div = this.div;
|
|
|
|
AnnotationLayer.render(parameters);
|
|
this.l10n.translate(this.div);
|
|
}
|
|
});
|
|
}
|
|
|
|
cancel() {
|
|
this._cancelled = true;
|
|
}
|
|
|
|
hide() {
|
|
if (!this.div) {
|
|
return;
|
|
}
|
|
this.div.setAttribute("hidden", "true");
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @implements IPDFAnnotationLayerFactory
|
|
*/
|
|
class DefaultAnnotationLayerFactory {
|
|
/**
|
|
* @param {HTMLDivElement} pageDiv
|
|
* @param {PDFPage} pdfPage
|
|
* @param {string} [imageResourcesPath] - Path for image resources, mainly
|
|
* for annotation icons. Include trailing slash.
|
|
* @param {boolean} renderInteractiveForms
|
|
* @param {IL10n} l10n
|
|
* @returns {AnnotationLayerBuilder}
|
|
*/
|
|
createAnnotationLayerBuilder(
|
|
pageDiv,
|
|
pdfPage,
|
|
imageResourcesPath = "",
|
|
renderInteractiveForms = false,
|
|
l10n = NullL10n
|
|
) {
|
|
return new AnnotationLayerBuilder({
|
|
pageDiv,
|
|
pdfPage,
|
|
imageResourcesPath,
|
|
renderInteractiveForms,
|
|
linkService: new SimpleLinkService(),
|
|
l10n,
|
|
});
|
|
}
|
|
}
|
|
|
|
export { AnnotationLayerBuilder, DefaultAnnotationLayerFactory };
|