自定义 UI ​

“ComPDFKit_Tools” 文件夹包含了可引导快速集成 ComPDFKit PDF SDK 的 UI 组件。我们还使用这个 UI 组件库构建了6个独立的功能程序，分别是 Viewer，Annotations，ContentEditor，Forms，DocsEditor 和 DigitalSignature。此外，我们还开发了一个叫做 PDFViewer 的程序，它集成了所有以上提到的示例功能供您参考。在本节中，我们会从以下几部分介绍如何使用它：

1. "ComPDFKit_Tools" 概述: 展示文件夹结构和对应的功能板块。

2. UI 组件：介绍 UI 组件以及如何轻松快速地使用它们。

3. 使用 CPDFListView 类: 包含使用 CPDFListView的详细步骤。

4. 了解更多：展示适用于 iOS 开发平台的特殊代码结构和功能。

如何使用默认 UI 制作 iOS 应用程序

ComPDFKit PDF SDK 的 "ComPDFKit_Tools" 是示例工程的 UI 组件库，它包括应用程序的基本 UI。要使用 ComPDFKit PDF SDK 的默认 UI 制作自定义的 iOS 应用程序 UI，可在 Lib/Tools/Objective-C/ 或 Lib/Tools/Swift/ 路径中找到对应开发语言的 "ComPDFKit_Tools" 文件，并引入到你的工程中。

"ComPDFKit_Tools" 概述 ​

"ComPDFKit_Tools" 中有九个模块： "Common"、"Viewer"、"Annotations"、"ContentEditor"、"Forms"、"DocsEditor"、"DigitalSignature"、"Security" 和 "Watermark"。如下表所示，每个模块都包含对应 PDF 功能的代码和 UI 组件。

UI 组件 ​

本节主要介绍 "ComPDFKit_Tools" 的 UI 组件与 API 配置之间的联系，这不仅可以帮助你快速上手 ComPDFKit 默认的 UI，还可以帮助你查看相关的API配置。这些 UI 组件可以被使用和修改，以创建你自定义的 UI。

Part 1:

上图的左图显示了与 Viewer 模块 API 相关的主要 UI 组件，这些也是 "ComPDFKit_Tools" 的基本 UI 组件。上图的右图显示了与 Text search 的 API 相关的主要 UI 组件。以下是 UI 组件和 APIs 之间对应的详细情况。

以下是初始化 Tools switcher （编号2） 的方法：

// CPDFToolsViewController：初始化CToolModel类型的数组toolArrays
// toolArrays：保存Tools展示模式的类型和数量
let toolsVc = CPDFToolsViewController(customizeWithToolArrays: [NSNumber(value: CPDFToolFunctionTypeState.viewer.rawValue),
                                                                        NSNumber(value: CPDFToolFunctionTypeState.edit.rawValue),
                                                                        NSNumber(value: CPDFToolFunctionTypeState.annotation.rawValue),
                                                                        NSNumber(value: CPDFToolFunctionTypeState.form.rawValue)])

// CPDFToolsViewController：初始化CToolModel类型的数组toolArrays
// toolArrays：保存Tools展示模式的类型和数量
CPDFToolsViewController * toolsVc = [[CPDFToolsViewController alloc] initCustomizeWithToolArrays:@[@(CToolModelViewer),@(CToolModelEdit),@(CToolModelAnnotation),@(CToolModelForm)]];

以下是初始化 BOTA（编号4）的方法：

// CPDFBOTAViewController：初始化CPDFListview对象 - pdfView，和CPDFBOTATypeState类型数组 - navArrays
// navArrays：保存BOTA展示的列表类型和数量
  let navArrays: [CPDFBOTATypeState] = [.CPDFBOTATypeStateOutline,
                                        .CPDFBOTATypeStateBookmark,
                                        .CPDFBOTATypeStateAnnotation]
        if(self.pdfListView != nil) {
            let botaViewController = CPDFBOTAViewController(customizeWith: self.pdfListView!, navArrays: navArrays)
        }

