Show documents in a tabbed ViewController with Apryse iOS SDK

The PTTabbedDocumentViewController class is a container view controller that hosts multiple PTDocumentControllers with a tabbed interface. For more information about the PTDocumentController class, please see this guide.

On iPads or other devices with a Regular horizontal size class then the tabs will be shown in a bar along the top of the view, for Compact size classes the tabs will be accessible in the UIToolbar at the bottom of the view.

The tabbed viewer control is part of the Tools library, so make sure you have added the Tools library to your project.

The following sample demonstrates how to show a tabbed viewer controller with a document from another UIViewController:

1// Create and wrap a tabbed controller in a navigation controller.
2let tabbedController = PTTabbedDocumentViewController()
3
4let navigationController = UINavigationController(rootViewController: tabbedController)
5
6// Open an existing local file URL.
7let fileURL: URL! = Bundle.main.url(forResource: "sample", withExtension: "pdf")
8
9tabbedController.openDocument(with: fileURL)
10
11// Show navigation (and tabbed) controller.
12self.present(navigationController, animated: true, completion: nil)

1// Create and wrap a tabbed controller in a navigation controller.
2PTTabbedDocumentViewController *tabbedController = [[PTTabbedDocumentViewController alloc] init];
3
4UINavigationController *navigationController = [[UINavigationController alloc] initWithRootViewController:tabbedController];
5
6// Open an existing local file URL.
7NSURL *fileURL = [[NSBundle mainBundle] URLForResource:@"Sample" withExtension:@"pdf"];
8
9[tabbedController openDocumentWithURL:fileURL];
10
11// Show navigation (and tabbed) controller. 
12[self presentViewController:navigationController animated:YES completion:nil];

The openDocumentWithURL: method will create a new tab if the URL is not already being displayed, otherwise it will switch to the existing tab.

The tabbed viewer controller currently relies on the UINavigationController to supply a navigation bar for the buttons.

For more control over how tabs are added to the tabbed viewer controller, the addTabWithURL:selected:error: and insertTabWithURL:atIndex:selected:error: methods can be used:

1// Add the fileURL to the end of the tab bar, without changing the selected tab.
2do {
3	try tabbedController.addTab(with: fileURL selected:false)
4} catch {
5	// Failed to add tab.
6}
7
8// Insert and select the otherFileURL at the start of the tab bar.
9do {
10	try tabbedController.insertTab(with: otherFileURL, at: 0, selected:true)
11} catch {
12	// Failed to insert and select tab.
13}

1// Add the fileURL to the end of the tab bar, without changing the selected tab.
2NSError *error = nil;
3BOOL success = [tabbedController addTabWithURL:fileURL selected:NO error:&error];
4if (!success) {
5	// Failed to add tab.
6}
7
8// Insert and select the otherFileURL at the start of the tab bar.
9error = nil;
10success = [tabbedController insertTabWithURL:otherFileURL atIndex:0 selected:YES error:&error];
11if (!success) {
12	// Failed to insert and select tab.
13}

The behavior of the tabbed viewer controller can be customized with several properties. The tabsEnabled and maximumTabCount properties can be used to disable the tab bar and limit the number of tabs, respectively. By default, tabs are enabled in the tabbed viewer controller and there is no limit on the number of tabs.

The tab bar's visibility is controlled by the tabBarHidden property. To animate the change in visibility, the setTabBarHidden:animated: method can be used.

When the containing navigation controller's navigation bar is hidden, the tabbed viewer also hides its tab bar.

To configure a document view controller before it is displayed, conform to and implement the PTTabbedDocumentViewControllerDelegate method tabbedDocumentViewController:willAddDocumentViewController:. Note that it is permissible to assign the internal PTDocumentController's delegate to an external object.

1func tabbedDocumentViewController(_ tabbedDocumentViewController: PTTabbedDocumentViewController, willAdd documentViewController: PTDocumentController) {
2
3        documentViewController.delegate = self
4        // customize documentViewController
5    }

1-(void)tabbedDocumentViewController:(PTTabbedDocumentViewController *)tabbedDocumentViewController willAddDocumentViewController:(PTDocumentController *)documentViewController
2{
3    documentViewController.delegate = self;
4    // customize documentViewController
5}

You can set a delegate to be notified by the tabbed viewer controller when tabs are removed with the PTTabbedDocumentViewControllerDelegate protocol's tabbedDocumentViewController:willRemoveTabAtIndex: method.

The tabbedDocumentViewController:willRemoveTabAtIndex: delegate method can be used to close the tabbed viewer controller when the last tab is closed:

1func tabbedDocumentViewController(_ tabbedDocumentViewController: PTTabbedDocumentViewController, willRemoveTabAt index: UInt) {
2  	// Check if the last tab is being removed.
3    if (tabbedDocumentViewController.tabURLs.count > 1) {
4        return
5    }
6        
7    // Close tabbed viewer controller.
8    // ...
9}

1- (void)tabbedDocumentViewController:(PTTabbedDocumentViewController *)tabbedDocumentViewController willRemoveTabAtIndex:(NSUInteger)index
2{
3    // Check if the last tab is being removed.
4    if (tabbedDocumentViewController.tabURLs.count > 1) {
5        return;
6    }
7    
8    // Close tabbed viewer controller.
9    // ...
10}