Configure PDF Annotation Toolbar using Swift for iOS

1
//
2
//  Copyright © 2017-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 ManualToolbarSetupExample: Example {
12

13
    override init() {
14
        super.init()
15
        title = "Manual annotation toolbar setup and management"
16
        contentDescription = "Flexible toolbar handling without UINavigationController or PSPDFAnnotationBarButtonItem."
17
        category = .barButtons
18
        priority = 220
19
    }
20

21
    override func invoke(with delegate: ExampleRunnerDelegate) -> UIViewController? {
22
        let document = AssetLoader.document(for: .annualReport)
23
        let controller = ManualToolbarSetupViewController(document: document)
24
        delegate.currentViewController?.present(controller, animated: true)
25
        // Present modally, so we can more easily configure it to have a different style.
26
        return nil
27
    }
28
}
29

30
private class ManualToolbarSetupViewController: UIViewController, UIToolbarDelegate, FlexibleToolbarContainerDelegate {
31

32
    private let pdfController: PDFViewController
33
    private lazy var customToolbar = UIToolbar(frame: CGRect(x: 0, y: 20, width: view.bounds.width, height: 44))
34
    private var flexibleToolbarContainer: FlexibleToolbarContainer?
35

36
    // MARK: Lifecycle
37

38
    init(document: Document) {
39
        // Add PDFViewController as a child view controller.
40
        pdfController = PDFViewController(document: document) {
41
            $0.userInterfaceViewMode = .never
42
            $0.backgroundColor = UIColor.psc_systemBackground
43
        }
44

45
        // Those need to be nilled out if you use the barButton items (e.g., annotationButtonItem) externally!
46
        pdfController.navigationItem.leftBarButtonItems = nil
47
        pdfController.navigationItem.rightBarButtonItems = nil
48

49
        super.init(nibName: nil, bundle: nil)
50

51
        addChild(pdfController)
52
        pdfController.didMove(toParent: self)
53
    }
54

55
    required init?(coder aDecoder: NSCoder) {
56
        fatalError("init(coder:) has not been implemented")
57
    }
58

59
    // MARK: UIViewController
60

61
    override func viewDidLoad() {
62
        super.viewDidLoad()
63
        view.backgroundColor = UIColor.psc_systemBackground
64

65
        view.addSubview(pdfController.view)
66

67
        // As an example, here we're not using the UINavigationController but instead a custom UIToolbar.
68
        // Note that if you're going that way, you'll lose some features that Nutrient provides, like dynamic toolbar updating or accessibility.
69
        customToolbar.delegate = self
70
        customToolbar.autoresizingMask = .flexibleWidth
71

72
        // Configure the toolbar items
73
        var toolbarItems = [UIBarButtonItem]()
74
        customToolbar.isTranslucent = false
75
        toolbarItems.append(contentsOf: [UIBarButtonItem(barButtonSystemItem: .done, target: self, action: #selector(doneButtonPressed)), UIBarButtonItem(barButtonSystemItem: .flexibleSpace, target: nil, action: nil)])
76

77
        // Normally we would just use the annotationButtonItem and let it do all the toolbar setup and management for us.
78
        // Here, however we'll show how one could manually configure and show the annotation toolbar without using
79
        // PSPDFAnnotationBarButtonItem. Note that PSPDFAnnotationBarButtonItem handles quite a few more
80
        // cases and should in general be preferred to this simple toolbar setup.
81

82
        // It's still a good idea to check if annotations are available
83
        if pdfController.document?.canSaveAnnotations ?? false {
84
            toolbarItems.append(UIBarButtonItem(barButtonSystemItem: .compose, target: self, action: #selector(toggleToolbar)))
85
        }
86
        customToolbar.items = toolbarItems
87
        view.addSubview(customToolbar)
88
    }
89

90
    override var preferredStatusBarStyle: UIStatusBarStyle {
91
        return .default
92
    }
93

94
    // MARK: Annotation toolbar
95

96
    @objc private func toggleToolbar(_ sender: Any) {
97
        if let flexibleToolbarContainer {
98
            flexibleToolbarContainer.hideAndRemove(animated: true) { _ in }
99
            return
100
        }
101
        let manager = pdfController.annotationStateManager
102
        let toolbar = AnnotationToolbar(annotationStateManager: manager)
103
        toolbar.matchUIBarAppearance(customToolbar)
104
        // (optional)
105
        let container = FlexibleToolbarContainer(frame: view.bounds)
106
        container.flexibleToolbar = toolbar
107
        container.overlaidBar = customToolbar
108
        container.containerDelegate = self
109
        view.addSubview(container)
110
        flexibleToolbarContainer = container
111
        container.show(animated: true)
112
    }
113

114
    // MARK: FlexibleToolbarContainerDelegate
115

116
    func flexibleToolbarContainerDidHide(_ container: FlexibleToolbarContainer) {
117
        flexibleToolbarContainer = nil
118
    }
119

120
    func flexibleToolbarContainerContentRect(_ container: FlexibleToolbarContainer) -> CGRect {
121
        pdfController.view.frame
122
    }
123

124
    // MARK: Layout
125

126
    override func viewWillLayoutSubviews() {
127
        super.viewWillLayoutSubviews()
128
        // Position the pdfController content below the toolbar
129
        var frame: CGRect = view.bounds
130
        frame.origin.y = customToolbar.frame.maxY
131
        frame.size.height -= frame.origin.y
132
        pdfController.view.frame = frame
133
    }
134

135
    // MARK: Public
136

137
    var document: Document? {
138
        get {
139
            pdfController.document
140
        }
141
        set {
142
            pdfController.document = newValue
143
        }
144
    }
145

146
    // MARK: Private
147

148
    @objc private func doneButtonPressed(_ sender: Any) {
149
        self.dismiss(animated: true)
150
    }
151

152
    // MARK: UIBarPositioningDelegate
153
    func position(for bar: UIBarPositioning) -> UIBarPosition {
154
        return .topAttached
155
    }
156
}