Use Tree Navigation
public class

Redaction

extends Markup
java.lang.Object
   ↳ com.pdftron.pdf.Annot
     ↳ com.pdftron.pdf.annots.Markup
       ↳ com.pdftron.pdf.annots.Redaction

Class Overview

A redaction annotation (PDF 1.7) identifies content that is intended to be removed from the document. The intent of redaction annotations is to enable the following process: a)Content identification. A user applies redact annotations that specify the pieces or regions of content that should be removed. Up until the next step is performed, the user can see, move and redefine these annotations. b)Content removal. The user instructs the viewer application to apply the redact annotations, after which the content in the area specified by the redact annotations is removed. In the removed content's place, some marking appears to indicate the area has been redacted. Also, the redact annotations are removed from the PDF document. Redaction annotations provide a mechanism for the first step in the redaction process (content identification). This allows content to be marked for redaction in a non-destructive way, thus enabling a review process for evaluating potential redactions prior to removing the specified content. Redaction annotations shall provide enough information to be used in the second phase of the redaction process (content removal). This phase is application-specific and requires the conforming reader to remove all content identified by the redaction annotation, as well as the annotation itself. Conforming readers that support redaction annotations shall provide a mechanism for applying content removal, and they shall remove all traces of the specified content. If a portion of an image is contained in a redaction region, that portion of the image data shall be destroyed; clipping or image masks shall not be used to hide that data. Such conforming readers shall also be diligent in their consideration of all content that can exist in a PDF document, including XML Forms Architecture (XFA) content and Extensible Metadata Platform (XMP) content.

Summary

Constants
int e_Centered The Constant e_Centered.
int e_LeftJustified This integer list represents the Quad Format of the Redaction annotation e_LeftJustified - Overlay text is left justified e_Centered - Overlay text is centered e_RightJustified - Overlay text is right justified e_None - No justification to the overlay text.
int e_None The Constant e_None.
int e_RightJustified The Constant e_RightJustified.
[Expand]
Inherited Constants
From class com.pdftron.pdf.annots.Markup
From class com.pdftron.pdf.Annot
Public Constructors
Redaction(Obj d)
Creates an Redaction annotation and initialize it using given Cos/SDF object.
Redaction()
Creates an empty Redaction annotation.
Redaction(Annot annot)
Creates an Redaction annotation and initialize it using given annotation object.
Public Methods
static Redaction create(Doc doc, Rect pos)
Creates a new Redaction annotation, in the specified document.
Obj getAppFormXO()
Get Overlay appearance of the Redaction annotation.
String getOverlayText()
Get Overlay text of the Redaction annotation.
String getOverlayTextAppearance()
Get Overlay text appearance of the Redaction annotation.
int getQuadForm()
Get Overlay text quadding(justification) format of the Redaction annotation.
QuadPoint getQuadPoint(int idx)
Get the QuadPoint located at a certain index of the QuadPoint array of the Redaction annotation.
int getQuadPointCount()
Get the number of QuadPoints in the QuadPoints array of the Redaction annotation.
boolean getUseRepeat()
Get the option of whether to use repeat for the Redaction annotation.
void setAppFormXO(Obj formxo)
Set Overlay appearance of the Redaction annotation.
void setOverlayText(String title)
Set Overlay text of the Redaction annotation.
void setOverlayTextAppearance(String app)
Set Overlay text appearance of the Redaction annotation.
void setQuadForm(int form)
Set Overlay text quadding(justification) format of the Redaction annotation.
void setQuadPoint(int idx, QuadPoint qp)
Set the QuadPoint to be located at a certain index of the QuadPoint array of the Redaction annotation.
void setUseRepeat(boolean repeat)
Set the option of whether to use repeat for the Redaction annotation.
[Expand]
Inherited Methods
From class com.pdftron.pdf.annots.Markup
From class com.pdftron.pdf.Annot
From class java.lang.Object

Constants

public static final int e_Centered

The Constant e_Centered.

Constant Value: 1 (0x00000001)

public static final int e_LeftJustified

This integer list represents the Quad Format of the Redaction annotation e_LeftJustified - Overlay text is left justified e_Centered - Overlay text is centered e_RightJustified - Overlay text is right justified e_None - No justification to the overlay text.

Constant Value: 0 (0x00000000)

public static final int e_None

The Constant e_None.

Constant Value: 3 (0x00000003)

public static final int e_RightJustified

The Constant e_RightJustified.

Constant Value: 2 (0x00000002)

Public Constructors

public Redaction (Obj d)

Creates an Redaction annotation and initialize it using given Cos/SDF object.

Note: The constructor does not copy any data, but is instead the logical equivalent of a type cast.

Parameters
d the input Cos/SDF object

public Redaction ()

Creates an empty Redaction annotation.

public Redaction (Annot annot)

Creates an Redaction annotation and initialize it using given annotation object.

Note: The constructor does not copy any data, but is instead the logical equivalent of a type cast.

Parameters
annot the annot

Public Methods

public static Redaction create (Doc doc, Rect pos)

Creates a new Redaction annotation, in the specified document.

Parameters
doc A document to which the annotation is added.
pos A rectangle specifying the annotation's bounds, specified in user space coordinates.
Returns
  • A newly created blank Circle annotation.

public Obj getAppFormXO ()

Get Overlay appearance of the Redaction annotation.

