Customize PDF Editor Toolbar using Swift for iOS

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

13
    override init() {
14
        super.init()
15
        title = "Document Editor Toolbar Customization"
16
        contentDescription = "Customize the new page button and remove all remaining buttons."
17
        category = .documentEditing
18
        priority = 1
19
    }
20

21
    override func invoke(with delegate: ExampleRunnerDelegate) -> UIViewController {
22
        // Let's create a new writable document every time we invoke the example for the
23
        // purpose of this example.
24
        let document = AssetLoader.writableDocument(for: .welcome, overrideIfExists: true)
25
        let pdfController = PDFViewController(document: document) {
26
            $0.overrideClass(PDFDocumentEditorToolbarController.self, with: FixedPageToolbarController.self)
27
            $0.overrideClass(PDFDocumentEditorToolbar.self, with: FixedPageToolbar.self)
28
        }
29

30
        // Immediately switch into document editor.
31
        pdfController.viewMode = .documentEditor
32

33
        return pdfController
34
    }
35

36
    // MARK: - Toolbar Controller
37

38
    @MainActor private class FixedPageToolbarController: PDFDocumentEditorToolbarController {
39

40
        override init(toolbar: FlexibleToolbar) {
41
            super.init(toolbar: toolbar)
42

43
            // Replace the default action.
44
            let addPageButton = documentEditorToolbar.addPageButton
45
            addPageButton.removeTarget(nil, action: nil, for: .touchUpInside)
46
            addPageButton.addTarget(self, action: #selector(addNewFixedPage), for: .touchUpInside)
47
        }
48

49
        convenience override init(documentEditorToolbar: PDFDocumentEditorToolbar) {
50
            self.init(toolbar: documentEditorToolbar)
51
        }
52

53
        @objc func addNewFixedPage(_ sender: AnyObject) {
54
            guard let editor = documentEditor else {
55
                return
56
            }
57
            let pageSize = editor.pageSizeForPage(at: 0)
58
            let newPageConfiguration = PDFNewPageConfiguration(pageTemplate: PageTemplate(pageType: .tiledPatternPage, identifier: .grid5mm)) {
59
                $0.pageSize = pageSize
60
                $0.backgroundColor = UIColor.psc_secondarySystemBackground
61
            }
62
            editor.addPages(in: NSRange(location: 0, length: 1), with: newPageConfiguration)
63
        }
64
    }
65

66
    // MARK: - Toolbar
67

68
    private class FixedPageToolbar: PDFDocumentEditorToolbar {
69

70
        // An alternative would be to override the individual button properties and return nil.
71
        override func buttons(forWidth width: CGFloat) -> [ToolbarButton] {
72
            return super.buttons(forWidth: width).filter { button in
73
                // Keep the done button, add page button and spacers.
74
                button === doneButton || button === addPageButton || button.isFlexible == true
75
            }
76
        }
77
    }
78
}