Skip to content
Demo示例FAQ

PDF 生成模板编辑器

开源可视化 PDF 生成引擎,支持自定义模板,并提供面向开发者的 API,灵活构建文档生成流程。

查看 GitHub
Android Guides Content comparison

内容比较 ​

通过基准文档的 createCompare(comparedDocument) 创建比较对象,再调用 doCompare() 比较指定的页面组合。以下示例中的两个文档均已成功打开,且各自至少有一页。

比较页面 ​

java
import com.compdfkit.core.compare.CPDFCompare;
import com.compdfkit.core.compare.CPDFCompareResults;
import com.compdfkit.core.compare.CPDFCompareResult;

CPDFCompare compare = baseDocument.createCompare(comparedDocument);
if (compare != null) {
    try {
        CPDFCompareResults results = compare.doCompare(
            0, 0, CPDFCompare.CompType.ONLY_TEXT, false);
        if (results != null) {
            for (CPDFCompareResult difference : results.getTextResults()) {
                // difference.getResultTypeEnum():差异类型。
                // difference.oldRect、compRect:两侧 PDF 页面坐标中的位置。
            }
            int inserted = results.getInsertCount();
            int deleted = results.getDeleteCount();
            int replaced = results.getReplaceCount();
        } else {
            // 比较失败,不能按“没有差异”处理。
        }
    } finally {
        compare.close();
    }
}

比较对象关闭后,源文档仍由调用方管理。不要在比较过程中关闭任一源文档。

选择比较内容 ​

CompType内容
ONLY_TEXT文本
ONLY_IMAGE图片
ONLY_ANNOT注释
ONLY_PATH矢量路径
ONLY_SHADING渐变
COMPARE_ALL文本、图片与注释,不包含路径和渐变

多种类型使用位或组合;需要全部类型时使用 CompType.everything():

java
int targets = CPDFCompare.CompType.ONLY_TEXT.getId()
    | CPDFCompare.CompType.ONLY_IMAGE.getId();
CPDFCompareResults results = compare.doCompare(0, 0, targets, false);

类型掩码不能为 0。页索引应位于对应文档范围内;跨文档的页码对应关系由应用确定。

读取结果 ​

通过 getTextResults()、getImageResults()、getAnnotResults()、getPathResults() 和 getShadingResults() 分别读取差异。isEmpty() 表示本次所选比较类型没有差异。

差异项包含类型、基准页索引 oldPageIndex、比较页索引 compPageIndex 及两侧矩形。矩形采用 PDF 页面坐标,原点在页面左下角;新增或删除内容在其中一侧可能没有有效矩形,显示前需检查。

getInsertCount()、getDeleteCount() 等统计来自比较结果,不应以列表长度代替。一处替换可能产生分别对应两侧的差异项。比较对象上的 getTotal*Count() 则用于读取会话累计统计。

导出标记结果 ​

将 drawHighlight 设为 true,再通过 generateNewDoc() 输出结果:

java
CPDFCompare compare = baseDocument.createCompare(comparedDocument);
if (compare != null) {
    try {
        compare.setInsertResColor(android.graphics.Color.BLUE);
        compare.setDeleteResColor(android.graphics.Color.RED);
        CPDFCompareResults results = compare.doCompare(
            0, 0, CPDFCompare.CompType.everything(), true);
        if (results != null) {
            boolean saved = compare.generateNewDoc(outputPath);
            // 根据 saved 处理输出结果。
        }
    } finally {
        compare.close();
    }
}

先创建输出目录,并使用独立输出路径。drawHighlight = true 会向源文档的内存页面写入标记,两份文档都会被标记为已修改,即使比较失败或没有发现差异也可能如此。需要保留当前编辑会话时,建议另外打开用于比较的文档实例。