java.lang.Object |
↳ |
com.pdftron.pdf.Redactor |
Class Overview
PDF Redactor is a separately licensable Add-on that offers options to remove
(not just covering or obscuring) content within a region of PDF.
With printed pages, redaction involves blacking-out or cutting-out areas of
the printed page. With electronic documents that use formats such as PDF,
redaction typically involves removing sensitive content within documents for
safe distribution to courts, patent and government institutions, the media,
customers, vendors or any other audience with restricted access to the content.
The redaction process in PDFNet consists of two steps:
- Content identification: A user applies redact annotations that specify the
pieces or regions of content that should be removed. The content for redaction
can be identified either interactively (e.g. using 'pdftron.PDF.PDFViewCtrl'
as shown in PDFView sample) or programmatically (e.g. using 'pdftron.PDF.TextSearch'
or 'pdftron.PDF.TextExtractor'). Up until the next step is performed, the user
can see, move and redefine these annotations.
- Content removal: Using 'pdftron.PDF.Redactor.Redact()' the user instructs
PDFNet to apply the redact regions, after which the content in the area specified
by the redact annotations is removed. The redaction function includes number of
options to control the style of the redaction overlay (including color, text,
font, border, transparency, etc.).
PDFTron Redactor makes sure that if a portion of an image, text, or vector graphics
is contained in a redaction region, that portion of the image or path data is
destroyed and is not simply hidden with clipping or image masks. PDFNet API can also
be used to review and remove metadata and other content that can exist in a PDF
document, including XML Forms Architecture (XFA) content and Extensible Metadata
Platform (XMP) content.
Summary
Public Methods |
static
void
|
redact(Doc doc, Redaction[] red_arr, Redactor.Appearance app, boolean ext_neg_mode, boolean page_coord_sys)
Apply the redactions specified in red_array to the PDFDoc doc.
|
[Expand]
Inherited Methods |
From class
java.lang.Object
boolean
|
equals(Object arg0)
|
final
Class<?>
|
getClass()
|
int
|
hashCode()
|
final
void
|
notify()
|
final
void
|
notifyAll()
|
String
|
toString()
|
final
void
|
wait(long arg0, int arg1)
|
final
void
|
wait(long arg0)
|
final
void
|
wait()
|
|
Public Constructors
Public Methods
public
static
void
redact
(Doc doc, Redaction[] red_arr, Redactor.Appearance app, boolean ext_neg_mode, boolean page_coord_sys)
Apply the redactions specified in red_array to the PDFDoc doc.
Parameters
doc |
- the document to redact |
red_arr |
- an array of redaction regions. |
app |
- optional parameter used to customize the appearance of the redaction overlay. |
ext_neg_mode |
- if true, negative redactions expand beyond the page to remove
content from other pages in the document. if false, the redaction will be localized
to the given page. |
page_coord_sys |
- if true, redaction coordinates are relative to the lower-left corner of the page,
otherwise the redaction coordinates are defined in PDF user coordinate system (which may or may not coincide with
page coordinates).
|