Add Overlay Views to PDF in Swift for iOS

1
//
2
//  Copyright © 2021-2025 PSPDFKit GmbH. All rights reserved.
3
//
4
//  The Nutrient sample applications are licensed with a modified BSD license.
5
//  Please see License for details. This notice may not be removed from this file.
6
//
7

8
import PSPDFKit
9
import PSPDFKitUI
10

11
class OverlayViewsExample: Example, PDFViewControllerDelegate {
12

13
    override init() {
14
        super.init()
15
        title = "Adding Overlay Views"
16
        contentDescription = "Shows how to add custom overlay views on top of pages."
17
        category = .controllerCustomization
18
        priority = 40
19
    }
20

21
    override func invoke(with delegate: ExampleRunnerDelegate) -> UIViewController? {
22
        PDFViewController(document: AssetLoader.document(for: .annualReport), delegate: self) { builder in
23
            builder.maximumZoomScale = 20
24
        }
25
    }
26

27
    func pdfViewController(_ pdfController: PDFViewController, didConfigurePageView pageView: PDFPageView, forPageAt pageIndex: Int) {
28
        // This is the size pf page and overlay in PDF coordinate space.
29
        // See: https://www.nutrient.io/guides/ios/faq/coordinate-spaces/
30
        guard let pageSize = pageView.pageInfo?.size else { return }
31
        let overlaySize = CGSize(width: 30, height: 30)
32
        // Add 4 custom views at the 4 corners of the first page. Nutrient will
33
        // reuse the page view but in doing so it will clear all foreign views,
34
        // so you don't have to remove them yourself.
35
        guard pageView.pageIndex == 0 else { return }
36
        // Top-left is actually "bottom-left" in PDF coordinates.
37
        let topLeftBoundingBox = CGRect(x: 0, y: pageSize.height - overlaySize.height, width: overlaySize.width, height: overlaySize.height)
38
        let topLeftView = OverlayView(on: pageView, boundingBox: topLeftBoundingBox, color: .yellow)
39
        pageView.annotationContainerView.addSubview(topLeftView)
40
        // Top-right is actually "bottom-right" in PDF coordinates.
41
        let topRightBoundingBox = CGRect(x: pageSize.width - overlaySize.width, y: pageSize.height - overlaySize.height, width: overlaySize.width, height: overlaySize.height)
42
        let topRightView = OverlayView(on: pageView, boundingBox: topRightBoundingBox, color: .red)
43
        pageView.annotationContainerView.addSubview(topRightView)
44
        // Bottom-right is actually "top-right" in PDF coordinates.
45
        let bottomRightBoundingBox = CGRect(x: pageSize.width - overlaySize.width, y: 0, width: overlaySize.width, height: overlaySize.height)
46
        let bottomRightView = OverlayView(on: pageView, boundingBox: bottomRightBoundingBox, color: .green)
47
        pageView.annotationContainerView.addSubview(bottomRightView)
48
        // Bottom-left is actually "top-left" in PDF coordinates.
49
        let bottomLeftBoundingBox = CGRect(origin: .zero, size: overlaySize)
50
        let bottomLeftView = OverlayView(on: pageView, boundingBox: bottomLeftBoundingBox, color: .blue)
51
        pageView.annotationContainerView.addSubview(bottomLeftView)
52
    }
53

54
}
55

56
private class OverlayView: UIView, AnnotationPresenting {
57

58
    init(on pageView: PDFPageView, boundingBox: CGRect, color backgroundColor: UIColor) {
59
        self.pageView = pageView
60
        self.boundingBox = boundingBox
61
        super.init(frame: .zero)
62
        self.backgroundColor = backgroundColor
63
    }
64

65
    required init?(coder: NSCoder) {
66
        fatalError("init(coder:) has not been implemented")
67
    }
68

69
    weak var pageView: PDFPageView?
70
    private let boundingBox: CGRect
71

72
    override func didMoveToSuperview() {
73
        super.didMoveToSuperview()
74
        // Update the frame when this view is first added to the hierarchy.
75
        updateFrameBasedOnBoundingBox()
76
    }
77

78
    func didChangePageBounds(_ bounds: CGRect) {
79
        // Update the frame once the page rotates.
80
        updateFrameBasedOnBoundingBox()
81
    }
82

83
    private func updateFrameBasedOnBoundingBox() {
84
        guard let pageView, let superview else { return }
85
        frame = superview.convert(boundingBox, from: pageView.pdfCoordinateSpace)
86
    }
87

88
}