类 com.foxit.sdk.addon.Redaction 继承关系图:

Public 成员函数
	Redaction (PDFDoc document) throws com.foxit.sdk.PDFException
	构造函数，从 PDF 文档对象构造。更多...

	Redaction (Redaction other)
	构造函数，使用另一个保护密文对象。更多...

boolean	apply () throws com.foxit.sdk.PDFException
	在标记区域应用保护密文：永久删除标记区域下的文本或图形。更多...

synchronized void	delete ()
	直接清除C++相关资源。更多...

void	enableFileStream (String temp_directory_path, ApplyRedactionCallback apply_redaction_callback) throws com.foxit.sdk.PDFException
	在应用过程中为图像对象启用文件流。更多...

boolean	isEmpty ()
	检查当前对象是否为空。更多...

Redact	markRedactAnnot (PDFPage page, RectFArray rects) throws com.foxit.sdk.PDFException
	标记要进行保护密文处理的页面内容（文本对象、图像对象和路径对象）。更多...

Progressive	startApply (PauseCallback pause) throws com.foxit.sdk.PDFException
	开始在标记区域应用保护密文：永久删除标记区域下的文本或图形。更多...

Public 成员函数继承自 com.foxit.sdk.common.Base
synchronized void	delete ()
	直接清除C++相关资源。更多...

详细描述

保护密文 PDF 文件允许用户隐藏敏感信息，同时保持文档的格式。此类可用于使用保护密文注释标记页面内容，并应用保护密文以永久删除（保护密文）PDF 文档中的可见文本和图像，以保护机密信息如社会保险号。

参见: com.foxit.sdk.pdf.annots.Redact

构造及析构函数说明

◆ Redaction() [1/2]

com.foxit.sdk.addon.Redaction.Redaction ( PDFDoc document ) throws com.foxit.sdk.PDFException

构造函数，从 PDF 文档对象构造。

参数

[in] document 有效的 PDF 文档对象。

注解: 如果在函数 common.Library.initialize 中使用的许可证信息中未定义"Redaction"模块，这意味着用户无权使用保护密文相关功能，此构造函数将抛出异常 com.foxit.sdk.common.Constants.e_ErrNoRedactionModuleRight 。

◆ Redaction() [2/2]

com.foxit.sdk.addon.Redaction.Redaction ( Redaction other )

构造函数，使用另一个保护密文对象。

参数

[in] other 另一个保护密文对象。

成员函数说明

◆ apply()

boolean com.foxit.sdk.addon.Redaction.apply ( ) throws com.foxit.sdk.PDFException

在标记区域应用保护密文：永久删除标记区域下的文本或图形。

一旦调用此函数，文档中所有标记的页面内容（文本对象、图像对象和路径对象）将被永久删除。指定标记区域的所有保护密文注释将被删除（连同它们的弹出注释），这些标记区域将被 pdf.annots.Redact.setApplyFillColor 指定的颜色填充。

返回: true 表示成功，false 表示失败。

◆ delete()

synchronized void com.foxit.sdk.addon.Redaction.delete ( )

直接清除C++相关资源。

返回: 无。

注解: 一旦这个接口被调用，这个对象将不能再被使用。

◆ enableFileStream()

void com.foxit.sdk.addon.Redaction.enableFileStream	(	String	temp_directory_path,
		ApplyRedactionCallback	apply_redaction_callback
	)		throws com.foxit.sdk.PDFException

在应用过程中为图像对象启用文件流。

一旦调用此函数，图像对象流将被写入 temp_directory_path 中指定目录的临时文件。临时文件必须在销毁文档之前保留，并将在销毁文档期间自动删除。

参数

临时目录路径。如果为空，临时目录将默认为当前路径。
这个回调通过实现	class com.foxit.sdk.addon.ApplyRedactionCallback 来应用密文。

返回: 无。

◆ isEmpty()

boolean com.foxit.sdk.addon.Redaction.isEmpty ( )

检查当前对象是否为空。

当前对象为空时，表示当前对象无用。

返回: true 表示当前对象为空，false 表示不为空。

◆ markRedactAnnot()

Redact com.foxit.sdk.addon.Redaction.markRedactAnnot	(	PDFPage	page,
		RectFArray	rects
	)		throws com.foxit.sdk.PDFException

标记要进行保护密文处理的页面内容（文本对象、图像对象和路径对象）。

此函数用于在指定的矩形区域添加特殊标记（称为保护密文注释），以便对这些区域中的页面内容进行保护密文处理。通常，标记区域有两种外观：

正常外观，当标记区域未与用户交互时使用。边框颜色（也称为描边颜色）可以通过 pdf.annots.Annot.setBorderColor 设置。填充颜色可以通过 pdf.annots.Redact.setFillColor 设置。不透明度可以通过 pdf.annots.Markup.setOpacity 设置。
滚动外观，当用户将光标移入标记区域而不按下鼠标按钮时使用。边框颜色和填充颜色相同，可以通过 pdf.annots.Redact.setApplyFillColor 设置。

一旦调用函数 Redaction.apply ，这些标记区域下的所有页面内容将被永久删除，这些标记区域将始终保持其滚动外观。

参数

[in]	page	要标记其内容的 PDF 页面。
[in]	rects	指定页面中要标记的区域。它不应该是空数组。所有输入的矩形将被视为一个保护密文注释。

返回: 保护密文注释对象（默认情况下还有一个弹出注释），具有默认外观：
应用填充颜色 = 黑色，边框颜色 = 红色，不透明度 = 1.0。

◆ startApply()

Progressive com.foxit.sdk.addon.Redaction.startApply ( PauseCallback pause ) throws com.foxit.sdk.PDFException

开始在标记区域应用保护密文：永久删除标记区域下的文本或图形。

此函数类似于函数 Redaction.apply ，但此函数将返回一个渐进对象，可用于逐步执行保护密文处理。

参数

[in] pause 决定应用过程是否应暂停的回调对象。这可以是 null，表示在应用过程中不暂停。如果不是 null，它应该是用户实现的有效暂停对象。默认值：null。

返回: 渐进对象。请通过函数 common.Progressive.getRateOfProgress 检查当前进度的速率。如果速率尚未达到 100，请调用函数 common.Progressive.resume 继续进度，直到进度完成。

Public 成员函数

详细描述

构造及析构函数说明

◆ Redaction() [1/2]

◆ Redaction() [2/2]

成员函数说明

◆ apply()

◆ delete()

◆ enableFileStream()

◆ isEmpty()

◆ markRedactAnnot()

◆ startApply()