Add a Custom Cloudy Rectangle Annotation to a PDF in Swift for iOS

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

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

16
        title = "Cloudy rectangle tool (custom annotation variant)"
17
        contentDescription = "Shows side-by-side tools for creating straight rectangles and cloudy rectangles by setting up a custom tool variant."
18
        category = .annotations
19
        priority = 999
20
    }
21

22
    override func invoke(with delegate: ExampleRunnerDelegate) -> UIViewController {
23
        // Define a string to identify our custom tool variant.
24
        let cloudyRectangleVariant = Annotation.Variant(rawValue: "MyCustomCloudyRectangle")
25

26
        // Set the initial style to use a cloudy border. For simplicity, this example sets this every time but this info is persisted so usually you only want to set this once otherwise each time the app is run you might be overwriting the user’s last used styles.
27
        let cloudyRectangleID = Annotation.ToolVariantID(tool: .square, variant: cloudyRectangleVariant)
28
        PSPDFKit.SDK.shared.styleManager.setLastUsedValue(Annotation.BorderEffect.cloudy.rawValue, forProperty: #keyPath(Annotation.borderEffect), forKey: cloudyRectangleID)
29
        PSPDFKit.SDK.shared.styleManager.setLastUsedValue(2, forProperty: #keyPath(Annotation.borderEffectIntensity), forKey: cloudyRectangleID)
30

31
        let document = AssetLoader.writableDocument(for: .welcome, overrideIfExists: false)
32
        let pdfViewController = PDFViewController(document: document)
33

34
        // Define our tools for the annotation toolbar.
35
        let straightRectangleTool = AnnotationToolConfiguration.ToolItem(type: .square)
36
        let cloudyRectangleTool = AnnotationToolConfiguration.ToolItem(type: .square, variant: cloudyRectangleVariant) { _, _, _ in
37
            UIImage(namedInCatalog: "rectangle_cloudy")!
38
        }
39

40
        // Tell the annotation toolbar to use these tools.
41
        // In practice, you probably want more tools and want to set multiple configurations to adapt to different amounts of space available. See `MeasurementsExample` for an example.
42
        pdfViewController.annotationToolbarController!.annotationToolbar.configurations = [
43
            AnnotationToolConfiguration(annotationGroups: [
44
                AnnotationToolConfiguration.ToolGroup(items: [straightRectangleTool]),
45
                AnnotationToolConfiguration.ToolGroup(items: [cloudyRectangleTool]),
46
            ]),
47
        ]
48

49
        return pdfViewController
50
    }
51
}