Overriding Classes

PSPDFKit has a rather unique and easy-to-use system that allows you to subclass classes that are used deeply within the framework without having to know where they are all instantiated.

The PDFConfigurationBuilder object has an overrideClass(_:with:) method in the builder, which is where you can register your subclasses to be used in place of the default PSPDFKit classes.

Let’s say you want to move the ScrubberBar all the way to the top. Classes usually don’t manage their placement themselves, so in this example, the class is managed by the UserInterfaceView, which requires you to override the class. We usually expose a variety of hooks that are meant to be modified in a subclass:

Copy
1
2
3
4
5
6
7
8
9
extension UserInterfaceView {

    /// Update these to manually set the frame.
    open func updateDocumentLabelFrame(animated: Bool)
    open func updatePageLabelFrame(animated: Bool)
    open func updateThumbnailBarFrame(animated: Bool)
    open func updateScrubberBarFrame(animated: Bool)

}
Copy
1
2
3
4
5
6
7
8
9
@interface PSPDFUserInterfaceView (SubclassingHooks)

// Update these to manually set the frame.
- (void)updateDocumentLabelFrameAnimated:(BOOL)animated;
- (void)updatePageLabelFrameAnimated:(BOOL)animated;
- (void)updateThumbnailBarFrameAnimated:(BOOL)animated;
- (void)updateScrubberBarFrameAnimated:(BOOL)animated;

@end

Here we’re interested in modifying the updateScrubberBarFrame(animated:) method.

First, we create a custom subclass where we override this method:

Copy
1
2
3
4
5
6
7
8
9
10
11
12
class CustomUserInterfaceView: UserInterfaceView {

    override func updateScrubberBarFrame(animated: Bool) {
        super.updateScrubberBarFrame(animated: animated)

        // Stick scrubber bar to the top.
        var newFrame = dataSource!.contentRect
        newFrame.size.height = 44
        scrubberBar.frame = newFrame
    }

}
Copy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
@interface PSCCustomUserInterfaceView : PSPDFUserInterfaceView @end

@implementation PSCCustomUserInterfaceView

- (void)updateScrubberBarFrameAnimated:(BOOL)animated {
    [super updateScrubberBarFrameAnimated:animated];

    // Stick scrubber bar to the top.
    CGRect newFrame = self.dataSource.contentRect;
    newFrame.size.height = 44.f;
    self.scrubberBar.frame = newFrame;
}

@end

Next, we register our custom subclass:

Copy
1
2
3
let pdfController = PDFViewController(document: document) {
    $0.overrideClass(UserInterfaceView.self, with: CustomUserInterfaceView.self)
}
Copy
1
2
3
4
5
PSPDFConfiguration *configuration = [PSPDFConfiguration configurationWithBuilder:^(PSPDFConfigurationBuilder *builder) {
    [builder overrideClass:PSPDFUserInterfaceView.class withClass:PSCCustomUserInterfaceView.class];
}];

PSPDFViewController *pdfController = [[PSPDFViewController alloc] initWithDocument:document configuration:configuration];

That’s it! From now on, every time PSPDFKit creates a UserInterfaceView, it actually uses CustomUserInterfaceView.

Things to Keep in Mind

  • Your subclass must be an actual subclass or we’ll throw an exception to warn you.
  • Only classes that already conform to the Overridable protocol can be overridden. Do not add conformance to this protocol for any other existing classes or for your new ones.
  • Most methods require that you call them on super.
  • Model-related classes need to be registered in Document’s overrideClass(_:with:).
  • Overrides need to be registered before calling any other method on the object (e.g. trying to set an override on the document after unlock(withPassword:) has been called will silently fail — it would be too expensive to check all calls for timing correctness).
  • If you see a getter/setter property pair or a read-only getter, do not override it unless doing so is specifically documented. In most cases, this will lead to unexpected/inconsistent/buggy behavior. PSPDFKit will even detect and assert some of these attempts, but we can’t possibly anticipate every use and every way to dynamically override properties. In most cases, there will be a better way to achieve what you’re trying to do — ping us on support; we’re happy to help.