Cycle Through PDF Documents 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
private class PageViewController: UIPageViewController {
12
    override func viewDidLayoutSubviews() {
13
        super.viewDidLayoutSubviews()
14

15
        // This is somewhat of a hack to work around the inflexible UIPageViewController
16
        // This will extend the content to include the page control indicator.
17
        for view in self.view.subviews {
18
            if view is UIScrollView {
19
                view.frame = self.view.frame
20
            } else if view is UIPageControl {
21
                self.view.bringSubviewToFront(view)
22
                view.backgroundColor = UIColor.clear
23
            }
24
        }
25
    }
26
}
27

28
class PageViewControllerExample: Example {
29

30
    var controller: [UIViewController] = []
31
    var pageViewController: UIPageViewController?
32
    var pageIndex: Int {
33
        didSet {
34
            updateTitle()
35
        }
36
    }
37

38
    override init() {
39
        pageIndex = 0
40
        super.init()
41
        title = "UIPageViewController Example"
42
        contentDescription = "Use UIPageViewController to cycle through PDFs"
43
        category = .viewCustomization
44
        priority = 11
45
        prefersLargeTitles = false
46
    }
47

48
    override func invoke(with delegate: ExampleRunnerDelegate) -> UIViewController {
49
        // prepare list of documents you want to present
50
        let assetNames: [AssetName] = [.welcome, .about, .web, .annualReport]
51
        let documents = assetNames.map { assetName in
52
            return AssetLoader.document(for: assetName)
53
        }
54
        // allocating many PDFViewController instances is memory intensive
55
        // if you have many documents, you should switch to a on-demand solution and re-use controllers.
56
        controller = documents.map { document in
57
            let pdfController = PDFViewController(document: document) {
58
                $0.pageTransition = .scrollContinuous
59
                $0.scrollDirection = .vertical
60
                $0.useParentNavigationBar = true
61
                $0.userInterfaceViewMode = .automaticNoFirstLastPage
62
                // the scrubber wouldn't work well when we expect horizontal movements to scroll content
63
                $0.thumbnailBarMode = .none
64
                // background is defined by the page view controller already
65
                $0.backgroundColor = UIColor.clear
66
            }
67
            pdfController.navigationItem.rightBarButtonItems = [pdfController.thumbnailsButtonItem, pdfController.outlineButtonItem, pdfController.searchButtonItem, pdfController.annotationButtonItem]
68
            return pdfController
69
        }
70

71
        // set up the page view controller
72
        let pageController = PageViewController(transitionStyle: .scroll, navigationOrientation: .horizontal, options: [.interPageSpacing: 10])
73
        pageController.dataSource = self
74
        pageController.delegate = self
75
        pageController.setViewControllers([controller[0]], direction: .forward, animated: false, completion: nil)
76
        pageController.view.backgroundColor = #colorLiteral(red: 0.05882352963, green: 0.180392161, blue: 0.2470588237, alpha: 1)
77
        pageViewController = pageController
78
        pageIndex = 0
79

80
        // styling as we customize the page indicator to overlay
81
        let pageControl = UIPageControl.appearance(whenContainedInInstancesOf: ([PageViewController.self]))
82
        pageControl.pageIndicatorTintColor = UIColor.lightGray
83
        pageControl.currentPageIndicatorTintColor = UIColor.darkGray
84
        UserInterfaceView.appearance(whenContainedInInstancesOf: ([PageViewController.self])).pageLabelInsets = UIEdgeInsets(top: 0, left: 0, bottom: 40, right: 0)
85

86
        return pageController
87
    }
88

89
    func updateTitle() {
90
        // Title is set a bit later in PDFViewController initialization, so we use it from the
91
        // document directly. Aternatively, title could be KVO ovserved.
92
        guard let pdfController = controller[pageIndex] as? PDFViewController else { return }
93
        pageViewController?.title = pdfController.document?.title
94

95
        // Since we forward the navigationitem from the hosted view controller, we need to explicly update
96
        pdfController.updateToolbar(animated: false)
97
    }
98
}
99

100
extension PageViewControllerExample: UIPageViewControllerDelegate {
101
    public func pageViewController(_ pageViewController: UIPageViewController, didFinishAnimating finished: Bool, previousViewControllers: [UIViewController], transitionCompleted completed: Bool) {
102
        guard completed,
103
            let currentVisibleController = pageViewController.viewControllers?.first,
104
            let index = controller.firstIndex(of: currentVisibleController) else { return }
105
        // update page index after it updated successfully
106
        pageIndex = index
107
    }
108
}
109

110
extension PageViewControllerExample: UIPageViewControllerDataSource {
111

112
    public func pageViewController(_ pageViewController: UIPageViewController, viewControllerBefore viewController: UIViewController) -> UIViewController? {
113
        guard let index = controller.firstIndex(of: viewController), index > 0 else { return nil }
114
        return controller[index - 1]
115
    }
116

117
    public func pageViewController(_ pageViewController: UIPageViewController, viewControllerAfter viewController: UIViewController) -> UIViewController? {
118
        guard let index = controller.firstIndex(of: viewController), index + 1 < controller.count else { return nil }
119
        return controller[index + 1]
120
    }
121

122
    // The number of items reflected in the page indicator.
123
    public func presentationCount(for pageViewController: UIPageViewController) -> Int {
124
        return controller.count
125
    }
126

127
    // The selected item reflected in the page indicator.
128
    public func presentationIndex(for pageViewController: UIPageViewController) -> Int {
129
        return pageIndex
130
    }
131
}