// CPDFBOTAViewController：初始化CPDFListview对象 - pdfView，和CPDFBOTATypeState类型数组 - navArrays
// navArrays：保存BOTA展示的列表类型和数量
CPDFBOTAViewController *botaVC = [[CPDFBOTAViewController alloc] initCustomizeWithPDFView:pdfListView navArrays:@[@(CPDFBOTATypeStateOutline),@(CPDFBOTATypeStateBookmark),@(CPDFBOTATypeStateAnnotation)]];

Part 2:

上面的左图展示了与CPDFBOTAViewController API 关联的主要 UI 组件。上面的右图展示了与CPDFPopMenuView API 关联的主要UI组件。请参阅以下 UI 组件与 API 的对应情况。

Part 3:

上面的左图展示了与 Annotations API 关联的主要 UI 组件。上面的右图展示了与ContentEditor API 关联的主要 UI 组件。请参阅以下 UI 组件与 API 的对应情况。

以下是初始化CAnnotationManage（编号19）的方法：

// 初始化CAnnotationManage对象。
  var annotationManage = CAnnotationManage.init(pdfListView: self.pdfListView!)

// 设置CAnnotationManage对象管理当前选中的注释。
annotationManage.setAnnotStyle(from: pdfListView.activeAnnotations)

// 设置CAnnotationManage对象管理默认的注释。
annotationManage.setAnnotStyle(from: pdfListView.annotationMode)

// 设置CAnnotationManage对象去修改当前选中的注释的属性。
annotationManage.refreshPage(with: annotStyle.annotations)

// CPDFAnnotationToolbar：初始化一个CAnnotationManage对象annotationManage。
// annotationManage：管理注释属性单独model数据。
let annotationBar = CPDFAnnotationToolBar.init(annotationManage: annotationManage)

// 初始化CAnnotationManage对象。
CAnnotationManage *annotationManage = [[CAnnotationManage alloc] initWithPDFView:pdfListView];

// 设置CAnnotationManage对象管理当前选中的注释。
[annotManage setAnnotStyleFromAnnotations:pdfListView.activeAnnotations];

// 设置CAnnotationManage对象管理默认的注释。
[annotManage setAnnotStyleFromMode:pdfListView.annotationMode];

// 设置CAnnotationManage对象去修改当前选中的注释的属性。
[annotManage refreshPageWithAnnotations:annotStyle.annotations];

// CPDFAnnotationToolbar：初始化一个CAnnotationManage对象annotationManage。
// annotationManage：管理注释属性单独model数据。
CPDFAnnotationToolbar *annotationToolbar = [[CPDFAnnotationToolbar alloc] initAnnotationManage:annotationManage];

