c6d400ed06
While e.g. the `simpleviewer` and `singlepageviewer` examples work, since they're based on the `BaseViewer`-class, the standalone `pageviewer` example currently doesn't support either XFA- or StructTree-layers. This seems like an obvious oversight, which can be easily addressed simply by exporting the necessary functionality through `pdf_viewer.component.js`, similar to the existing Text/Annotation-layers. While working on, and testing, these changes I happened to notice a number of smaller things that's also fixed in this patch: - Ensure that `XfaLayerBuilder.render` always have a *consistent* return type, to prevent possible run-time failures in `PDFPageView`; PR 13908 follow-up. - Change the order of the options in the `XfaLayerBuilder`-constructor to agree with the parameter order in the `DefaultXfaLayerFactory.createXfaLayerBuilder`-method. - Add a missing `textHighlighterFactory`-option, in the JSDocs for the `PDFPageView`-class. - A couple of small tweaks in the `TextLayerBuilder.render`-method: Re-use an existing Array rather than creating a new one, and replace an `if` with optional chaining instead. *Please note:* For now XFA-support is currently disabled by default, similar to the regular viewer.
138 lines
3.5 KiB
JavaScript
138 lines
3.5 KiB
JavaScript
/* Copyright 2021 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("./interfaces").IPDFXfaLayerFactory} IPDFXfaLayerFactory */
|
|
|
|
import { XfaLayer } from "pdfjs-lib";
|
|
|
|
/**
|
|
* @typedef {Object} XfaLayerBuilderOptions
|
|
* @property {HTMLDivElement} pageDiv
|
|
* @property {PDFPage} pdfPage
|
|
* @property {AnnotationStorage} [annotationStorage]
|
|
* @property {Object} [xfaHtml]
|
|
*/
|
|
|
|
class XfaLayerBuilder {
|
|
/**
|
|
* @param {XfaLayerBuilderOptions} options
|
|
*/
|
|
constructor({ pageDiv, pdfPage, annotationStorage, xfaHtml }) {
|
|
this.pageDiv = pageDiv;
|
|
this.pdfPage = pdfPage;
|
|
this.annotationStorage = annotationStorage;
|
|
this.xfaHtml = xfaHtml;
|
|
|
|
this.div = null;
|
|
this._cancelled = false;
|
|
}
|
|
|
|
/**
|
|
* @param {PageViewport} viewport
|
|
* @param {string} intent (default value is 'display')
|
|
* @returns {Promise<Object | void>} A promise that is resolved when rendering
|
|
* of the XFA layer is complete. The first rendering will return an object
|
|
* with a `textDivs` property that can be used with the TextHighlighter.
|
|
*/
|
|
render(viewport, intent = "display") {
|
|
if (intent === "print") {
|
|
const parameters = {
|
|
viewport: viewport.clone({ dontFlip: true }),
|
|
div: this.div,
|
|
xfa: this.xfaHtml,
|
|
page: null,
|
|
annotationStorage: this.annotationStorage,
|
|
intent,
|
|
};
|
|
|
|
// Create an xfa layer div and render the form
|
|
const div = document.createElement("div");
|
|
this.pageDiv.appendChild(div);
|
|
parameters.div = div;
|
|
|
|
const result = XfaLayer.render(parameters);
|
|
return Promise.resolve(result);
|
|
}
|
|
|
|
// intent === "display"
|
|
return this.pdfPage
|
|
.getXfa()
|
|
.then(xfa => {
|
|
if (this._cancelled || !xfa) {
|
|
return { textDivs: [] };
|
|
}
|
|
|
|
const parameters = {
|
|
viewport: viewport.clone({ dontFlip: true }),
|
|
div: this.div,
|
|
xfa,
|
|
page: this.pdfPage,
|
|
annotationStorage: this.annotationStorage,
|
|
intent,
|
|
};
|
|
|
|
if (this.div) {
|
|
return XfaLayer.update(parameters);
|
|
}
|
|
// Create an xfa layer div and render the form
|
|
this.div = document.createElement("div");
|
|
this.pageDiv.appendChild(this.div);
|
|
parameters.div = this.div;
|
|
return XfaLayer.render(parameters);
|
|
})
|
|
.catch(error => {
|
|
console.error(error);
|
|
});
|
|
}
|
|
|
|
cancel() {
|
|
this._cancelled = true;
|
|
}
|
|
|
|
hide() {
|
|
if (!this.div) {
|
|
return;
|
|
}
|
|
this.div.hidden = true;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @implements IPDFXfaLayerFactory
|
|
*/
|
|
class DefaultXfaLayerFactory {
|
|
/**
|
|
* @param {HTMLDivElement} pageDiv
|
|
* @param {PDFPage} pdfPage
|
|
* @param {AnnotationStorage} [annotationStorage]
|
|
* @param {Object} [xfaHtml]
|
|
*/
|
|
createXfaLayerBuilder(
|
|
pageDiv,
|
|
pdfPage,
|
|
annotationStorage = null,
|
|
xfaHtml = null
|
|
) {
|
|
return new XfaLayerBuilder({
|
|
pageDiv,
|
|
pdfPage,
|
|
annotationStorage,
|
|
xfaHtml,
|
|
});
|
|
}
|
|
}
|
|
|
|
export { DefaultXfaLayerFactory, XfaLayerBuilder };
|