Customize PDF Form Appearance in Swift for iOS

1
//
2
//  Copyright © 2020-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
/// This example shows how to customize the appearance of forms. We also add a
12
/// temporary label over text and signature fields which will disappear when
13
/// we type anything in the fields.
14
class CustomizingFormAppearanceExample: Example {
15

16
    override init() {
17
        super.init()
18

19
        title = "Customizing the Appearance of Forms"
20
        category = .forms
21
        priority = 10
22
    }
23

24
    let document = AssetLoader.writableDocument(for: "Form.pdf", overrideIfExists: true)
25

26
    override func invoke(with delegate: ExampleRunnerDelegate) -> UIViewController {
27
        /// These options clear out the default form field color so that
28
        /// we can customize it dynamically later in the example.
29
        let options = document.renderOptions(forType: .page)
30
        options.drawSignHereOverlay = false
31
        options.interactiveFormFillColor = UIColor.clear
32
        document.setRenderOptions(options, type: .page)
33

34
        let controller = PDFViewController(document: document) {
35
            $0.pageTransition = .scrollPerSpread
36
            $0.overrideClass(PDFPageView.self, with: CustomFormPDFPageView.self)
37
        }
38
        controller.delegate = self
39
        styleTextFieldFormElements()
40

41
        return controller
42
    }
43

44
    func styleTextFieldFormElements() {
45
        let annotations = document.annotationsForPage(at: 0, type: .widget)
46
        for annotation in annotations {
47
            if let formElement = annotation as? TextFieldFormElement {
48
                formElement.highlightColor = UIColor.clear
49
                formElement.fillColor = UIColor(red: 221.0 / 255.0, green: 240.0 / 255.0, blue: 236.0 / 255.0, alpha: 1)
50
                formElement.borderColor = UIColor.clear
51
                formElement.borderStyle = .none
52
                formElement.borderEffectIntensity = 0.0
53
            }
54
        }
55
    }
56
}
57

58
extension CustomizingFormAppearanceExample: PDFViewControllerDelegate {
59
    func pdfViewController(_ pdfController: PDFViewController, willBeginDisplaying pageView: PDFPageView, forPageAt pageIndex: Int) {
60
        if let pageView = pageView as? CustomFormPDFPageView {
61
            pageView.addLabels()
62
        }
63
    }
64
}
65

66
private class CustomFormPDFPageView: PDFPageView {
67

68
    /// Dictionary which keeps a mapping between the form element and its label.
69
    /// Used to identify which label to remove when selecting a form field.
70
    var labelList = [String: UILabel]()
71

72
    override var frame: CGRect {
73
        didSet {
74
            // Re-add labels when page view frame changes
75
            labelList.values.forEach { $0.removeFromSuperview() }
76
            labelList.removeAll()
77
            addLabels()
78
        }
79
    }
80

81
    /// `prepareForReuse` automatically removes all unknown internal subviews.
82
    /// We need to clear out our mapping dictionary as well.
83
    override func prepareForReuse() {
84
        labelList.removeAll()
85
        super.prepareForReuse()
86
    }
87

88
    /// Add labels over all the text and signature fields.
89
    func addLabels() {
90
        guard let document = presentationContext?.document else { return }
91
        let annotations = document.annotationsForPage(at: pageIndex, type: .widget)
92
        for annotation in annotations {
93
            if let formElement = annotation as? FormElement {
94
                addLabelOnFormElement(formElement: formElement)
95
            }
96
        }
97
    }
98

99
    /// Add the label on a given form element. Only add a label if the form field is empty.
100
    func addLabelOnFormElement(formElement: FormElement) {
101
        if !(formElement.isKind(of: TextFieldFormElement.self) || formElement.isKind(of: SignatureFormElement.self)) { return }
102

103
        let label = labelList[formElement.uuid] ?? UILabel()
104
        if let textFieldFormElement = formElement as? TextFieldFormElement {
105
            if textFieldFormElement.contents != nil && textFieldFormElement.contents != "" { return }
106
            label.text = textFieldFormElement.textFormField?.name ?? "Text Field"
107
        }
108
        if let signatureFormElement = formElement as? SignatureFormElement {
109
            if signatureFormElement.isSigned || signatureFormElement.overlappingSignatureAnnotation != nil { return }
110
            label.text = "Signature Field"
111
        }
112

113
        label.frame = convert(formElement.boundingBox, from: pdfCoordinateSpace)
114
        label.textAlignment = .center
115
        label.textColor = UIColor(red: 84.0 / 255.0, green: 178.0 / 255.0, blue: 159.0 / 255.0, alpha: 1)
116
        label.backgroundColor = UIColor(red: 221.0 / 255.0, green: 240.0 / 255.0, blue: 236.0 / 255.0, alpha: 1)
117
        annotationContainerView.addSubview(label)
118
        labelList[formElement.uuid] = label
119
    }
120

121
    override func didSelect(_ annotations: [Annotation]) {
122
        super.didSelect(annotations)
123
        for annotation in annotations {
124
            if let label = labelList[annotation.uuid] {
125
                labelList[annotation.uuid] = nil
126
                label.removeFromSuperview()
127
            }
128
            if let textFieldFormElement = annotation as? TextFieldFormElement {
129
                textFieldFormElement.borderColor = UIColor(red: 84.0 / 255.0, green: 178.0 / 255.0, blue: 159.0 / 255.0, alpha: 1)
130
                textFieldFormElement.borderStyle = .solid
131
                textFieldFormElement.borderEffectIntensity = 1.0
132
            }
133
        }
134
    }
135

136
    override func didDeselect(_ annotations: [Annotation]) {
137
        super.didDeselect(annotations)
138
        for annotation in annotations {
139
            if let textFieldFormElement = annotation as? TextFieldFormElement {
140
                textFieldFormElement.borderColor = UIColor.clear
141
                textFieldFormElement.borderStyle = .none
142
                textFieldFormElement.borderEffectIntensity = 0.0
143
            }
144
            if let formElement = annotation as? FormElement {
145
                addLabelOnFormElement(formElement: formElement)
146
            }
147
            if let inkAnnotation = annotation as? InkAnnotation {
148
                if inkAnnotation.isSignature { addLabels() }
149
            }
150
        }
151
    }
152
}