func startObservingNotes(newNotes: [CPDFAnnotation]) {
        if self.notes == nil {
            self.notes = []
        }
        for note in newNotes {
            if self.notes?.contains(note) == false {
                self.notes?.append(note)
            }
            let keys: Set<String> = note.keysForValuesToObserveForUndo()
            for key in keys {
                note.addObserver(self, forKeyPath: key, options: [.new, .old], context: &CPDFAnnotationPropertiesObservationContext)
            }
 }

- (void)startObservingNotes:(NSArray *)newNotes {
    if (!self.notes) {
        self.notes = [NSMutableArray array];
    }
    for (CPDFAnnotation *note in newNotes) {
        if (![self.notes containsObject:note]) {
            [self.notes addObject:note];
        }
        for (NSString *key in [note keysForValuesToObserveForUndo]) {
            [note addObserver:self forKeyPath:key options:(NSKeyValueObservingOptionNew | NSKeyValueObservingOptionOld) context:&CPDFAnnotationPropertiesObservationContext];
        }
    }
}

注: 切换文档以及移除对应的注释或表单时，一定要留意移除注释属性的 KVO 监听。

下面的代码展示了如何撤消和重做注释和表单的编辑

 @objc func buttonItemClicked_undo(_ button: UIButton) {
         if self.annotManage?.pdfListView?.undoPDFManager != nil && ((self.annotManage?.pdfListView?.canUndo()) == true) {
             self.annotManage?.pdfListView?.undoPDFManager?.undo()
         }
     }
     
     @objc func buttonItemClicked_redo(_ button: UIButton) {
         if self.annotManage?.pdfListView?.undoPDFManager != nil && (self.annotManage?.pdfListView?.canRedo()) == true {
             self.annotManage?.pdfListView?.undoPDFManager?.redo()
         }
     }

- (void)buttonItemClicked_undo:(UIButton *)button {
    if(self.annotManage.pdfListView.undoPDFManager && [self.annotManage.pdfListView canUndo]) {
        [self.annotManage.pdfListView.undoPDFManager undo];
    }
}

- (void)buttonItemClicked_redo:(UIButton *)button {
    if(self.annotManage.pdfListView.undoPDFManager && [self.annotManage.pdfListView canRedo]) {
        [self.annotManage.pdfListView.undoPDFManager redo];
    }
}

4. 实现委托函数

   关于实现委托函数，请参考 “CPDFViewController” 文件中的以下方法.

 @optional
   
 // 上下文菜单选项。
     @objc optional func PDFListView(_ pdfListView: CPDFListView, customizeMenuItems menuItems: [UIMenuItem], forPage page: CPDFPage, forPagePoint pagePoint: CGPoint) -> [UIMenuItem]
 
 // 空白区域点击
     @objc optional func PDFListViewPerformTouchEnded(_ pdfListView: CPDFListView)
 
 // 功能模式切换。
     @objc optional func PDFListViewChangedToolMode(_ pdfListView: CPDFListView, forToolMode toolMode: Int)
 
 // 注释类型切换。
     @objc optional func PDFListViewChangedToolMode(_ pdfListView: CPDFListView, forToolMode toolMode: Int)
 
 // 选中注释发生变化
     @objc optional func PDFListViewChangeatioActiveAnnotations(_ pdfListView: CPDFListView, forActiveAnnotations annotations: [CPDFAnnotation])
 
 // 文档注释有发生变化。
     @objc optional func PDFListViewAnnotationsOperationChange(_ pdfListView: CPDFListView)
 
 // 编辑注释内容。
     @objc optional func PDFListViewEditNote(_ pdfListView: CPDFListView, forAnnotation annotation: CPDFAnnotation)
 
 // 修改注释属性。
     @objc optional func PDFListViewEditProperties(_ pdfListView: CPDFListView, forAnnotation annotation: CPDFAnnotation)
 
 // 取消音频添加。
     @objc optional func PDFListViewPerformPlay(_ pdfView: CPDFListView, forAnnotation annotation: CPDFSoundAnnotation)
 
 // 取消音频添加。
     @objc optional func PDFListViewPerformCancelMedia(_ pdfView: CPDFListView, atPoint point: CGPoint, forPage page: CPDFPage)
 
 // 音频是否正在录音
     @objc optional func PDFListViewPerformRecordMedia(_ pdfView: CPDFListView, atPoint point: CGPoint, forPage page: CPDFPage)
 
 // Sound annotations: If it's recording
     @objc optional func PDFListViewerTouchEndedIsAudioRecordMedia(_ pdfListView: CPDFListView) -> Bool
 
 // 添加图章注释。
     @objc optional func PDFListViewPerformAddStamp(_ pdfView: CPDFListView, atPoint point: CGPoint, forPage page: CPDFPage)
 
 // 添加图片。
     @objc optional func PDFListViewPerformAddImage(_ pdfView: CPDFListView, atPoint point: CGPoint, forPage page: CPDFPage)
 
 // 添加签名。
     @objc optional func PDFListViewPerformSignatureWidget(_ pdfView: CPDFListView, forAnnotation annotation: CPDFSignatureWidgetAnnotation)
 
 // 修改PDF文字属性。
     @objc optional func PDFListViewContentEditProperty(_ pdfListView: CPDFListView, point: CGPoint)

@optional
  
// 上下文菜单选项。
- (NSArray<UIMenuItem *> *)PDFListView:(CPDFListView *)pdfListView customizeMenuItems:(NSArray *)MenuItems forPage:(CPDFPage *)page forPagePoint:(CGPoint)pagePoint;

// 空白区域点击。
- (void)PDFListViewPerformTouchEnded:(CPDFListView *)pdfListView;

// 功能模式切换。
- (void)PDFListViewChangedToolMode:(CPDFListView *)pdfListView forToolMode:(CToolModel)toolMode;

// 注释类型切换。
- (void)PDFListViewChangedAnnotationType:(CPDFListView *)pdfListView forAnnotationMode:(CPDFViewAnnotationMode)annotationMode;

// 选中注释发生变化。
- (void)PDFListViewChangeatioActiveAnnotations:(CPDFListView *)pdfListView forActiveAnnotations:(NSArray<CPDFAnnotation *> *)annotations;

// 文档注释有发生变化。
- (void)PDFListViewAnnotationsOperationChange:(CPDFListView *)pdfListView;

// 编辑注释内容。
- (void)PDFListViewEditNote:(CPDFListView *)pdfListView forAnnotation:(CPDFAnnotation *)annotation;

// 修改注释属性。
- (void)PDFListViewEditProperties:(CPDFListView *)pdfListView forAnnotation:(CPDFAnnotation *)annotation;

// 播放音频注释。
- (void)PDFListViewPerformPlay:(CPDFListView *)pdfView forAnnotation:(CPDFSoundAnnotation *)annotation;

// 取消音频添加。
- (void)PDFListViewPerformCancelMedia:(CPDFListView *)pdfView atPoint:(CGPoint)point forPage:(CPDFPage *)page;

// 音频注释开始录音。
- (void)PDFListViewPerformRecordMedia:(CPDFListView *)pdfView atPoint:(CGPoint)point forPage:(CPDFPage *)page;

// 音频是否正在录音。
- (BOOL)PDFListViewerTouchEndedIsAudioRecordMedia:(CPDFListView *)pdfListView;

// 添加图章注释。
- (void)PDFListViewPerformAddStamp:(CPDFListView *)pdfView atPoint:(CGPoint)point forPage:(CPDFPage *)page;

// 添加图片注释。
- (void)PDFListViewPerformAddImage:(CPDFListView *)pdfView atPoint:(CGPoint)point forPage:(CPDFPage *)page;

// 添加签名。
- (void)PDFListViewPerformSignatureWidget:(CPDFListView *)pdfView forAnnotation:(CPDFSignatureWidgetAnnotation *)annotation;

// 修改PDF文字属性。
- (void)PDFListViewContentEditProperty:(CPDFListView *)pdfListView point:(CGPoint)point;

注： 如果需要切换或取消选择注释，需要调用CPDFListView::updateActiveAnnotations才能让CPDFListView::PDFListViewChangeatioActiveAnnotations: forActiveAnnotations:得到响应。

SwiftUI ​

自 iOS 版本 10.1 起，ComPDFKit 公开了特定的 API，以便开箱即用地将 ComPDFKit 与 SwiftUI 结合使用。CPDFViewController.swift这使得在 SwiftUI 应用程序中处理 ComPDFKit 变得更容易，并且如果您想走 SwiftUI 路线，它不需要您自己包装。

1. 导入资源文件，ComPDFKit_Tools iOS样例项目自带默认UI设计，包括应用程序的基本UI和功能模块UI，使用ComPDFKit PDF SDK实现，并已发布。还包括一个 CPDFViewController 视图控制器，它包含随时可用的UI模块实现。

   

2. 通过将PDF文档拖放到项目中，将它们添加到应用程序中。在显示的对话框中，选择Finish以接受默认的集成选项。您可以使用TestFile文件夹中的文档作为示例。

3. 桥接CPDFSwiftViewController到SwiftUI

   首先，声明' CPDFSwiftViewController '结构-它符合' UIViewControllerRepresentable'协议-这样你就可以从UIKit桥接到SwiftUI。

   swift

   struct CPDFSwiftViewController: UIViewControllerRepresentable {
       @Environment(\.presentationMode) var presentationMode: Binding<PresentationMode>
   
       class Coordinator: NSObject,CPDFViewBaseControllerDelete {
           var myview: CPDFSwiftViewController
           init(_ myview: CPDFSwiftViewController) {
               self.myview = myview
           }
           
           // MARK: - CPDFViewBaseControllerDelete
           func PDFViewBaseControllerDissmiss(_ baseControllerDelete: CPDFViewBaseController) {
               baseControllerDelete.dismiss(animated: true)
           }
               
       }
       
       func makeCoordinator() -> Coordinator {
           Coordinator(self)
       }
       
       func makeUIViewController(context: Context) -> CNavigationController {
           
           CPDFKit.setLicenseKey("", secret: "")
   				
           let filePath = Bundle.main.path(forResource: "developer_guide_ios", ofType: "pdf")
           let documentFolder = NSHomeDirectory().appending("/Documents/Samples")
   
           if !FileManager.default.fileExists(atPath: documentFolder) {
               try? FileManager.default.createDirectory(atPath: documentFolder, withIntermediateDirectories: true, attributes: nil)
           }
           
   
           let documentURL = URL(fileURLWithPath: documentFolder).appendingPathComponent((filePath as NSString?)?.lastPathComponent ?? "")
           
           if !FileManager.default.fileExists(atPath: documentURL.path) {
               try? FileManager.default.copyItem(at: URL(fileURLWithPath: filePath ?? ""), to: documentURL)
           }
           
           let configuration = CPDFConfiguration()
             
           let thumbnail = CNavBarButtonItem(viewLeftBarButtonItem: .thumbnail)
           let back = CNavBarButtonItem(viewLeftBarButtonItem: .back)
           let search = CNavBarButtonItem(viewRightBarButtonItem: .search)
           let bota = CNavBarButtonItem(viewRightBarButtonItem: .bota)
           let more = CNavBarButtonItem(viewRightBarButtonItem: .more)
   
           configuration.showleftItems = [back, thumbnail]
           configuration.showRightItems = [search, bota, more]
   
   
           let vc = CPDFViewController(filePath: documentURL.path, password: nil, configuration: configuration)
           vc.delegate = context.coordinator;
           let navController = CNavigationController(rootViewController: vc)
   
           return navController
       }
       
       func updateUIViewController(_ uiViewController: CNavigationController, context: UIViewControllerRepresentableContext<CPDFSwiftViewController>) {
           // Update the view controller.
       }
   }

   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   14
   15
   16
   17
   18
   19
   20
   21
   22
   23
   24
   25
   26
   27
   28
   29
   30
   31
   32
   33
   34
   35
   36
   37
   38
   39
   40
   41
   42
   43
   44
   45
   46
   47
   48
   49
   50
   51
   52
   53
   54
   55
   56
   57
   58
   59
   60
   61
   

4. 在SwiftUI中使用CPDFSwiftViewController

   最后，在你的SwiftUI内容视图中使用'CPDFSwiftViewController :

   swift

   struct ContentView: View {
       @State var isPresented: Bool = false
   
       var body: some View {
           VStack {
               Image(systemName: "globe")
                   .imageScale(.large)
                   .foregroundColor(.accentColor)
               Text("Hello, world!")
               
                   .toolbar {
                       
                       ToolbarItem(placement: .bottomBar) {
                           Button("Click to open the sample PDF") {
                               isPresented = true
                           }
                       }
                   }
                   .sheet(isPresented: $isPresented) {
                       CPDFSwiftViewController()
                   }
               
           }
           .padding()
       }
   }
   
   struct ContentView_Previews: PreviewProvider {
       static var previews: some View {
           ContentView()
       }
   }

   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   14
   15
   16
   17
   18
   19
   20
   21
   22
   23
   24
   25
   26
   27
   28
   29
   30
   31
   32
   

了解更多 ​

1. 如何处理 PDF 文件加载

   要处理 PDF 文档加载，请参考***“CPDFViewBaseController.m”***文件中的以下方法。

   objective-c

   - (void)reloadDocumentWithFilePath:(NSString *)filePath password:(nullable NSString *)password completion:(void (^)(BOOL result))completion;

   1
   

2. 为了保护用户隐私，在访问设备数据之前，你需要在你的 iOS 10.0 或更高版本的 iOS 设备中找到 ”Info“ 配置，并按照下图所示配置相关的设置。

<key>NSCameraUsageDescription</key>
<string>Your consent is required before you could access the function.</string>

<key>NSMicrophoneUsageDescription</key>
<string>Your consent is required before you could access the function.</string>

<key>NSPhotoLibraryAddUsageDescription</key>
<string>Your consent is required before you could access the function.</string>

<key>NSPhotoLibraryUsageDescription</key>
<string>Your consent is required before you could access the function.</string>