Note: This overlay overlay appearance object is a form XObject specifying the overlay appearance for this redaction annotation. After this redaction is applied and the affected content has been removed, the overlay appearance should be drawn such that its origin lines up with the lower-left corner of the annotation rectangle. This form XObject is not necessarily related to other annotation appearances, and may or may not be present in the Appearance dictionary. This entry takes precedence over the Interior Color(IC), OverlayText, OverlayTextAppearance(DA), and QuadPoint(Q) entries.

Returns
  • An SDF object that represents the overlay overlay appearance of the Redaction annotation.

public String getOverlayText ()

Get Overlay text of the Redaction annotation.

Note: The OverlayText string is a text string specifying the overlay text that should be drawn over the redacted region after the affected content has been removed. This entry is ignored if the Overlay appearance(RO) entry is present.

Returns
  • A string containing the overlay text of the annotation.

public String getOverlayTextAppearance ()

Get Overlay text appearance of the Redaction annotation.

Note: The overlay text appearance is the appearance string to be used in formatting the overlay text when it is drawn after the affected content has been removed. This entry is ignored if the Overlay appearance strint(RO) entry is present.

Returns
  • A string containing the overlay text appearance of the annotation.

public int getQuadForm ()

Get Overlay text quadding(justification) format of the Redaction annotation.

Note: quadding format specifies the form of quadding (justification) to be used in laying out the overlay

Returns
  • An entry of the "QuadForm" enum, indicating the overlay text quadding(justification) format of the Redaction annotation .

public QuadPoint getQuadPoint (int idx)

Get the QuadPoint located at a certain index of the QuadPoint array of the Redaction annotation.

Note: An array of n QuadPoints specifying If present, these quadrilaterals denote the content region that is intended to be removed. If this entry is not present, the Rect entry denotes the content region that is intended to be removed

Parameters
idx The index of where the QuadPoint of interest is located.
Returns
  • The QuadPoint located at a certain index of the QuadPoint array of the Redaction annotation.

public int getQuadPointCount ()

Get the number of QuadPoints in the QuadPoints array of the Redaction annotation.

Note: An array of n QuadPoints specifying If present, these quadrilaterals denote the content region that is intended to be removed. If this entry is not present, the Rect entry denotes the content region that is intended to be removed

Returns
  • The number of QuadPoints.

public boolean getUseRepeat ()

Get the option of whether to use repeat for the Redaction annotation.

Note: If UseRepeat value is true, then the text specified by OverlayText should be repeated to fill the redacted region after the affected content has been removed. This entry is ignored if the RO entry is present. Default value: false.

Returns
  • A bool indicating whether to repeat for the Redaction annotation.

public void setAppFormXO (Obj formxo)

Set Overlay appearance of the Redaction annotation. (Optional)

Note: This overlay appearance object is a form XObject specifying the overlay appearance for this redaction annotation. After this redaction is applied and the affected content has been removed, the overlay appearance should be drawn such that its origin lines up with the lower-left corner of the annotation rectangle. This form XObject is not necessarily related to other annotation appearances, and may or may not be present in the Appearance dictionary. This entry takes precedence over the Interior Color(IC), OverlayText, OverlayTextAppearance(DA), and QuadPoint(Q) entries.

Parameters
formxo An SDF object that represents the overlay appearance of the Redaction annotation.

public void setOverlayText (String title)

Set Overlay text of the Redaction annotation.

Note: The OverlayText string is a text string specifying the overlay text that should be drawn over the redacted region after the affected content has been removed. This entry is ignored if the Overlay appearance(RO) entry is present.

Parameters
title A string containing the overlay text of the annotation.

public void setOverlayTextAppearance (String app)

Set Overlay text appearance of the Redaction annotation.

Note: The overlay text appearance is the appearance string to be used in formatting the overlay text when it is drawn after the affected content has been removed. This entry is ignored if the Overlay appearance strint(RO) entry is present.

Parameters
app A string containing the overlay text appearance of the annotation.

public void setQuadForm (int form)

Set Overlay text quadding(justification) format of the Redaction annotation.

Note: Quadding format specifies the form of quadding (justification) to be used in laying out the overlay

Parameters
form An entry of the "QuadForm" enum, indicating the overlay text quadding(justification) format of the Redaction annotation .

public void setQuadPoint (int idx, QuadPoint qp)

Set the QuadPoint to be located at a certain index of the QuadPoint array of the Redaction annotation. (Optional; PDF 1.6 )

Note: An array of n QuadPoints specifying the coordinates of n quadrilaterals in default user space that comprise the region in which the link should be activated. The coordinates specifying the four vertices of the quadrilateral in counterclockwise order. For orientation purposes, such as when applying an underline border style, the bottom of a quadrilateral is the line formed by p1 and p2 of the QuadPoint. QuadPoints shall be ignored if any coordinate in the array lies outside the region specified by Rect.

Parameters
idx The index position where the QuadPoint of interest is to be inserted.
qp The QuadPoint to be inserted at that position.

public void setUseRepeat (boolean repeat)

Set the option of whether to use repeat for the Redaction annotation.

Note: If UseRepeat value is true, then the text specified by OverlayText should be repeated to fill the redacted region after the affected content has been removed. This entry is ignored if the RO entry is present. Default value: false.

Parameters
repeat the new use repeat