Add Image Gallery to PDF 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 ButtonImageGalleryExample: Example, PDFViewControllerDelegate {
12
    override init() {
13
        super.init()
14
            title = "Galleries with button activation"
15
            contentDescription = "Buttons that show/hide gallery or videos."
16
            category = .multimedia
17
            priority = 51
18
    }
19

20
    override func invoke(with delegate: ExampleRunnerDelegate) -> UIViewController? {
21
        let document = AssetLoader.temporaryDocument(with: "")
22
        document.annotationSaveMode = .disabled
23

24
        do {
25
            let title = FreeTextAnnotation(contents: "Galleries with button activation")
26
            title.fontSize = 20
27
            title.boundingBox = CGRect(x: 20.0, y: 750.0, width: 300.0, height: 40.0)
28
            document.add(annotations: [title], options: nil)
29
        }
30

31
        do {
32
            let text = FreeTextAnnotation(contents: "Gallery that opens inline:\n\n[Action.Option.buttonKey: NSNumber(value: true)]")
33
            text.fontSize = 15
34
            text.boundingBox = CGRect(x: 20.0, y: 600.0, width: 350.0, height: 60.0)
35

36
            // Setting the button option to yes will show the default button.
37
            let url = URL(string: "pspdfkit://localhost/Bundle/sample.gallery")!
38
            let galleryAction = URLAction(url: url, options: [
39
                Action.Option.buttonKey: true
40
            ])
41
            let galleryAnnotation = LinkAnnotation(action: galleryAction)
42
            galleryAnnotation.boundingBox = CGRect(x: 80.0, y: 550.0, width: 300.0, height: 200.0)
43
            document.add(annotations: [text, galleryAnnotation], options: nil)
44
        }
45

46
        do {
47
            let text = FreeTextAnnotation(contents: "Gallery that opens inline with a custom button image:\n\n[Action.Option.buttonKey: \"pspdfkit://localhost/Bundle/eye\"]")
48
            text.fontSize = 15
49
            text.boundingBox = CGRect(x: 20.0, y: 450.0, width: 450.0, height: 60.0)
50

51
            // Setting the button option to a URL will load this URL. The URL can be local or remote. Use pspdfkit://localhost for local URLs.
52
            // For remote URLs, use something such as:
53
            // [Action.Option.buttonKey: "https://www.dropbox.com/s/8diroz5npb3eciy/webimage2%402x.png?raw=1"]
54
            let url = URL(string: "pspdfkit://localhost/Bundle/sample.gallery")!
55
            let action = URLAction(url: url, options: [
56
                Action.Option.buttonKey: "pspdfkit://localhost/Bundle/eye"
57
            ])
58

59
            let galleryAnnotation = LinkAnnotation(action: action)
60
            galleryAnnotation.boundingBox = CGRect(x: 260.0, y: 400.0, width: 300.0, height: 200.0)
61
            document.add(annotations: [text, galleryAnnotation], options: nil)
62
        }
63

64
        do {
65
            let text = FreeTextAnnotation(contents: "Link that opens modally:\n\nAction.Option.buttonKey: NSNumber(value: true),\nAction.Option.modalKey: NSNumber(value: true),\nAction.Option.sizeKey: NSNumber(cgSize: CGSize(width: 550.0, height: 550.0))")
66
            text.fontSize = 15.0
67
            text.boundingBox = CGRect(x: 20.0, y: 80.0, width: 600.0, height: 120.0)
68

69
            let url = URL(string: "pspdfkit://www.apple.com/ipad/")!
70
            let action = URLAction(url: url, options: [
71
                Action.Option.buttonKey: true,
72
                Action.Option.modalKey: true,
73
                Action.Option.sizeKey: CGSize(width: 550.0, height: 550.0)
74
            ])
75
            let webAnnotation = LinkAnnotation(action: action)
76
            webAnnotation.boundingBox = CGRect(x: 205.0, y: 175.0, width: 30.0, height: 30.0)
77
            document.add(annotations: [text, webAnnotation], options: nil)
78
        }
79

80
        let pdfController = PDFViewController(document: document) { builder in
81
            // Disable free text editing here as we use them as labels.
82
            builder.editableAnnotationTypes = nil
83
        }
84
        return pdfController
85
    }
86
}