Customize annotation interactions in iOS viewer

Annotation and PDF interaction is implemented within the open-source Tools.framework. This includes annotation creation & selection, text selection, form filling and link following.

The behavior is implemented via a collection of "Tools": classes that derive from the abstract base class PTTool and that are coordinated by a PTToolManager. The PTToolManager provides the ability to customize tool behavior, and enable/disable the ability for users to create or edit annotations (both in general and on an annotation type by annotation type basis).

To disable (or re-enable) the ability to create or edit annotations, options can be altered as shown below. When disabled, the relevant annotation tool is removed from the annotation toolbar, and from the UIMenuController.

1// disables all text annotation types (highlights, underlines, etc.)
2toolManager.highlightAnnotationOptions.canCreate = false
3toolManager.highlightAnnotationOptions.canEdit = false
4toolManager.underlineAnnotationOptions.canCreate = false
5toolManager.underlineAnnotationOptions.canEdit = false
6toolManager.strikeOutAnnotationOptions.canCreate = false
7toolManager.strikeOutAnnotationOptions.canEdit = false
8toolManager.squigglyAnnotationOptions.canCreate = false
9toolManager.squigglyAnnotationOptions.canEdit = false

1// disables all text annotation types (highlights, underlines, etc.)
2toolManager.highlightAnnotationOptions.canCreate = NO;
3toolManager.highlightAnnotationOptions.canEdit = NO;
4toolManager.underlineAnnotationOptions.canCreate = NO;
5toolManager.underlineAnnotationOptions.canEdit = NO;
6toolManager.strikeOutAnnotationOptions.canCreate = NO;
7toolManager.strikeOutAnnotationOptions.canEdit = NO;
8toolManager.squigglyAnnotationOptions.canCreate = NO;
9toolManager.squigglyAnnotationOptions.canEdit = NO;

Further control over annotation interaction behaviour via the PTToolManagerDelegate protocol.

There are several methods that allow you to be notified of, and if desired modify or prevent, default behavior from occurring. For all methods, if false is returned, then the default behavior will not occur.

1. -toolManager:shouldSelectAnnotation:onPageNumber:This method is called just before an annotation is selected. The annotation object itself is available for the decision making process, and for further action if needed.
2. -toolManager:shouldShowMenu:forAnnotation:onPageNumber:This method is called just before the selection popup menu is shown. The UIMenuController object is passed so that menu items can be added or removed as required.
3. -toolManager:shouldHandleLinkAnnotation:orLinkInfo:onPageNumber:This method is called just before a link is followed. The link is provided so that alternate action can be taken if required.
4. -toolManager:shouldSwitchToTool:This method is called just before a tool is activated. The tool is available for the decision making process.

The sample code uses -toolManager:shouldShowMenu:forAnnotation:onPageNumber: to restrict use of the UIMenuController to copying and defining text found in the PDF. This is done by stopping the UIMenuController from popping up in any case other than selecting text, and by removing options to highlight/underline etc. from the selected text UIMenuController popup.

1// PTToolManagerDelegate method implementation.
2func toolManager(_ toolManager: PTToolManager, shouldShowMenu menuController: UIMenuController, forAnnotation annotation: PTAnnot, onPageNumber pageNumber: UInt) -> Bool {
3    // Only show quick menu for the text select tool.
4    if type(of: toolManager.tool) === TextSelectTool.self {
5        // Remove the annotation creation menu items.
6        menuController.menuItems = removeAnnotationItems(menuController.menuItems!)
7  
8        return true;
9    } else {
10        return false;
11    }
12}
13
14func removeAnnotationItems(_ items: [UIMenuItem]) -> [UIMenuItem] {
15    let stringsToRemove = ["Highlight", "Underline", "Squiggly", "Strikeout"]
16    
17    // Filter out menu items with titles matching specified strings.
18    return items.filter({ (menuItem) -> Bool in
19        return !stringsToRemove.contains(menuItem.title)
20    })
21}

1// PTToolManagerDelegate method implementation.
2-(BOOL)toolManager:(PTToolManager *)toolManager shouldShowMenu:(UIMenuController *)menuController forAnnotation:(PTAnnot *)annotation onPageNumber:(unsigned long)pageNumber {
3    // Only show quick menu for the text select tool.
4    if ([toolManager.tool isKindOfClass:[TextSelectTool class]]) {
5        // Remove the annotation creation menu items.
6        menuController.menuItems = [self removeAnnotationItems:menuController.menuItems];
7
8        return YES;
9    } else {
10        return NO;
11    }
12}
13
14- (NSArray<UIMenuItem *> *)removeAnnotationItems:(NSArray<UIMenuItem *> *)items {
15    NSArray<NSString *> *stringsToRemove = @[
16        PTLocalizedString(@"Highlight", nil),
17        PTLocalizedString(@"Underline", nil),
18        PTLocalizedString(@"Squiggly", nil),
19        PTLocalizedString(@"Strikeout", nil)
20    ];
21    
22    // Filter out menu items with titles matching specified strings.
23    return [items objectsAtIndexes:[items indexesOfObjectsPassingTest:^BOOL(UIMenuItem *menuItem, NSUInteger idx, BOOL *stop) {
24        return ![stringsToRemove containsObject:menuItem.title];
25    }]];
26}

Default Menu Options	Customized Menu Options

Tools.framework frequently creates new instances of objects defined within the framework (e.g. a new instance of PTAnnotEditTool is created when a user taps on an annotation). In order to customize certain aspects of the default behavior, it is required to create and use a subclass of the built-in tool. To enable this without requiring source code modification, Tools.framework includes a system to "inject" an externally defined subclass that will be used by the Tools.framework during its normal operation. This is done via the PTOverrides class as follows:

1// EGAnnotEditTool is an externally defined class that derives from PTAnnotEditTool
2PTOverrides.overrideClass(PTAnnotEditTool.self, withClass: EGAnnotEditTool.self);

1// EGAnnotEditTool is an externally defined class that derives from PTAnnotEditTool
2[PTOverrides overrideClass:[PTAnnotEditTool class] withClass:[EGAnnotEditTool class]];

Note that in order to be compatible with the external override system, the base class must conform to the PTOverridable protocol.

Because Tools.framework is open source, any and all changes are possible by editing the source code directly. The project is found in /Lib/Tools/src.

If you customize the tools source code, you will likely want to use a universal framework (one that contains architectures for both simulators and devices), which is not done automatically by Xcode. The Tools project includes a custom script step that automatically creates a universal framework, located in a folder next to the default build location, with the name {Debug,Release}-universal.

(Building a universal framework also be done manually by first building for device, then simulator, and using the terminal command xcrun -sdk iphoneos lipo -create to merge the binaries (Tools.framework/Tools) into a universal binary.)