ca69da735e
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 `annotationLayerFactory` 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.
108 lines
3.4 KiB
JavaScript
108 lines
3.4 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.
|
|
*/
|
|
|
|
/** @typedef {import("../src/display/api").PDFPageProxy} PDFPageProxy */
|
|
// eslint-disable-next-line max-len
|
|
/** @typedef {import("../src/display/display_utils").PageViewport} PageViewport */
|
|
/** @typedef {import("./event_utils").EventBus} EventBus */
|
|
/** @typedef {import("./interfaces").IDownloadManager} IDownloadManager */
|
|
/** @typedef {import("./interfaces").IL10n} IL10n */
|
|
/** @typedef {import("./interfaces").IPDFLinkService} IPDFLinkService */
|
|
// eslint-disable-next-line max-len
|
|
/** @typedef {import("./interfaces").IPDFStructTreeLayerFactory} IPDFStructTreeLayerFactory */
|
|
// eslint-disable-next-line max-len
|
|
/** @typedef {import("./interfaces").IPDFTextLayerFactory} IPDFTextLayerFactory */
|
|
/** @typedef {import("./interfaces").IPDFXfaLayerFactory} IPDFXfaLayerFactory */
|
|
/** @typedef {import("./text_highlighter").TextHighlighter} TextHighlighter */
|
|
// eslint-disable-next-line max-len
|
|
/** @typedef {import("./text_accessibility.js").TextAccessibilityManager} TextAccessibilityManager */
|
|
|
|
import { SimpleLinkService } from "./pdf_link_service.js";
|
|
import { StructTreeLayerBuilder } from "./struct_tree_layer_builder.js";
|
|
import { TextLayerBuilder } from "./text_layer_builder.js";
|
|
import { XfaLayerBuilder } from "./xfa_layer_builder.js";
|
|
|
|
/**
|
|
* @implements IPDFStructTreeLayerFactory
|
|
*/
|
|
class DefaultStructTreeLayerFactory {
|
|
/**
|
|
* @returns {StructTreeLayerBuilder}
|
|
*/
|
|
createStructTreeLayerBuilder() {
|
|
return new StructTreeLayerBuilder();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @implements IPDFTextLayerFactory
|
|
*/
|
|
class DefaultTextLayerFactory {
|
|
/**
|
|
* @typedef {Object} CreateTextLayerBuilderParameters
|
|
* @property {TextHighlighter} highlighter
|
|
* @property {TextAccessibilityManager} [accessibilityManager]
|
|
* @property {boolean} [isOffscreenCanvasSupported]
|
|
*/
|
|
|
|
/**
|
|
* @param {CreateTextLayerBuilderParameters}
|
|
* @returns {TextLayerBuilder}
|
|
*/
|
|
createTextLayerBuilder({
|
|
highlighter,
|
|
accessibilityManager = null,
|
|
isOffscreenCanvasSupported = true,
|
|
}) {
|
|
return new TextLayerBuilder({
|
|
highlighter,
|
|
accessibilityManager,
|
|
isOffscreenCanvasSupported,
|
|
});
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @implements IPDFXfaLayerFactory
|
|
*/
|
|
class DefaultXfaLayerFactory {
|
|
/**
|
|
* @typedef {Object} CreateXfaLayerBuilderParameters
|
|
* @property {HTMLDivElement} pageDiv
|
|
* @property {PDFPageProxy} pdfPage
|
|
* @property {AnnotationStorage} [annotationStorage] - Storage for annotation
|
|
* data in forms.
|
|
*/
|
|
|
|
/**
|
|
* @param {CreateXfaLayerBuilderParameters}
|
|
* @returns {XfaLayerBuilder}
|
|
*/
|
|
createXfaLayerBuilder({ pageDiv, pdfPage, annotationStorage = null }) {
|
|
return new XfaLayerBuilder({
|
|
pageDiv,
|
|
pdfPage,
|
|
annotationStorage,
|
|
linkService: new SimpleLinkService(),
|
|
});
|
|
}
|
|
}
|
|
|
|
export {
|
|
DefaultStructTreeLayerFactory,
|
|
DefaultTextLayerFactory,
|
|
DefaultXfaLayerFactory,
|
|
};
|