Export the XFA/StructTree-layers in the viewer components

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.
This commit is contained in:
Jonas Jenwald 2021-08-28 18:09:39 +02:00
parent 153d058b3a
commit c6d400ed06
6 changed files with 29 additions and 17 deletions

View file

@ -21,19 +21,19 @@ import { XfaLayer } from "pdfjs-lib";
* @typedef {Object} XfaLayerBuilderOptions
* @property {HTMLDivElement} pageDiv
* @property {PDFPage} pdfPage
* @property {Object} [xfaHtml]
* @property {AnnotationStorage} [annotationStorage]
* @property {Object} [xfaHtml]
*/
class XfaLayerBuilder {
/**
* @param {XfaLayerBuilderOptions} options
*/
constructor({ pageDiv, pdfPage, xfaHtml, annotationStorage }) {
constructor({ pageDiv, pdfPage, annotationStorage, xfaHtml }) {
this.pageDiv = pageDiv;
this.pdfPage = pdfPage;
this.xfaHtml = xfaHtml;
this.annotationStorage = annotationStorage;
this.xfaHtml = xfaHtml;
this.div = null;
this._cancelled = false;
@ -62,17 +62,18 @@ class XfaLayerBuilder {
this.pageDiv.appendChild(div);
parameters.div = div;
XfaLayer.render(parameters);
return Promise.resolve();
const result = XfaLayer.render(parameters);
return Promise.resolve(result);
}
// intent === "display"
return this.pdfPage
.getXfa()
.then(xfa => {
if (this._cancelled) {
return Promise.resolve();
if (this._cancelled || !xfa) {
return { textDivs: [] };
}
const parameters = {
viewport: viewport.clone({ dontFlip: true }),
div: this.div,