Customize PDF Outline 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 CustomOutlineControllerExample: Example {
12

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

16
        title = "Custom Outline Controller"
17
        contentDescription = "Shows how to use a custom outline controller in the document info."
18
        category = .viewCustomization
19
        priority = 100
20
    }
21

22
    override func invoke(with delegate: ExampleRunnerDelegate) -> UIViewController {
23
        return PDFViewController(document: AssetLoader.document(for: .welcome)) {
24
            $0.overrideClass(DocumentInfoCoordinator.self, with: CustomDocumentInfoCoordinator.self)
25
        }
26
    }
27
}
28

29
private class CustomDocumentInfoCoordinator: DocumentInfoCoordinator {
30

31
    override func controller(forOption option: DocumentInfoOption) -> UIViewController? {
32
        if option == .outline {
33
            return CustomOutlineViewController()
34
        } else {
35
            return super.controller(forOption: option)
36
        }
37
    }
38
}
39

40
private class CustomOutlineViewController: UIViewController, SegmentImageProviding {
41

42
    override func viewDidLoad() {
43
        super.viewDidLoad()
44
        view.backgroundColor = UIColor.systemYellow
45

46
        let customLabel = UILabel()
47
        customLabel.translatesAutoresizingMaskIntoConstraints = false
48
        customLabel.text = "I am a custom outline controller"
49
        customLabel.textAlignment = .center
50
        view.addSubview(customLabel)
51

52
        NSLayoutConstraint.activate([
53
            customLabel.topAnchor.constraint(equalTo: view.topAnchor, constant: 20),
54
            customLabel.bottomAnchor.constraint(equalTo: view.bottomAnchor, constant: -20),
55
            customLabel.leadingAnchor.constraint(equalTo: view.leadingAnchor),
56
            customLabel.trailingAnchor.constraint(equalTo: view.trailingAnchor)
57
        ])
58
    }
59

60
    // MARK: - PSPDFSegmentImageProviding
61

62
    var segmentImage: UIImage? {
63
        return UIImage(systemName: "text.book.closed")
64
    }
65
}