Show Author Name on Annotation Selection in Swift for iOS

1
//
2
//  Copyright © 2020-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
/// Example that adds a custom overlaying view to the `PDFPageView` when a user selects an annotation.
12
class ShowAuthorNameOnAnnotationSelectionExample: Example {
13

14
    override init() {
15
        super.init()
16

17
        title = "Show Author Name On Annotation Selection"
18
        category = .viewCustomization
19
    }
20

21
    override func invoke(with delegate: ExampleRunnerDelegate) -> UIViewController {
22
        let document = AssetLoader.writableDocument(for: .welcome, overrideIfExists: false)
23

24
        let controller = CustomOverlayingViewViewController(document: document)
25

26
        // Add annotation interaction hooks to display author name.
27
        controller.addAnnotationInteractionActions()
28

29
        // Show a page with annotations.
30
        controller.pageIndex = 15
31

32
        return controller
33
    }
34
}
35

36
/// `PDFViewController` subclass that can add actions to be executed on a user interaction with annotations.
37
private class CustomOverlayingViewViewController: PDFViewController {
38

39
    /// Currently visible overlaying view.
40
    var displayingCustomOverlayView: CustomOverlayLabelView?
41

42
    /// Adds the actions to be executed whenever the user selects or de-selects an annotation.
43
    func addAnnotationInteractionActions() {
44
        // `selectAnnotation.addActivationCallback` code block is called whenever a user selects an annotation.
45
        self.interactions.selectAnnotation.addActivationCallback { context, _, _  in
46
            // Use the provided context to get the page and annotation about to be selected.
47
            let selectedAnnotation = context.annotation
48
            let authorName = selectedAnnotation.user ?? "Unknown Author"
49
            let pageView = context.pageView
50

51
            // `boundingBox` is in the page coordinates that is in the PDF coordinate space which means
52
            // origin is at the bottom left.
53
            // For more info: https://www.nutrient.io/guides/ios/faq/coordinate-spaces/
54
            let selectedAnnotationBoundingBox = selectedAnnotation.boundingBox
55
            // We anchor the custom overlay view at the centre of the annotation.
56
            let viewSize: CGFloat = 40
57
            let authorViewRect = CGRect(x: selectedAnnotationBoundingBox.midX - (viewSize / 2), y: selectedAnnotationBoundingBox.midY - (viewSize / 2), width: viewSize, height: viewSize)
58
            let authorView = CustomOverlayLabelView(authorName: authorName, pageView: pageView, pdfRect: authorViewRect)
59

60
            // Add the custom overlay view to the page view.
61
            pageView.addSubview(authorView)
62

63
            // Remove the existing author view in case the current annotation is selected without
64
            // de-selecting the earlier annotation
65
            self.displayingCustomOverlayView?.removeFromSuperview()
66

67
            // Store a reference to the author view to remove it from the view when an annotation is
68
            // deselected.
69
            self.displayingCustomOverlayView = authorView
70
        }
71

72
        // `deselectAnnotation.addActivationCallback` code block is called whenever a user de-selects an annotation.
73
        self.interactions.deselectAnnotation.addActivationCallback { _, _, _ in
74
            // Remove the view as the annotation is no longer in selection.
75
            self.displayingCustomOverlayView?.removeFromSuperview()
76
        }
77
    }
78
}
79

80
/// A view containing a `UILabel` that can be added to a `PDFPageView`.
81
private class CustomOverlayLabelView: UIView {
82

83
    let pdfRect: CGRect
84
    weak var pageView: PDFPageView?
85

86
    let authorLabel: UILabel = {
87
        let label = UILabel()
88
        label.translatesAutoresizingMaskIntoConstraints = false
89
        return label
90
    }()
91

92
    /// Creates and returns a view that contains a label that can be added to a `PDFPageView`.
93
    /// - Parameters:
94
    ///   - authorName: Text to be displayed in the contained label.
95
    ///   - pageView: Page view to which this view is added.
96
    ///   - pdfRect: `CGRect` in PDF Page coordinates where the custom view is supposed to be placed.
97
    ///   Will be converted to the `pageView`'s coordinate space before using it as the `frame`.
98
    init(authorName: String, pageView: PDFPageView, pdfRect: CGRect) {
99
        self.pageView = pageView
100
        self.pdfRect = pdfRect
101

102
        // Convert the rect from PDF Page Coordinates to PageView coordinates.
103
        let viewRect = pageView.convert(pdfRect, from: pageView.pdfCoordinateSpace)
104
        super.init(frame: viewRect)
105

106
        addSubview(authorLabel)
107
        NSLayoutConstraint.activate([
108
            authorLabel.centerXAnchor.constraint(equalTo: centerXAnchor),
109
            authorLabel.centerYAnchor.constraint(equalTo: centerYAnchor)
110
        ])
111
        authorLabel.text = authorName
112

113
        // Use black text color here because the page background is light
114
        // and to ensure the text visibility in both light and dark mode.
115
        authorLabel.textColor = .black
116
    }
117

118
    required init?(coder: NSCoder) {
119
        fatalError("init(coder:) has not been implemented")
120
    }
121

122
}