Package com.datalogics.PDFL

Class Redaction

java.lang.Object

com.datalogics.PDFL.Annotation

com.datalogics.PDFL.Redaction

public class Redaction
extends Annotation

Associates an object with its location on a page of a PDF document. A redaction occludes some part of a document.

Constructor Summary

Constructors

Constructor	Description
Redaction(Page page, List<Quad> regions)	Create a new Redaction annotation object with extended options.
Redaction(Page page, List<Quad> regions, Color internalColor)	Create a new Redaction annotation object with extended options.
Redaction(Page page, List<Quad> regions, Color internalColor, boolean fillRedacted)	Create a new Redaction annotation object with extended options.
Redaction(Page page, List<Quad> regions, Color internalColor, boolean fillRedacted, boolean drawBorder)	Create a new Redaction annotation object with extended options.
Redaction(Page page, List<Quad> regions, Color internalColor, boolean fillRedacted, boolean drawBorder, Color borderColor)	Create a new Redaction annotation object with extended options.
Redaction(Page page, List<Quad> regions, Color internalColor, boolean fillRedacted, boolean drawBorder, Color borderColor, boolean fillNormal)	Create a new Redaction annotation object with extended options.
Redaction(Page page, List<Quad> regions, Color internalColor, boolean fillRedacted, boolean drawBorder, Color borderColor, boolean fillNormal, Color fillColor)	Create a new Redaction annotation object with extended options.
Redaction(Page page, List<Quad> regions, Color internalColor, boolean fillRedacted, boolean drawBorder, Color borderColor, boolean fillNormal, Color fillColor, double fillOpacity)	Create a new Redaction annotation object with extended options.
Redaction(Page page, List<Quad> regions, Color internalColor, boolean fillRedacted, boolean drawBorder, Color borderColor, boolean fillNormal, Color fillColor, double fillOpacity, String overlayText)	Create a new Redaction annotation object with extended options.
Redaction(Page page, List<Quad> regions, Color internalColor, boolean fillRedacted, boolean drawBorder, Color borderColor, boolean fillNormal, Color fillColor, double fillOpacity, String overlayText, Color textColor)	Create a new Redaction annotation object with extended options.
Redaction(Page page, List<Quad> regions, Color internalColor, boolean fillRedacted, boolean drawBorder, Color borderColor, boolean fillNormal, Color fillColor, double fillOpacity, String overlayText, Color textColor, String fontName)	Create a new Redaction annotation object with extended options.
Redaction(Page page, List<Quad> regions, Color internalColor, boolean fillRedacted, boolean drawBorder, Color borderColor, boolean fillNormal, Color fillColor, double fillOpacity, String overlayText, Color textColor, String fontName, double textSize)	Create a new Redaction annotation object with extended options.
Redaction(Page page, List<Quad> regions, Color internalColor, boolean fillRedacted, boolean drawBorder, Color borderColor, boolean fillNormal, Color fillColor, double fillOpacity, String overlayText, Color textColor, String fontName, double textSize, boolean repeat)	Create a new Redaction annotation object with extended options.
Redaction(Page page, List<Quad> regions, Color internalColor, boolean fillRedacted, boolean drawBorder, Color borderColor, boolean fillNormal, Color fillColor, double fillOpacity, String overlayText, Color textColor, String fontName, double textSize, boolean repeat, boolean scaleToFit)	Create a new Redaction annotation object with extended options.
Redaction(Page page, List<Quad> regions, Font font)	Create a new Redaction annotation object with extended options .When Overlay Text is used, font is provided as a font.
Redaction(Page page, List<Quad> regions, Font font, Color internalColor)	Create a new Redaction annotation object with extended options .When Overlay Text is used, font is provided as a font.
Redaction(Page page, List<Quad> regions, Font font, Color internalColor, boolean fillRedacted)	Create a new Redaction annotation object with extended options .When Overlay Text is used, font is provided as a font.
Redaction(Page page, List<Quad> regions, Font font, Color internalColor, boolean fillRedacted, boolean drawBorder)	Create a new Redaction annotation object with extended options .When Overlay Text is used, font is provided as a font.
Redaction(Page page, List<Quad> regions, Font font, Color internalColor, boolean fillRedacted, boolean drawBorder, Color borderColor)	Create a new Redaction annotation object with extended options .When Overlay Text is used, font is provided as a font.
Redaction(Page page, List<Quad> regions, Font font, Color internalColor, boolean fillRedacted, boolean drawBorder, Color borderColor, boolean fillNormal)	Create a new Redaction annotation object with extended options .When Overlay Text is used, font is provided as a font.
Redaction(Page page, List<Quad> regions, Font font, Color internalColor, boolean fillRedacted, boolean drawBorder, Color borderColor, boolean fillNormal, Color fillColor)	Create a new Redaction annotation object with extended options .When Overlay Text is used, font is provided as a font.
Redaction(Page page, List<Quad> regions, Font font, Color internalColor, boolean fillRedacted, boolean drawBorder, Color borderColor, boolean fillNormal, Color fillColor, double fillOpacity)	Create a new Redaction annotation object with extended options .When Overlay Text is used, font is provided as a font.
Redaction(Page page, List<Quad> regions, Font font, Color internalColor, boolean fillRedacted, boolean drawBorder, Color borderColor, boolean fillNormal, Color fillColor, double fillOpacity, String overlayText)	Create a new Redaction annotation object with extended options .When Overlay Text is used, font is provided as a font.
Redaction(Page page, List<Quad> regions, Font font, Color internalColor, boolean fillRedacted, boolean drawBorder, Color borderColor, boolean fillNormal, Color fillColor, double fillOpacity, String overlayText, Color textColor)	Create a new Redaction annotation object with extended options .When Overlay Text is used, font is provided as a font.
Redaction(Page page, List<Quad> regions, Font font, Color internalColor, boolean fillRedacted, boolean drawBorder, Color borderColor, boolean fillNormal, Color fillColor, double fillOpacity, String overlayText, Color textColor, double textSize)	Create a new Redaction annotation object with extended options .When Overlay Text is used, font is provided as a font.
Redaction(Page page, List<Quad> regions, Font font, Color internalColor, boolean fillRedacted, boolean drawBorder, Color borderColor, boolean fillNormal, Color fillColor, double fillOpacity, String overlayText, Color textColor, double textSize, boolean repeat)	Create a new Redaction annotation object with extended options .When Overlay Text is used, font is provided as a font.
Redaction(Page page, List<Quad> regions, Font font, Color internalColor, boolean fillRedacted, boolean drawBorder, Color borderColor, boolean fillNormal, Color fillColor, double fillOpacity, String overlayText, Color textColor, double textSize, boolean repeat, boolean scaleToFit)	Create a new Redaction annotation object with extended options .When Overlay Text is used, font is provided as a font.

Method Summary

Modifier and Type	Method	Description
void	delete()
HorizontalAlignment	getAlign()	Get the horizontal alignment for the redaction text.
double	getAnnotationFeatureLevel()	Get the minimum PDF version necessary to support the features used in this annotation.
Color	getBorderColor()	Get the color used as the "normal" border.
boolean	getDrawBorder()	Get Draw Border option
Color	getFillColor()	Get the color used to fill the "normal" appearance area.
boolean	getFillNormal()	Get Fill Normal Appearance option
double	getFillOpacity()	Get the opacity applied to the fill color in "normal" appearance.
boolean	getFillRedacted()	Get Fill Redacted Appearance option
String	getFontFace()	Get Font face for the text
double	getFontSize()	Get font size for the text;
Color	getInternalColor()	Get the color used as the replacement background.
String	getNote()	Get the text string to be used as the Popup contents
Font	getOverlayFont()	Get Overlay Text Font
String	getOverlayText()	Get the optional overlay text of the redaction.
int	getPageNo()	Get the page number where the redaction occurs.
List<Quad>	getQuads()	A list of quads to mark.
boolean	getRepeat()	Get the repeat value
boolean	getScaleToFit()	Get the ScaleToFit value
Color	getTextColor()	Get the color used for the overlay text.
void	setAlign(HorizontalAlignment halign)	Sets the horizontal alignment for the redaction text.
void	setAnnotationFeatureLevel(double featureLevel)	Removes features not supported in the supplied version number.
void	setBorderColor(Color col)	Set the color used as the "normal" border.
void	setDrawBorder(boolean Option)	Set Draw Border option
void	setFillColor(Color col, double opacity)	Set the color used to fill the "normal" appearance.
void	setFillNormal(boolean Option)	Set Fill Normal Appearance option
void	setFillRedacted(boolean Option)	Set Fill Redacted Appearance option
void	setFontFace(String fontName)	Set Font face for the text
void	setFontSize(double fontsize)	Set font size for text
void	setInternalColor(Color col)	Set the color used as the replacement background.
void	setNote(String notetext)	Set the text string to be used as the Popup Contents
void	setOverlayFont(Font font)	Set Overlay Text Font
void	setOverlayText(String otext)	Set the optional overlay text of the redaction.
void	setPageNo(int pgNo)	Sets the page number where the redaction occurs.
void	setQuads(List<Quad> theQuads)	A list of quads to mark.
void	setRepeat(boolean Value)	Set the repeat value
void	setScaleToFit(boolean Value)	Set the ScaleToFit value
void	setTextColor(Color col)	Set the color used for the overlay text.

Methods inherited from class com.datalogics.PDFL.Annotation

equals, generateAppearance, getColor, getContents, getFlags, getInteriorColor, getNormalAppearance, getOpacity, getOptionalContentMembershipDict, getPDFDict, getRect, getSubtype, getTitle, hasRichTextData, isCurrentlyVisible, setColor, setContents, setFlags, setInteriorColor, setNormalAppearance, setOpacity, setOptionalContentMembershipDict, setRect, setTitle, toString

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

Redaction

public Redaction(Page page,
 List<Quad> regions,
 Color internalColor,
 boolean fillRedacted,
 boolean drawBorder,
 Color borderColor,
 boolean fillNormal,
 Color fillColor,
 double fillOpacity,
 String overlayText,
 Color textColor,
 String fontName,
 double textSize,
 boolean repeat,
 boolean scaleToFit)

Create a new Redaction annotation object with extended options. When Overlay Text is used, font is specified by name. To create a potental redaction and place it elsewhere in the page's annotation array.

Parameters:

page - The page where this redaction mark is found.

regions - A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.

internalColor - The color of the redaction mark. This color is also used as the fill color when generating the replacement form for this redaction mark. The replacement form is the content that will be placed on the page when this mark is applied and the underlying content is removed.

fillRedacted - When true, the area being redacted will be filled with the internalColor in the redacted appearance (and in the final document, after redactions are applied). This parameter is considered true if not omitted.

drawBorder - When true, the "normal" appearance of the redacted areas will have a border of 1 point, in the borderColor. When it is false, no border will be drawn. This parameter is considered true if not omitted.

borderColor - The color to draw the border around the "normal" appearance of each area. If omitted, and fillColor is not omitted, no border will be drawn. If both fillColor and BorderColor is omitted, border will be drawn in internalColor. If internalColor is also omitted, border will be drawn in black.

fillNormal - When true, the areas being redacted will be drawn, in the "normal" appearance, with an overlaying fill of the fillColor at the fillOpacity. When false, there will be no overlay fill. This paramter is considered false if omitted.

fillColor - The color applied as an overlay to the "normal" (Non redacted) area within the redaction areas. If this color is omitted, a "white" fill will be presumed.

fillOpacity - A value from 0 to 1.0 which is the opacity of the fill color (If this value is one, then the content of the redacted area will not be visible in the "normal" mode. If it is zero, then there will be no visible color overlaying the content to be redacted). If omitted, this will default to 1.0.

overlayText - The value of the string to be displayed over the redacted area. It will be scaled and/or repeated according to the value of later parameters. If omitted, it will be an empty string, and there will be no overlay text drawn.

textColor - The color to use in drawing the OverlayText. If this is omitted, white will be presumed.

fontName - The name of the font to be used when setting the overlayText. When absent or empty, the standard font Helvtica will be used. Using this option, a new internal font is created for each redaction. Each is subset and embedded. When many, many redactions are to be created, this can result in a significant use of processing time. When many redactions are to be created, the option using a font object in place of the font name is preferred.

textSize - The size, in points, to draw the text too. This may be overridden the scaleTofit value below. If omitted, it will default to 12.0.

repeat - When true, the overlay text will be repeated to fill the redacted area. when false, the overlay text will be displayed only once. When omitted, it is presumed to be false.

scaleToFit - When true, the text size will be decreased to just fill the redacted area. When false, the text size will be constant, as described in textSize. When omitted, this is presumed to be false.

Redaction

public Redaction(Page page,
 List<Quad> regions,
 Color internalColor,
 boolean fillRedacted,
 boolean drawBorder,
 Color borderColor,
 boolean fillNormal,
 Color fillColor,
 double fillOpacity,
 String overlayText,
 Color textColor,
 String fontName,
 double textSize,
 boolean repeat)

Create a new Redaction annotation object with extended options. When Overlay Text is used, font is specified by name. To create a potental redaction and place it elsewhere in the page's annotation array.

Parameters:

page - The page where this redaction mark is found.

regions - A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.

internalColor - The color of the redaction mark. This color is also used as the fill color when generating the replacement form for this redaction mark. The replacement form is the content that will be placed on the page when this mark is applied and the underlying content is removed.

fillRedacted - When true, the area being redacted will be filled with the internalColor in the redacted appearance (and in the final document, after redactions are applied). This parameter is considered true if not omitted.

drawBorder - When true, the "normal" appearance of the redacted areas will have a border of 1 point, in the borderColor. When it is false, no border will be drawn. This parameter is considered true if not omitted.

borderColor - The color to draw the border around the "normal" appearance of each area. If omitted, and fillColor is not omitted, no border will be drawn. If both fillColor and BorderColor is omitted, border will be drawn in internalColor. If internalColor is also omitted, border will be drawn in black.

fillNormal - When true, the areas being redacted will be drawn, in the "normal" appearance, with an overlaying fill of the fillColor at the fillOpacity. When false, there will be no overlay fill. This paramter is considered false if omitted.

fillColor - The color applied as an overlay to the "normal" (Non redacted) area within the redaction areas. If this color is omitted, a "white" fill will be presumed.

fillOpacity - A value from 0 to 1.0 which is the opacity of the fill color (If this value is one, then the content of the redacted area will not be visible in the "normal" mode. If it is zero, then there will be no visible color overlaying the content to be redacted). If omitted, this will default to 1.0.

overlayText - The value of the string to be displayed over the redacted area. It will be scaled and/or repeated according to the value of later parameters. If omitted, it will be an empty string, and there will be no overlay text drawn.

textColor - The color to use in drawing the OverlayText. If this is omitted, white will be presumed.

fontName - The name of the font to be used when setting the overlayText. When absent or empty, the standard font Helvtica will be used. Using this option, a new internal font is created for each redaction. Each is subset and embedded. When many, many redactions are to be created, this can result in a significant use of processing time. When many redactions are to be created, the option using a font object in place of the font name is preferred.

textSize - The size, in points, to draw the text too. This may be overridden the scaleTofit value below. If omitted, it will default to 12.0.

repeat - When true, the overlay text will be repeated to fill the redacted area. when false, the overlay text will be displayed only once. When omitted, it is presumed to be false.

scaleToFit - When true, the text size will be decreased to just fill the redacted area. When false, the text size will be constant, as described in textSize. When omitted, this is presumed to be false.

Redaction

public Redaction(Page page,
 List<Quad> regions,
 Color internalColor,
 boolean fillRedacted,
 boolean drawBorder,
 Color borderColor,
 boolean fillNormal,
 Color fillColor,
 double fillOpacity,
 String overlayText,
 Color textColor,
 String fontName,
 double textSize)

Create a new Redaction annotation object with extended options. When Overlay Text is used, font is specified by name. To create a potental redaction and place it elsewhere in the page's annotation array.

Parameters:

page - The page where this redaction mark is found.

regions - A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.

internalColor - The color of the redaction mark. This color is also used as the fill color when generating the replacement form for this redaction mark. The replacement form is the content that will be placed on the page when this mark is applied and the underlying content is removed.

fillRedacted - When true, the area being redacted will be filled with the internalColor in the redacted appearance (and in the final document, after redactions are applied). This parameter is considered true if not omitted.

drawBorder - When true, the "normal" appearance of the redacted areas will have a border of 1 point, in the borderColor. When it is false, no border will be drawn. This parameter is considered true if not omitted.

borderColor - The color to draw the border around the "normal" appearance of each area. If omitted, and fillColor is not omitted, no border will be drawn. If both fillColor and BorderColor is omitted, border will be drawn in internalColor. If internalColor is also omitted, border will be drawn in black.

fillNormal - When true, the areas being redacted will be drawn, in the "normal" appearance, with an overlaying fill of the fillColor at the fillOpacity. When false, there will be no overlay fill. This paramter is considered false if omitted.

fillColor - The color applied as an overlay to the "normal" (Non redacted) area within the redaction areas. If this color is omitted, a "white" fill will be presumed.

fillOpacity - A value from 0 to 1.0 which is the opacity of the fill color (If this value is one, then the content of the redacted area will not be visible in the "normal" mode. If it is zero, then there will be no visible color overlaying the content to be redacted). If omitted, this will default to 1.0.

overlayText - The value of the string to be displayed over the redacted area. It will be scaled and/or repeated according to the value of later parameters. If omitted, it will be an empty string, and there will be no overlay text drawn.

textColor - The color to use in drawing the OverlayText. If this is omitted, white will be presumed.

fontName - The name of the font to be used when setting the overlayText. When absent or empty, the standard font Helvtica will be used. Using this option, a new internal font is created for each redaction. Each is subset and embedded. When many, many redactions are to be created, this can result in a significant use of processing time. When many redactions are to be created, the option using a font object in place of the font name is preferred.

textSize - The size, in points, to draw the text too. This may be overridden the scaleTofit value below. If omitted, it will default to 12.0.

repeat - When true, the overlay text will be repeated to fill the redacted area. when false, the overlay text will be displayed only once. When omitted, it is presumed to be false.

scaleToFit - When true, the text size will be decreased to just fill the redacted area. When false, the text size will be constant, as described in textSize. When omitted, this is presumed to be false.

Redaction

public Redaction(Page page,
 List<Quad> regions,
 Color internalColor,
 boolean fillRedacted,
 boolean drawBorder,
 Color borderColor,
 boolean fillNormal,
 Color fillColor,
 double fillOpacity,
 String overlayText,
 Color textColor,
 String fontName)

Create a new Redaction annotation object with extended options. When Overlay Text is used, font is specified by name. To create a potental redaction and place it elsewhere in the page's annotation array.

Parameters:

page - The page where this redaction mark is found.

regions - A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.

internalColor - The color of the redaction mark. This color is also used as the fill color when generating the replacement form for this redaction mark. The replacement form is the content that will be placed on the page when this mark is applied and the underlying content is removed.

fillRedacted - When true, the area being redacted will be filled with the internalColor in the redacted appearance (and in the final document, after redactions are applied). This parameter is considered true if not omitted.

drawBorder - When true, the "normal" appearance of the redacted areas will have a border of 1 point, in the borderColor. When it is false, no border will be drawn. This parameter is considered true if not omitted.

borderColor - The color to draw the border around the "normal" appearance of each area. If omitted, and fillColor is not omitted, no border will be drawn. If both fillColor and BorderColor is omitted, border will be drawn in internalColor. If internalColor is also omitted, border will be drawn in black.

fillNormal - When true, the areas being redacted will be drawn, in the "normal" appearance, with an overlaying fill of the fillColor at the fillOpacity. When false, there will be no overlay fill. This paramter is considered false if omitted.

fillColor - The color applied as an overlay to the "normal" (Non redacted) area within the redaction areas. If this color is omitted, a "white" fill will be presumed.

fillOpacity - A value from 0 to 1.0 which is the opacity of the fill color (If this value is one, then the content of the redacted area will not be visible in the "normal" mode. If it is zero, then there will be no visible color overlaying the content to be redacted). If omitted, this will default to 1.0.

overlayText - The value of the string to be displayed over the redacted area. It will be scaled and/or repeated according to the value of later parameters. If omitted, it will be an empty string, and there will be no overlay text drawn.

textColor - The color to use in drawing the OverlayText. If this is omitted, white will be presumed.

fontName - The name of the font to be used when setting the overlayText. When absent or empty, the standard font Helvtica will be used. Using this option, a new internal font is created for each redaction. Each is subset and embedded. When many, many redactions are to be created, this can result in a significant use of processing time. When many redactions are to be created, the option using a font object in place of the font name is preferred.

textSize - The size, in points, to draw the text too. This may be overridden the scaleTofit value below. If omitted, it will default to 12.0.

repeat - When true, the overlay text will be repeated to fill the redacted area. when false, the overlay text will be displayed only once. When omitted, it is presumed to be false.

scaleToFit - When true, the text size will be decreased to just fill the redacted area. When false, the text size will be constant, as described in textSize. When omitted, this is presumed to be false.

Redaction

public Redaction(Page page,
 List<Quad> regions,
 Color internalColor,
 boolean fillRedacted,
 boolean drawBorder,
 Color borderColor,
 boolean fillNormal,
 Color fillColor,
 double fillOpacity,
 String overlayText,
 Color textColor)

Create a new Redaction annotation object with extended options. When Overlay Text is used, font is specified by name. To create a potental redaction and place it elsewhere in the page's annotation array.

Parameters:

page - The page where this redaction mark is found.

regions - A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.

internalColor - The color of the redaction mark. This color is also used as the fill color when generating the replacement form for this redaction mark. The replacement form is the content that will be placed on the page when this mark is applied and the underlying content is removed.

fillRedacted - When true, the area being redacted will be filled with the internalColor in the redacted appearance (and in the final document, after redactions are applied). This parameter is considered true if not omitted.

drawBorder - When true, the "normal" appearance of the redacted areas will have a border of 1 point, in the borderColor. When it is false, no border will be drawn. This parameter is considered true if not omitted.

borderColor - The color to draw the border around the "normal" appearance of each area. If omitted, and fillColor is not omitted, no border will be drawn. If both fillColor and BorderColor is omitted, border will be drawn in internalColor. If internalColor is also omitted, border will be drawn in black.

fillNormal - When true, the areas being redacted will be drawn, in the "normal" appearance, with an overlaying fill of the fillColor at the fillOpacity. When false, there will be no overlay fill. This paramter is considered false if omitted.

fillColor - The color applied as an overlay to the "normal" (Non redacted) area within the redaction areas. If this color is omitted, a "white" fill will be presumed.

fillOpacity - A value from 0 to 1.0 which is the opacity of the fill color (If this value is one, then the content of the redacted area will not be visible in the "normal" mode. If it is zero, then there will be no visible color overlaying the content to be redacted). If omitted, this will default to 1.0.

overlayText - The value of the string to be displayed over the redacted area. It will be scaled and/or repeated according to the value of later parameters. If omitted, it will be an empty string, and there will be no overlay text drawn.

textColor - The color to use in drawing the OverlayText. If this is omitted, white will be presumed.

fontName - The name of the font to be used when setting the overlayText. When absent or empty, the standard font Helvtica will be used. Using this option, a new internal font is created for each redaction. Each is subset and embedded. When many, many redactions are to be created, this can result in a significant use of processing time. When many redactions are to be created, the option using a font object in place of the font name is preferred.

textSize - The size, in points, to draw the text too. This may be overridden the scaleTofit value below. If omitted, it will default to 12.0.

repeat - When true, the overlay text will be repeated to fill the redacted area. when false, the overlay text will be displayed only once. When omitted, it is presumed to be false.

scaleToFit - When true, the text size will be decreased to just fill the redacted area. When false, the text size will be constant, as described in textSize. When omitted, this is presumed to be false.

Redaction

public Redaction(Page page,
 List<Quad> regions,
 Color internalColor,
 boolean fillRedacted,
 boolean drawBorder,
 Color borderColor,
 boolean fillNormal,
 Color fillColor,
 double fillOpacity,
 String overlayText)

Create a new Redaction annotation object with extended options. When Overlay Text is used, font is specified by name. To create a potental redaction and place it elsewhere in the page's annotation array.

Parameters:

page - The page where this redaction mark is found.

regions - A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.

internalColor - The color of the redaction mark. This color is also used as the fill color when generating the replacement form for this redaction mark. The replacement form is the content that will be placed on the page when this mark is applied and the underlying content is removed.

fillRedacted - When true, the area being redacted will be filled with the internalColor in the redacted appearance (and in the final document, after redactions are applied). This parameter is considered true if not omitted.

drawBorder - When true, the "normal" appearance of the redacted areas will have a border of 1 point, in the borderColor. When it is false, no border will be drawn. This parameter is considered true if not omitted.

borderColor - The color to draw the border around the "normal" appearance of each area. If omitted, and fillColor is not omitted, no border will be drawn. If both fillColor and BorderColor is omitted, border will be drawn in internalColor. If internalColor is also omitted, border will be drawn in black.

fillNormal - When true, the areas being redacted will be drawn, in the "normal" appearance, with an overlaying fill of the fillColor at the fillOpacity. When false, there will be no overlay fill. This paramter is considered false if omitted.

fillColor - The color applied as an overlay to the "normal" (Non redacted) area within the redaction areas. If this color is omitted, a "white" fill will be presumed.

fillOpacity - A value from 0 to 1.0 which is the opacity of the fill color (If this value is one, then the content of the redacted area will not be visible in the "normal" mode. If it is zero, then there will be no visible color overlaying the content to be redacted). If omitted, this will default to 1.0.

overlayText - The value of the string to be displayed over the redacted area. It will be scaled and/or repeated according to the value of later parameters. If omitted, it will be an empty string, and there will be no overlay text drawn.

textColor - The color to use in drawing the OverlayText. If this is omitted, white will be presumed.

fontName - The name of the font to be used when setting the overlayText. When absent or empty, the standard font Helvtica will be used. Using this option, a new internal font is created for each redaction. Each is subset and embedded. When many, many redactions are to be created, this can result in a significant use of processing time. When many redactions are to be created, the option using a font object in place of the font name is preferred.

textSize - The size, in points, to draw the text too. This may be overridden the scaleTofit value below. If omitted, it will default to 12.0.

repeat - When true, the overlay text will be repeated to fill the redacted area. when false, the overlay text will be displayed only once. When omitted, it is presumed to be false.

scaleToFit - When true, the text size will be decreased to just fill the redacted area. When false, the text size will be constant, as described in textSize. When omitted, this is presumed to be false.

Redaction

public Redaction(Page page,
 List<Quad> regions,
 Color internalColor,
 boolean fillRedacted,
 boolean drawBorder,
 Color borderColor,
 boolean fillNormal,
 Color fillColor,
 double fillOpacity)

Create a new Redaction annotation object with extended options. When Overlay Text is used, font is specified by name. To create a potental redaction and place it elsewhere in the page's annotation array.

Parameters:

page - The page where this redaction mark is found.

regions - A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.

internalColor - The color of the redaction mark. This color is also used as the fill color when generating the replacement form for this redaction mark. The replacement form is the content that will be placed on the page when this mark is applied and the underlying content is removed.

fillRedacted - When true, the area being redacted will be filled with the internalColor in the redacted appearance (and in the final document, after redactions are applied). This parameter is considered true if not omitted.

drawBorder - When true, the "normal" appearance of the redacted areas will have a border of 1 point, in the borderColor. When it is false, no border will be drawn. This parameter is considered true if not omitted.

borderColor - The color to draw the border around the "normal" appearance of each area. If omitted, and fillColor is not omitted, no border will be drawn. If both fillColor and BorderColor is omitted, border will be drawn in internalColor. If internalColor is also omitted, border will be drawn in black.

fillNormal - When true, the areas being redacted will be drawn, in the "normal" appearance, with an overlaying fill of the fillColor at the fillOpacity. When false, there will be no overlay fill. This paramter is considered false if omitted.

fillColor - The color applied as an overlay to the "normal" (Non redacted) area within the redaction areas. If this color is omitted, a "white" fill will be presumed.

fillOpacity - A value from 0 to 1.0 which is the opacity of the fill color (If this value is one, then the content of the redacted area will not be visible in the "normal" mode. If it is zero, then there will be no visible color overlaying the content to be redacted). If omitted, this will default to 1.0.

overlayText - The value of the string to be displayed over the redacted area. It will be scaled and/or repeated according to the value of later parameters. If omitted, it will be an empty string, and there will be no overlay text drawn.

textColor - The color to use in drawing the OverlayText. If this is omitted, white will be presumed.

fontName - The name of the font to be used when setting the overlayText. When absent or empty, the standard font Helvtica will be used. Using this option, a new internal font is created for each redaction. Each is subset and embedded. When many, many redactions are to be created, this can result in a significant use of processing time. When many redactions are to be created, the option using a font object in place of the font name is preferred.

textSize - The size, in points, to draw the text too. This may be overridden the scaleTofit value below. If omitted, it will default to 12.0.

repeat - When true, the overlay text will be repeated to fill the redacted area. when false, the overlay text will be displayed only once. When omitted, it is presumed to be false.

scaleToFit - When true, the text size will be decreased to just fill the redacted area. When false, the text size will be constant, as described in textSize. When omitted, this is presumed to be false.

Redaction

public Redaction(Page page,
 List<Quad> regions,
 Color internalColor,
 boolean fillRedacted,
 boolean drawBorder,
 Color borderColor,
 boolean fillNormal,
 Color fillColor)

Create a new Redaction annotation object with extended options. When Overlay Text is used, font is specified by name. To create a potental redaction and place it elsewhere in the page's annotation array.

Parameters:

page - The page where this redaction mark is found.

regions - A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.

internalColor - The color of the redaction mark. This color is also used as the fill color when generating the replacement form for this redaction mark. The replacement form is the content that will be placed on the page when this mark is applied and the underlying content is removed.

fillRedacted - When true, the area being redacted will be filled with the internalColor in the redacted appearance (and in the final document, after redactions are applied). This parameter is considered true if not omitted.

drawBorder - When true, the "normal" appearance of the redacted areas will have a border of 1 point, in the borderColor. When it is false, no border will be drawn. This parameter is considered true if not omitted.

borderColor - The color to draw the border around the "normal" appearance of each area. If omitted, and fillColor is not omitted, no border will be drawn. If both fillColor and BorderColor is omitted, border will be drawn in internalColor. If internalColor is also omitted, border will be drawn in black.

fillNormal - When true, the areas being redacted will be drawn, in the "normal" appearance, with an overlaying fill of the fillColor at the fillOpacity. When false, there will be no overlay fill. This paramter is considered false if omitted.

fillColor - The color applied as an overlay to the "normal" (Non redacted) area within the redaction areas. If this color is omitted, a "white" fill will be presumed.

fillOpacity - A value from 0 to 1.0 which is the opacity of the fill color (If this value is one, then the content of the redacted area will not be visible in the "normal" mode. If it is zero, then there will be no visible color overlaying the content to be redacted). If omitted, this will default to 1.0.

overlayText - The value of the string to be displayed over the redacted area. It will be scaled and/or repeated according to the value of later parameters. If omitted, it will be an empty string, and there will be no overlay text drawn.

textColor - The color to use in drawing the OverlayText. If this is omitted, white will be presumed.

fontName - The name of the font to be used when setting the overlayText. When absent or empty, the standard font Helvtica will be used. Using this option, a new internal font is created for each redaction. Each is subset and embedded. When many, many redactions are to be created, this can result in a significant use of processing time. When many redactions are to be created, the option using a font object in place of the font name is preferred.

textSize - The size, in points, to draw the text too. This may be overridden the scaleTofit value below. If omitted, it will default to 12.0.

repeat - When true, the overlay text will be repeated to fill the redacted area. when false, the overlay text will be displayed only once. When omitted, it is presumed to be false.

scaleToFit - When true, the text size will be decreased to just fill the redacted area. When false, the text size will be constant, as described in textSize. When omitted, this is presumed to be false.

Redaction

public Redaction(Page page,
 List<Quad> regions,
 Color internalColor,
 boolean fillRedacted,
 boolean drawBorder,
 Color borderColor,
 boolean fillNormal)

Create a new Redaction annotation object with extended options. When Overlay Text is used, font is specified by name. To create a potental redaction and place it elsewhere in the page's annotation array.

Parameters:

page - The page where this redaction mark is found.

regions - A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.

internalColor - The color of the redaction mark. This color is also used as the fill color when generating the replacement form for this redaction mark. The replacement form is the content that will be placed on the page when this mark is applied and the underlying content is removed.

fillRedacted - When true, the area being redacted will be filled with the internalColor in the redacted appearance (and in the final document, after redactions are applied). This parameter is considered true if not omitted.

drawBorder - When true, the "normal" appearance of the redacted areas will have a border of 1 point, in the borderColor. When it is false, no border will be drawn. This parameter is considered true if not omitted.

borderColor - The color to draw the border around the "normal" appearance of each area. If omitted, and fillColor is not omitted, no border will be drawn. If both fillColor and BorderColor is omitted, border will be drawn in internalColor. If internalColor is also omitted, border will be drawn in black.

fillNormal - When true, the areas being redacted will be drawn, in the "normal" appearance, with an overlaying fill of the fillColor at the fillOpacity. When false, there will be no overlay fill. This paramter is considered false if omitted.

fillColor - The color applied as an overlay to the "normal" (Non redacted) area within the redaction areas. If this color is omitted, a "white" fill will be presumed.

fillOpacity - A value from 0 to 1.0 which is the opacity of the fill color (If this value is one, then the content of the redacted area will not be visible in the "normal" mode. If it is zero, then there will be no visible color overlaying the content to be redacted). If omitted, this will default to 1.0.

overlayText - The value of the string to be displayed over the redacted area. It will be scaled and/or repeated according to the value of later parameters. If omitted, it will be an empty string, and there will be no overlay text drawn.

textColor - The color to use in drawing the OverlayText. If this is omitted, white will be presumed.

fontName - The name of the font to be used when setting the overlayText. When absent or empty, the standard font Helvtica will be used. Using this option, a new internal font is created for each redaction. Each is subset and embedded. When many, many redactions are to be created, this can result in a significant use of processing time. When many redactions are to be created, the option using a font object in place of the font name is preferred.

textSize - The size, in points, to draw the text too. This may be overridden the scaleTofit value below. If omitted, it will default to 12.0.

repeat - When true, the overlay text will be repeated to fill the redacted area. when false, the overlay text will be displayed only once. When omitted, it is presumed to be false.

scaleToFit - When true, the text size will be decreased to just fill the redacted area. When false, the text size will be constant, as described in textSize. When omitted, this is presumed to be false.

Redaction

public Redaction(Page page,
 List<Quad> regions,
 Color internalColor,
 boolean fillRedacted,
 boolean drawBorder,
 Color borderColor)

Create a new Redaction annotation object with extended options. When Overlay Text is used, font is specified by name. To create a potental redaction and place it elsewhere in the page's annotation array.

Parameters:

page - The page where this redaction mark is found.

regions - A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.

internalColor - The color of the redaction mark. This color is also used as the fill color when generating the replacement form for this redaction mark. The replacement form is the content that will be placed on the page when this mark is applied and the underlying content is removed.

fillRedacted - When true, the area being redacted will be filled with the internalColor in the redacted appearance (and in the final document, after redactions are applied). This parameter is considered true if not omitted.

drawBorder - When true, the "normal" appearance of the redacted areas will have a border of 1 point, in the borderColor. When it is false, no border will be drawn. This parameter is considered true if not omitted.

borderColor - The color to draw the border around the "normal" appearance of each area. If omitted, and fillColor is not omitted, no border will be drawn. If both fillColor and BorderColor is omitted, border will be drawn in internalColor. If internalColor is also omitted, border will be drawn in black.

fillNormal - When true, the areas being redacted will be drawn, in the "normal" appearance, with an overlaying fill of the fillColor at the fillOpacity. When false, there will be no overlay fill. This paramter is considered false if omitted.

fillColor - The color applied as an overlay to the "normal" (Non redacted) area within the redaction areas. If this color is omitted, a "white" fill will be presumed.

fillOpacity - A value from 0 to 1.0 which is the opacity of the fill color (If this value is one, then the content of the redacted area will not be visible in the "normal" mode. If it is zero, then there will be no visible color overlaying the content to be redacted). If omitted, this will default to 1.0.

overlayText - The value of the string to be displayed over the redacted area. It will be scaled and/or repeated according to the value of later parameters. If omitted, it will be an empty string, and there will be no overlay text drawn.

textColor - The color to use in drawing the OverlayText. If this is omitted, white will be presumed.

fontName - The name of the font to be used when setting the overlayText. When absent or empty, the standard font Helvtica will be used. Using this option, a new internal font is created for each redaction. Each is subset and embedded. When many, many redactions are to be created, this can result in a significant use of processing time. When many redactions are to be created, the option using a font object in place of the font name is preferred.

textSize - The size, in points, to draw the text too. This may be overridden the scaleTofit value below. If omitted, it will default to 12.0.

repeat - When true, the overlay text will be repeated to fill the redacted area. when false, the overlay text will be displayed only once. When omitted, it is presumed to be false.

scaleToFit - When true, the text size will be decreased to just fill the redacted area. When false, the text size will be constant, as described in textSize. When omitted, this is presumed to be false.

Redaction

public Redaction(Page page,
 List<Quad> regions,
 Color internalColor,
 boolean fillRedacted,
 boolean drawBorder)

Create a new Redaction annotation object with extended options. When Overlay Text is used, font is specified by name. To create a potental redaction and place it elsewhere in the page's annotation array.

Parameters:

page - The page where this redaction mark is found.

regions - A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.

internalColor - The color of the redaction mark. This color is also used as the fill color when generating the replacement form for this redaction mark. The replacement form is the content that will be placed on the page when this mark is applied and the underlying content is removed.

fillRedacted - When true, the area being redacted will be filled with the internalColor in the redacted appearance (and in the final document, after redactions are applied). This parameter is considered true if not omitted.

drawBorder - When true, the "normal" appearance of the redacted areas will have a border of 1 point, in the borderColor. When it is false, no border will be drawn. This parameter is considered true if not omitted.

borderColor - The color to draw the border around the "normal" appearance of each area. If omitted, and fillColor is not omitted, no border will be drawn. If both fillColor and BorderColor is omitted, border will be drawn in internalColor. If internalColor is also omitted, border will be drawn in black.

fillNormal - When true, the areas being redacted will be drawn, in the "normal" appearance, with an overlaying fill of the fillColor at the fillOpacity. When false, there will be no overlay fill. This paramter is considered false if omitted.

fillColor - The color applied as an overlay to the "normal" (Non redacted) area within the redaction areas. If this color is omitted, a "white" fill will be presumed.

fillOpacity - A value from 0 to 1.0 which is the opacity of the fill color (If this value is one, then the content of the redacted area will not be visible in the "normal" mode. If it is zero, then there will be no visible color overlaying the content to be redacted). If omitted, this will default to 1.0.

overlayText - The value of the string to be displayed over the redacted area. It will be scaled and/or repeated according to the value of later parameters. If omitted, it will be an empty string, and there will be no overlay text drawn.

textColor - The color to use in drawing the OverlayText. If this is omitted, white will be presumed.

fontName - The name of the font to be used when setting the overlayText. When absent or empty, the standard font Helvtica will be used. Using this option, a new internal font is created for each redaction. Each is subset and embedded. When many, many redactions are to be created, this can result in a significant use of processing time. When many redactions are to be created, the option using a font object in place of the font name is preferred.

textSize - The size, in points, to draw the text too. This may be overridden the scaleTofit value below. If omitted, it will default to 12.0.

repeat - When true, the overlay text will be repeated to fill the redacted area. when false, the overlay text will be displayed only once. When omitted, it is presumed to be false.

scaleToFit - When true, the text size will be decreased to just fill the redacted area. When false, the text size will be constant, as described in textSize. When omitted, this is presumed to be false.

Redaction

public Redaction(Page page,
 List<Quad> regions,
 Color internalColor,
 boolean fillRedacted)

Create a new Redaction annotation object with extended options. When Overlay Text is used, font is specified by name. To create a potental redaction and place it elsewhere in the page's annotation array.

Parameters:

page - The page where this redaction mark is found.

regions - A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.

internalColor - The color of the redaction mark. This color is also used as the fill color when generating the replacement form for this redaction mark. The replacement form is the content that will be placed on the page when this mark is applied and the underlying content is removed.

fillRedacted - When true, the area being redacted will be filled with the internalColor in the redacted appearance (and in the final document, after redactions are applied). This parameter is considered true if not omitted.

drawBorder - When true, the "normal" appearance of the redacted areas will have a border of 1 point, in the borderColor. When it is false, no border will be drawn. This parameter is considered true if not omitted.

borderColor - The color to draw the border around the "normal" appearance of each area. If omitted, and fillColor is not omitted, no border will be drawn. If both fillColor and BorderColor is omitted, border will be drawn in internalColor. If internalColor is also omitted, border will be drawn in black.

fillNormal - When true, the areas being redacted will be drawn, in the "normal" appearance, with an overlaying fill of the fillColor at the fillOpacity. When false, there will be no overlay fill. This paramter is considered false if omitted.

fillColor - The color applied as an overlay to the "normal" (Non redacted) area within the redaction areas. If this color is omitted, a "white" fill will be presumed.

fillOpacity - A value from 0 to 1.0 which is the opacity of the fill color (If this value is one, then the content of the redacted area will not be visible in the "normal" mode. If it is zero, then there will be no visible color overlaying the content to be redacted). If omitted, this will default to 1.0.

overlayText - The value of the string to be displayed over the redacted area. It will be scaled and/or repeated according to the value of later parameters. If omitted, it will be an empty string, and there will be no overlay text drawn.

textColor - The color to use in drawing the OverlayText. If this is omitted, white will be presumed.

fontName - The name of the font to be used when setting the overlayText. When absent or empty, the standard font Helvtica will be used. Using this option, a new internal font is created for each redaction. Each is subset and embedded. When many, many redactions are to be created, this can result in a significant use of processing time. When many redactions are to be created, the option using a font object in place of the font name is preferred.

textSize - The size, in points, to draw the text too. This may be overridden the scaleTofit value below. If omitted, it will default to 12.0.

repeat - When true, the overlay text will be repeated to fill the redacted area. when false, the overlay text will be displayed only once. When omitted, it is presumed to be false.

scaleToFit - When true, the text size will be decreased to just fill the redacted area. When false, the text size will be constant, as described in textSize. When omitted, this is presumed to be false.

Redaction

public Redaction(Page page,
 List<Quad> regions,
 Color internalColor)

Create a new Redaction annotation object with extended options. When Overlay Text is used, font is specified by name. To create a potental redaction and place it elsewhere in the page's annotation array.

Parameters:

page - The page where this redaction mark is found.

regions - A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.

internalColor - The color of the redaction mark. This color is also used as the fill color when generating the replacement form for this redaction mark. The replacement form is the content that will be placed on the page when this mark is applied and the underlying content is removed.

fillRedacted - When true, the area being redacted will be filled with the internalColor in the redacted appearance (and in the final document, after redactions are applied). This parameter is considered true if not omitted.

drawBorder - When true, the "normal" appearance of the redacted areas will have a border of 1 point, in the borderColor. When it is false, no border will be drawn. This parameter is considered true if not omitted.

borderColor - The color to draw the border around the "normal" appearance of each area. If omitted, and fillColor is not omitted, no border will be drawn. If both fillColor and BorderColor is omitted, border will be drawn in internalColor. If internalColor is also omitted, border will be drawn in black.

fillNormal - When true, the areas being redacted will be drawn, in the "normal" appearance, with an overlaying fill of the fillColor at the fillOpacity. When false, there will be no overlay fill. This paramter is considered false if omitted.

fillColor - The color applied as an overlay to the "normal" (Non redacted) area within the redaction areas. If this color is omitted, a "white" fill will be presumed.

fillOpacity - A value from 0 to 1.0 which is the opacity of the fill color (If this value is one, then the content of the redacted area will not be visible in the "normal" mode. If it is zero, then there will be no visible color overlaying the content to be redacted). If omitted, this will default to 1.0.

overlayText - The value of the string to be displayed over the redacted area. It will be scaled and/or repeated according to the value of later parameters. If omitted, it will be an empty string, and there will be no overlay text drawn.

textColor - The color to use in drawing the OverlayText. If this is omitted, white will be presumed.

fontName - The name of the font to be used when setting the overlayText. When absent or empty, the standard font Helvtica will be used. Using this option, a new internal font is created for each redaction. Each is subset and embedded. When many, many redactions are to be created, this can result in a significant use of processing time. When many redactions are to be created, the option using a font object in place of the font name is preferred.

textSize - The size, in points, to draw the text too. This may be overridden the scaleTofit value below. If omitted, it will default to 12.0.

repeat - When true, the overlay text will be repeated to fill the redacted area. when false, the overlay text will be displayed only once. When omitted, it is presumed to be false.

scaleToFit - When true, the text size will be decreased to just fill the redacted area. When false, the text size will be constant, as described in textSize. When omitted, this is presumed to be false.

Redaction

public Redaction(Page page,
 List<Quad> regions)

Create a new Redaction annotation object with extended options. When Overlay Text is used, font is specified by name. To create a potental redaction and place it elsewhere in the page's annotation array.

Parameters:

page - The page where this redaction mark is found.

regions - A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.

internalColor - The color of the redaction mark. This color is also used as the fill color when generating the replacement form for this redaction mark. The replacement form is the content that will be placed on the page when this mark is applied and the underlying content is removed.

fillRedacted - When true, the area being redacted will be filled with the internalColor in the redacted appearance (and in the final document, after redactions are applied). This parameter is considered true if not omitted.

drawBorder - When true, the "normal" appearance of the redacted areas will have a border of 1 point, in the borderColor. When it is false, no border will be drawn. This parameter is considered true if not omitted.

borderColor - The color to draw the border around the "normal" appearance of each area. If omitted, and fillColor is not omitted, no border will be drawn. If both fillColor and BorderColor is omitted, border will be drawn in internalColor. If internalColor is also omitted, border will be drawn in black.

fillNormal - When true, the areas being redacted will be drawn, in the "normal" appearance, with an overlaying fill of the fillColor at the fillOpacity. When false, there will be no overlay fill. This paramter is considered false if omitted.

fillColor - The color applied as an overlay to the "normal" (Non redacted) area within the redaction areas. If this color is omitted, a "white" fill will be presumed.

fillOpacity - A value from 0 to 1.0 which is the opacity of the fill color (If this value is one, then the content of the redacted area will not be visible in the "normal" mode. If it is zero, then there will be no visible color overlaying the content to be redacted). If omitted, this will default to 1.0.

overlayText - The value of the string to be displayed over the redacted area. It will be scaled and/or repeated according to the value of later parameters. If omitted, it will be an empty string, and there will be no overlay text drawn.

textColor - The color to use in drawing the OverlayText. If this is omitted, white will be presumed.

fontName - The name of the font to be used when setting the overlayText. When absent or empty, the standard font Helvtica will be used. Using this option, a new internal font is created for each redaction. Each is subset and embedded. When many, many redactions are to be created, this can result in a significant use of processing time. When many redactions are to be created, the option using a font object in place of the font name is preferred.

textSize - The size, in points, to draw the text too. This may be overridden the scaleTofit value below. If omitted, it will default to 12.0.

repeat - When true, the overlay text will be repeated to fill the redacted area. when false, the overlay text will be displayed only once. When omitted, it is presumed to be false.

scaleToFit - When true, the text size will be decreased to just fill the redacted area. When false, the text size will be constant, as described in textSize. When omitted, this is presumed to be false.

Redaction

public Redaction(Page page,
 List<Quad> regions,
 Font font,
 Color internalColor,
 boolean fillRedacted,
 boolean drawBorder,
 Color borderColor,
 boolean fillNormal,
 Color fillColor,
 double fillOpacity,
 String overlayText,
 Color textColor,
 double textSize,
 boolean repeat,
 boolean scaleToFit)

Create a new Redaction annotation object with extended options .When Overlay Text is used, font is provided as a font. To create a potental redaction and place it elsewhere in the page's annotation array.

Parameters:

page - The page where this redaction mark is found.

regions - A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.

font - The font to be used when creating overlay text. For most efficiency, this font should be created prior to the first redaction, and used for all redactions. After the last redaction is created the font may be subset and embedded. Using this option, rather than specifying a font name, significantly speeds the creation of many redactions.

internalColor - The color of the redaction mark. This color is also used as the fill color when generating the replacement form for this redaction mark. The replacement form is the content that will be placed on the page when this mark is applied and the underlying content is removed.

fillRedacted - When true, the area being redacted will be filled with the internalColor in the redacted appearance(and in the final document, after redactions are applied). If omitted, this parameter will default to true.

drawBorder - When true, the "normal" appearance of the redacted areas will have a border of 1 point, in the borderColor. When it is false, no border will be drawn. If omitted, this parameter will default to true.

borderColor - The color to draw the border around the "normal" appearance of each area. If omitted, and fillColor is not omitted, no border will be drawn. If both fillColor and BorderColor is omitted, border will be drawn in internalColor. If internalColor is also omitted, border will be drawn in black.

fillNormal - When true, the areas being redacted will be drawn, in the "normal" appearance, with an overlaying fill of the fillColor at the fillOpacity. When false, there will be no overlay fill. This paramter is considered false if omitted.

fillColor - The color applied as an overlay to the "normal" (Non redacted) area within the redaction areas. If this color is omitted, a "white" fill will be presumed.

fillOpacity - A value from 0 to 1.0 which is the opacity of the fill color(If this value is one, then the content of the redacted area will not be visible in the "normal" mode. If it is zero, then there will be no visible color overlaying the content to be redacted). If omitted, this will default to 1.0.

overlayText - The value of the string to be displayed over the redacted area. It will be scaled and/or repeated according to the value of later parameters. If omitted, it will be an empty string, and there will be no overlay text drawn.

textColor - The color to use in drawing the OverlayText. If this is omitted, white will be presumed.

textSize - The size, in points, to draw the text too. This may be overridden the scaleTofit value below. If omitted, it will default to 12.0.

repeat - When true, the overlay text will be repeated to fill the redacted area, when false, the overlay text will be displayed only once. When omitted, it is presumed to be false.

scaleToFit - When true, the text size will be decreased to just fill the redacted area. When false, the text size will be constant, as described in textSize. When omitted, this is presumed to be false.

Redaction

public Redaction(Page page,
 List<Quad> regions,
 Font font,
 Color internalColor,
 boolean fillRedacted,
 boolean drawBorder,
 Color borderColor,
 boolean fillNormal,
 Color fillColor,
 double fillOpacity,
 String overlayText,
 Color textColor,
 double textSize,
 boolean repeat)

Create a new Redaction annotation object with extended options .When Overlay Text is used, font is provided as a font. To create a potental redaction and place it elsewhere in the page's annotation array.

Parameters:

page - The page where this redaction mark is found.

regions - A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.

font - The font to be used when creating overlay text. For most efficiency, this font should be created prior to the first redaction, and used for all redactions. After the last redaction is created the font may be subset and embedded. Using this option, rather than specifying a font name, significantly speeds the creation of many redactions.

internalColor - The color of the redaction mark. This color is also used as the fill color when generating the replacement form for this redaction mark. The replacement form is the content that will be placed on the page when this mark is applied and the underlying content is removed.

fillRedacted - When true, the area being redacted will be filled with the internalColor in the redacted appearance(and in the final document, after redactions are applied). If omitted, this parameter will default to true.

drawBorder - When true, the "normal" appearance of the redacted areas will have a border of 1 point, in the borderColor. When it is false, no border will be drawn. If omitted, this parameter will default to true.

borderColor - The color to draw the border around the "normal" appearance of each area. If omitted, and fillColor is not omitted, no border will be drawn. If both fillColor and BorderColor is omitted, border will be drawn in internalColor. If internalColor is also omitted, border will be drawn in black.

fillNormal - When true, the areas being redacted will be drawn, in the "normal" appearance, with an overlaying fill of the fillColor at the fillOpacity. When false, there will be no overlay fill. This paramter is considered false if omitted.

fillColor - The color applied as an overlay to the "normal" (Non redacted) area within the redaction areas. If this color is omitted, a "white" fill will be presumed.

fillOpacity - A value from 0 to 1.0 which is the opacity of the fill color(If this value is one, then the content of the redacted area will not be visible in the "normal" mode. If it is zero, then there will be no visible color overlaying the content to be redacted). If omitted, this will default to 1.0.

overlayText - The value of the string to be displayed over the redacted area. It will be scaled and/or repeated according to the value of later parameters. If omitted, it will be an empty string, and there will be no overlay text drawn.

textColor - The color to use in drawing the OverlayText. If this is omitted, white will be presumed.

textSize - The size, in points, to draw the text too. This may be overridden the scaleTofit value below. If omitted, it will default to 12.0.

repeat - When true, the overlay text will be repeated to fill the redacted area, when false, the overlay text will be displayed only once. When omitted, it is presumed to be false.

scaleToFit - When true, the text size will be decreased to just fill the redacted area. When false, the text size will be constant, as described in textSize. When omitted, this is presumed to be false.

Redaction

public Redaction(Page page,
 List<Quad> regions,
 Font font,
 Color internalColor,
 boolean fillRedacted,
 boolean drawBorder,
 Color borderColor,
 boolean fillNormal,
 Color fillColor,
 double fillOpacity,
 String overlayText,
 Color textColor,
 double textSize)

Create a new Redaction annotation object with extended options .When Overlay Text is used, font is provided as a font. To create a potental redaction and place it elsewhere in the page's annotation array.

Parameters:

page - The page where this redaction mark is found.

regions - A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.

font - The font to be used when creating overlay text. For most efficiency, this font should be created prior to the first redaction, and used for all redactions. After the last redaction is created the font may be subset and embedded. Using this option, rather than specifying a font name, significantly speeds the creation of many redactions.

internalColor - The color of the redaction mark. This color is also used as the fill color when generating the replacement form for this redaction mark. The replacement form is the content that will be placed on the page when this mark is applied and the underlying content is removed.

fillRedacted - When true, the area being redacted will be filled with the internalColor in the redacted appearance(and in the final document, after redactions are applied). If omitted, this parameter will default to true.

drawBorder - When true, the "normal" appearance of the redacted areas will have a border of 1 point, in the borderColor. When it is false, no border will be drawn. If omitted, this parameter will default to true.

borderColor - The color to draw the border around the "normal" appearance of each area. If omitted, and fillColor is not omitted, no border will be drawn. If both fillColor and BorderColor is omitted, border will be drawn in internalColor. If internalColor is also omitted, border will be drawn in black.

fillNormal - When true, the areas being redacted will be drawn, in the "normal" appearance, with an overlaying fill of the fillColor at the fillOpacity. When false, there will be no overlay fill. This paramter is considered false if omitted.

fillColor - The color applied as an overlay to the "normal" (Non redacted) area within the redaction areas. If this color is omitted, a "white" fill will be presumed.

fillOpacity - A value from 0 to 1.0 which is the opacity of the fill color(If this value is one, then the content of the redacted area will not be visible in the "normal" mode. If it is zero, then there will be no visible color overlaying the content to be redacted). If omitted, this will default to 1.0.

overlayText - The value of the string to be displayed over the redacted area. It will be scaled and/or repeated according to the value of later parameters. If omitted, it will be an empty string, and there will be no overlay text drawn.

textColor - The color to use in drawing the OverlayText. If this is omitted, white will be presumed.

textSize - The size, in points, to draw the text too. This may be overridden the scaleTofit value below. If omitted, it will default to 12.0.

repeat - When true, the overlay text will be repeated to fill the redacted area, when false, the overlay text will be displayed only once. When omitted, it is presumed to be false.

scaleToFit - When true, the text size will be decreased to just fill the redacted area. When false, the text size will be constant, as described in textSize. When omitted, this is presumed to be false.

Redaction

public Redaction(Page page,
 List<Quad> regions,
 Font font,
 Color internalColor,
 boolean fillRedacted,
 boolean drawBorder,
 Color borderColor,
 boolean fillNormal,
 Color fillColor,
 double fillOpacity,
 String overlayText,
 Color textColor)

Create a new Redaction annotation object with extended options .When Overlay Text is used, font is provided as a font. To create a potental redaction and place it elsewhere in the page's annotation array.

Parameters:

page - The page where this redaction mark is found.

regions - A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.

font - The font to be used when creating overlay text. For most efficiency, this font should be created prior to the first redaction, and used for all redactions. After the last redaction is created the font may be subset and embedded. Using this option, rather than specifying a font name, significantly speeds the creation of many redactions.

internalColor - The color of the redaction mark. This color is also used as the fill color when generating the replacement form for this redaction mark. The replacement form is the content that will be placed on the page when this mark is applied and the underlying content is removed.

fillRedacted - When true, the area being redacted will be filled with the internalColor in the redacted appearance(and in the final document, after redactions are applied). If omitted, this parameter will default to true.

drawBorder - When true, the "normal" appearance of the redacted areas will have a border of 1 point, in the borderColor. When it is false, no border will be drawn. If omitted, this parameter will default to true.

borderColor - The color to draw the border around the "normal" appearance of each area. If omitted, and fillColor is not omitted, no border will be drawn. If both fillColor and BorderColor is omitted, border will be drawn in internalColor. If internalColor is also omitted, border will be drawn in black.

fillNormal - When true, the areas being redacted will be drawn, in the "normal" appearance, with an overlaying fill of the fillColor at the fillOpacity. When false, there will be no overlay fill. This paramter is considered false if omitted.

fillColor - The color applied as an overlay to the "normal" (Non redacted) area within the redaction areas. If this color is omitted, a "white" fill will be presumed.

fillOpacity - A value from 0 to 1.0 which is the opacity of the fill color(If this value is one, then the content of the redacted area will not be visible in the "normal" mode. If it is zero, then there will be no visible color overlaying the content to be redacted). If omitted, this will default to 1.0.

overlayText - The value of the string to be displayed over the redacted area. It will be scaled and/or repeated according to the value of later parameters. If omitted, it will be an empty string, and there will be no overlay text drawn.

textColor - The color to use in drawing the OverlayText. If this is omitted, white will be presumed.

textSize - The size, in points, to draw the text too. This may be overridden the scaleTofit value below. If omitted, it will default to 12.0.

repeat - When true, the overlay text will be repeated to fill the redacted area, when false, the overlay text will be displayed only once. When omitted, it is presumed to be false.

scaleToFit - When true, the text size will be decreased to just fill the redacted area. When false, the text size will be constant, as described in textSize. When omitted, this is presumed to be false.

Redaction

public Redaction(Page page,
 List<Quad> regions,
 Font font,
 Color internalColor,
 boolean fillRedacted,
 boolean drawBorder,
 Color borderColor,
 boolean fillNormal,
 Color fillColor,
 double fillOpacity,
 String overlayText)

Create a new Redaction annotation object with extended options .When Overlay Text is used, font is provided as a font. To create a potental redaction and place it elsewhere in the page's annotation array.

Parameters:

page - The page where this redaction mark is found.

regions - A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.

font - The font to be used when creating overlay text. For most efficiency, this font should be created prior to the first redaction, and used for all redactions. After the last redaction is created the font may be subset and embedded. Using this option, rather than specifying a font name, significantly speeds the creation of many redactions.

internalColor - The color of the redaction mark. This color is also used as the fill color when generating the replacement form for this redaction mark. The replacement form is the content that will be placed on the page when this mark is applied and the underlying content is removed.

fillRedacted - When true, the area being redacted will be filled with the internalColor in the redacted appearance(and in the final document, after redactions are applied). If omitted, this parameter will default to true.

drawBorder - When true, the "normal" appearance of the redacted areas will have a border of 1 point, in the borderColor. When it is false, no border will be drawn. If omitted, this parameter will default to true.

borderColor - The color to draw the border around the "normal" appearance of each area. If omitted, and fillColor is not omitted, no border will be drawn. If both fillColor and BorderColor is omitted, border will be drawn in internalColor. If internalColor is also omitted, border will be drawn in black.

fillNormal - When true, the areas being redacted will be drawn, in the "normal" appearance, with an overlaying fill of the fillColor at the fillOpacity. When false, there will be no overlay fill. This paramter is considered false if omitted.

fillColor - The color applied as an overlay to the "normal" (Non redacted) area within the redaction areas. If this color is omitted, a "white" fill will be presumed.

fillOpacity - A value from 0 to 1.0 which is the opacity of the fill color(If this value is one, then the content of the redacted area will not be visible in the "normal" mode. If it is zero, then there will be no visible color overlaying the content to be redacted). If omitted, this will default to 1.0.

overlayText - The value of the string to be displayed over the redacted area. It will be scaled and/or repeated according to the value of later parameters. If omitted, it will be an empty string, and there will be no overlay text drawn.

textColor - The color to use in drawing the OverlayText. If this is omitted, white will be presumed.

textSize - The size, in points, to draw the text too. This may be overridden the scaleTofit value below. If omitted, it will default to 12.0.

repeat - When true, the overlay text will be repeated to fill the redacted area, when false, the overlay text will be displayed only once. When omitted, it is presumed to be false.

scaleToFit - When true, the text size will be decreased to just fill the redacted area. When false, the text size will be constant, as described in textSize. When omitted, this is presumed to be false.

Redaction

public Redaction(Page page,
 List<Quad> regions,
 Font font,
 Color internalColor,
 boolean fillRedacted,
 boolean drawBorder,
 Color borderColor,
 boolean fillNormal,
 Color fillColor,
 double fillOpacity)

Create a new Redaction annotation object with extended options .When Overlay Text is used, font is provided as a font. To create a potental redaction and place it elsewhere in the page's annotation array.

Parameters:

page - The page where this redaction mark is found.

regions - A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.

font - The font to be used when creating overlay text. For most efficiency, this font should be created prior to the first redaction, and used for all redactions. After the last redaction is created the font may be subset and embedded. Using this option, rather than specifying a font name, significantly speeds the creation of many redactions.

internalColor - The color of the redaction mark. This color is also used as the fill color when generating the replacement form for this redaction mark. The replacement form is the content that will be placed on the page when this mark is applied and the underlying content is removed.

fillRedacted - When true, the area being redacted will be filled with the internalColor in the redacted appearance(and in the final document, after redactions are applied). If omitted, this parameter will default to true.

drawBorder - When true, the "normal" appearance of the redacted areas will have a border of 1 point, in the borderColor. When it is false, no border will be drawn. If omitted, this parameter will default to true.

borderColor - The color to draw the border around the "normal" appearance of each area. If omitted, and fillColor is not omitted, no border will be drawn. If both fillColor and BorderColor is omitted, border will be drawn in internalColor. If internalColor is also omitted, border will be drawn in black.

fillNormal - When true, the areas being redacted will be drawn, in the "normal" appearance, with an overlaying fill of the fillColor at the fillOpacity. When false, there will be no overlay fill. This paramter is considered false if omitted.

fillColor - The color applied as an overlay to the "normal" (Non redacted) area within the redaction areas. If this color is omitted, a "white" fill will be presumed.

fillOpacity - A value from 0 to 1.0 which is the opacity of the fill color(If this value is one, then the content of the redacted area will not be visible in the "normal" mode. If it is zero, then there will be no visible color overlaying the content to be redacted). If omitted, this will default to 1.0.

overlayText - The value of the string to be displayed over the redacted area. It will be scaled and/or repeated according to the value of later parameters. If omitted, it will be an empty string, and there will be no overlay text drawn.

textColor - The color to use in drawing the OverlayText. If this is omitted, white will be presumed.

textSize - The size, in points, to draw the text too. This may be overridden the scaleTofit value below. If omitted, it will default to 12.0.

repeat - When true, the overlay text will be repeated to fill the redacted area, when false, the overlay text will be displayed only once. When omitted, it is presumed to be false.

scaleToFit - When true, the text size will be decreased to just fill the redacted area. When false, the text size will be constant, as described in textSize. When omitted, this is presumed to be false.

Redaction

public Redaction(Page page,
 List<Quad> regions,
 Font font,
 Color internalColor,
 boolean fillRedacted,
 boolean drawBorder,
 Color borderColor,
 boolean fillNormal,
 Color fillColor)

Create a new Redaction annotation object with extended options .When Overlay Text is used, font is provided as a font. To create a potental redaction and place it elsewhere in the page's annotation array.

Parameters:

page - The page where this redaction mark is found.

regions - A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.

font - The font to be used when creating overlay text. For most efficiency, this font should be created prior to the first redaction, and used for all redactions. After the last redaction is created the font may be subset and embedded. Using this option, rather than specifying a font name, significantly speeds the creation of many redactions.

internalColor - The color of the redaction mark. This color is also used as the fill color when generating the replacement form for this redaction mark. The replacement form is the content that will be placed on the page when this mark is applied and the underlying content is removed.

fillRedacted - When true, the area being redacted will be filled with the internalColor in the redacted appearance(and in the final document, after redactions are applied). If omitted, this parameter will default to true.

drawBorder - When true, the "normal" appearance of the redacted areas will have a border of 1 point, in the borderColor. When it is false, no border will be drawn. If omitted, this parameter will default to true.

borderColor - The color to draw the border around the "normal" appearance of each area. If omitted, and fillColor is not omitted, no border will be drawn. If both fillColor and BorderColor is omitted, border will be drawn in internalColor. If internalColor is also omitted, border will be drawn in black.

fillNormal - When true, the areas being redacted will be drawn, in the "normal" appearance, with an overlaying fill of the fillColor at the fillOpacity. When false, there will be no overlay fill. This paramter is considered false if omitted.

fillColor - The color applied as an overlay to the "normal" (Non redacted) area within the redaction areas. If this color is omitted, a "white" fill will be presumed.

fillOpacity - A value from 0 to 1.0 which is the opacity of the fill color(If this value is one, then the content of the redacted area will not be visible in the "normal" mode. If it is zero, then there will be no visible color overlaying the content to be redacted). If omitted, this will default to 1.0.

overlayText - The value of the string to be displayed over the redacted area. It will be scaled and/or repeated according to the value of later parameters. If omitted, it will be an empty string, and there will be no overlay text drawn.

textColor - The color to use in drawing the OverlayText. If this is omitted, white will be presumed.

textSize - The size, in points, to draw the text too. This may be overridden the scaleTofit value below. If omitted, it will default to 12.0.

repeat - When true, the overlay text will be repeated to fill the redacted area, when false, the overlay text will be displayed only once. When omitted, it is presumed to be false.

scaleToFit - When true, the text size will be decreased to just fill the redacted area. When false, the text size will be constant, as described in textSize. When omitted, this is presumed to be false.

Redaction

public Redaction(Page page,
 List<Quad> regions,
 Font font,
 Color internalColor,
 boolean fillRedacted,
 boolean drawBorder,
 Color borderColor,
 boolean fillNormal)

Create a new Redaction annotation object with extended options .When Overlay Text is used, font is provided as a font. To create a potental redaction and place it elsewhere in the page's annotation array.

Parameters:

page - The page where this redaction mark is found.

regions - A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.

font - The font to be used when creating overlay text. For most efficiency, this font should be created prior to the first redaction, and used for all redactions. After the last redaction is created the font may be subset and embedded. Using this option, rather than specifying a font name, significantly speeds the creation of many redactions.

internalColor - The color of the redaction mark. This color is also used as the fill color when generating the replacement form for this redaction mark. The replacement form is the content that will be placed on the page when this mark is applied and the underlying content is removed.

fillRedacted - When true, the area being redacted will be filled with the internalColor in the redacted appearance(and in the final document, after redactions are applied). If omitted, this parameter will default to true.

drawBorder - When true, the "normal" appearance of the redacted areas will have a border of 1 point, in the borderColor. When it is false, no border will be drawn. If omitted, this parameter will default to true.

borderColor - The color to draw the border around the "normal" appearance of each area. If omitted, and fillColor is not omitted, no border will be drawn. If both fillColor and BorderColor is omitted, border will be drawn in internalColor. If internalColor is also omitted, border will be drawn in black.

fillNormal - When true, the areas being redacted will be drawn, in the "normal" appearance, with an overlaying fill of the fillColor at the fillOpacity. When false, there will be no overlay fill. This paramter is considered false if omitted.

fillColor - The color applied as an overlay to the "normal" (Non redacted) area within the redaction areas. If this color is omitted, a "white" fill will be presumed.

fillOpacity - A value from 0 to 1.0 which is the opacity of the fill color(If this value is one, then the content of the redacted area will not be visible in the "normal" mode. If it is zero, then there will be no visible color overlaying the content to be redacted). If omitted, this will default to 1.0.

overlayText - The value of the string to be displayed over the redacted area. It will be scaled and/or repeated according to the value of later parameters. If omitted, it will be an empty string, and there will be no overlay text drawn.

textColor - The color to use in drawing the OverlayText. If this is omitted, white will be presumed.

textSize - The size, in points, to draw the text too. This may be overridden the scaleTofit value below. If omitted, it will default to 12.0.

repeat - When true, the overlay text will be repeated to fill the redacted area, when false, the overlay text will be displayed only once. When omitted, it is presumed to be false.

scaleToFit - When true, the text size will be decreased to just fill the redacted area. When false, the text size will be constant, as described in textSize. When omitted, this is presumed to be false.

Redaction

public Redaction(Page page,
 List<Quad> regions,
 Font font,
 Color internalColor,
 boolean fillRedacted,
 boolean drawBorder,
 Color borderColor)

Create a new Redaction annotation object with extended options .When Overlay Text is used, font is provided as a font. To create a potental redaction and place it elsewhere in the page's annotation array.

Parameters:

page - The page where this redaction mark is found.

regions - A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.

font - The font to be used when creating overlay text. For most efficiency, this font should be created prior to the first redaction, and used for all redactions. After the last redaction is created the font may be subset and embedded. Using this option, rather than specifying a font name, significantly speeds the creation of many redactions.

internalColor - The color of the redaction mark. This color is also used as the fill color when generating the replacement form for this redaction mark. The replacement form is the content that will be placed on the page when this mark is applied and the underlying content is removed.

fillRedacted - When true, the area being redacted will be filled with the internalColor in the redacted appearance(and in the final document, after redactions are applied). If omitted, this parameter will default to true.

drawBorder - When true, the "normal" appearance of the redacted areas will have a border of 1 point, in the borderColor. When it is false, no border will be drawn. If omitted, this parameter will default to true.

borderColor - The color to draw the border around the "normal" appearance of each area. If omitted, and fillColor is not omitted, no border will be drawn. If both fillColor and BorderColor is omitted, border will be drawn in internalColor. If internalColor is also omitted, border will be drawn in black.

fillNormal - When true, the areas being redacted will be drawn, in the "normal" appearance, with an overlaying fill of the fillColor at the fillOpacity. When false, there will be no overlay fill. This paramter is considered false if omitted.

fillColor - The color applied as an overlay to the "normal" (Non redacted) area within the redaction areas. If this color is omitted, a "white" fill will be presumed.

fillOpacity - A value from 0 to 1.0 which is the opacity of the fill color(If this value is one, then the content of the redacted area will not be visible in the "normal" mode. If it is zero, then there will be no visible color overlaying the content to be redacted). If omitted, this will default to 1.0.

overlayText - The value of the string to be displayed over the redacted area. It will be scaled and/or repeated according to the value of later parameters. If omitted, it will be an empty string, and there will be no overlay text drawn.

textColor - The color to use in drawing the OverlayText. If this is omitted, white will be presumed.

textSize - The size, in points, to draw the text too. This may be overridden the scaleTofit value below. If omitted, it will default to 12.0.

repeat - When true, the overlay text will be repeated to fill the redacted area, when false, the overlay text will be displayed only once. When omitted, it is presumed to be false.

scaleToFit - When true, the text size will be decreased to just fill the redacted area. When false, the text size will be constant, as described in textSize. When omitted, this is presumed to be false.

Redaction

public Redaction(Page page,
 List<Quad> regions,
 Font font,
 Color internalColor,
 boolean fillRedacted,
 boolean drawBorder)

Create a new Redaction annotation object with extended options .When Overlay Text is used, font is provided as a font. To create a potental redaction and place it elsewhere in the page's annotation array.

Parameters:

page - The page where this redaction mark is found.

regions - A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.

font - The font to be used when creating overlay text. For most efficiency, this font should be created prior to the first redaction, and used for all redactions. After the last redaction is created the font may be subset and embedded. Using this option, rather than specifying a font name, significantly speeds the creation of many redactions.

internalColor - The color of the redaction mark. This color is also used as the fill color when generating the replacement form for this redaction mark. The replacement form is the content that will be placed on the page when this mark is applied and the underlying content is removed.

fillRedacted - When true, the area being redacted will be filled with the internalColor in the redacted appearance(and in the final document, after redactions are applied). If omitted, this parameter will default to true.

drawBorder - When true, the "normal" appearance of the redacted areas will have a border of 1 point, in the borderColor. When it is false, no border will be drawn. If omitted, this parameter will default to true.

borderColor - The color to draw the border around the "normal" appearance of each area. If omitted, and fillColor is not omitted, no border will be drawn. If both fillColor and BorderColor is omitted, border will be drawn in internalColor. If internalColor is also omitted, border will be drawn in black.

fillNormal - When true, the areas being redacted will be drawn, in the "normal" appearance, with an overlaying fill of the fillColor at the fillOpacity. When false, there will be no overlay fill. This paramter is considered false if omitted.

fillColor - The color applied as an overlay to the "normal" (Non redacted) area within the redaction areas. If this color is omitted, a "white" fill will be presumed.

fillOpacity - A value from 0 to 1.0 which is the opacity of the fill color(If this value is one, then the content of the redacted area will not be visible in the "normal" mode. If it is zero, then there will be no visible color overlaying the content to be redacted). If omitted, this will default to 1.0.

overlayText - The value of the string to be displayed over the redacted area. It will be scaled and/or repeated according to the value of later parameters. If omitted, it will be an empty string, and there will be no overlay text drawn.

textColor - The color to use in drawing the OverlayText. If this is omitted, white will be presumed.

textSize - The size, in points, to draw the text too. This may be overridden the scaleTofit value below. If omitted, it will default to 12.0.

repeat - When true, the overlay text will be repeated to fill the redacted area, when false, the overlay text will be displayed only once. When omitted, it is presumed to be false.

scaleToFit - When true, the text size will be decreased to just fill the redacted area. When false, the text size will be constant, as described in textSize. When omitted, this is presumed to be false.

Redaction

public Redaction(Page page,
 List<Quad> regions,
 Font font,
 Color internalColor,
 boolean fillRedacted)

Create a new Redaction annotation object with extended options .When Overlay Text is used, font is provided as a font. To create a potental redaction and place it elsewhere in the page's annotation array.

Parameters:

page - The page where this redaction mark is found.

regions - A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.

font - The font to be used when creating overlay text. For most efficiency, this font should be created prior to the first redaction, and used for all redactions. After the last redaction is created the font may be subset and embedded. Using this option, rather than specifying a font name, significantly speeds the creation of many redactions.

internalColor - The color of the redaction mark. This color is also used as the fill color when generating the replacement form for this redaction mark. The replacement form is the content that will be placed on the page when this mark is applied and the underlying content is removed.

fillRedacted - When true, the area being redacted will be filled with the internalColor in the redacted appearance(and in the final document, after redactions are applied). If omitted, this parameter will default to true.

drawBorder - When true, the "normal" appearance of the redacted areas will have a border of 1 point, in the borderColor. When it is false, no border will be drawn. If omitted, this parameter will default to true.

borderColor - The color to draw the border around the "normal" appearance of each area. If omitted, and fillColor is not omitted, no border will be drawn. If both fillColor and BorderColor is omitted, border will be drawn in internalColor. If internalColor is also omitted, border will be drawn in black.

fillNormal - When true, the areas being redacted will be drawn, in the "normal" appearance, with an overlaying fill of the fillColor at the fillOpacity. When false, there will be no overlay fill. This paramter is considered false if omitted.

fillColor - The color applied as an overlay to the "normal" (Non redacted) area within the redaction areas. If this color is omitted, a "white" fill will be presumed.

fillOpacity - A value from 0 to 1.0 which is the opacity of the fill color(If this value is one, then the content of the redacted area will not be visible in the "normal" mode. If it is zero, then there will be no visible color overlaying the content to be redacted). If omitted, this will default to 1.0.

overlayText - The value of the string to be displayed over the redacted area. It will be scaled and/or repeated according to the value of later parameters. If omitted, it will be an empty string, and there will be no overlay text drawn.

textColor - The color to use in drawing the OverlayText. If this is omitted, white will be presumed.

textSize - The size, in points, to draw the text too. This may be overridden the scaleTofit value below. If omitted, it will default to 12.0.

repeat - When true, the overlay text will be repeated to fill the redacted area, when false, the overlay text will be displayed only once. When omitted, it is presumed to be false.

scaleToFit - When true, the text size will be decreased to just fill the redacted area. When false, the text size will be constant, as described in textSize. When omitted, this is presumed to be false.

Redaction

public Redaction(Page page,
 List<Quad> regions,
 Font font,
 Color internalColor)

Create a new Redaction annotation object with extended options .When Overlay Text is used, font is provided as a font. To create a potental redaction and place it elsewhere in the page's annotation array.

Parameters:

page - The page where this redaction mark is found.

regions - A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.

font - The font to be used when creating overlay text. For most efficiency, this font should be created prior to the first redaction, and used for all redactions. After the last redaction is created the font may be subset and embedded. Using this option, rather than specifying a font name, significantly speeds the creation of many redactions.

internalColor - The color of the redaction mark. This color is also used as the fill color when generating the replacement form for this redaction mark. The replacement form is the content that will be placed on the page when this mark is applied and the underlying content is removed.

fillRedacted - When true, the area being redacted will be filled with the internalColor in the redacted appearance(and in the final document, after redactions are applied). If omitted, this parameter will default to true.

drawBorder - When true, the "normal" appearance of the redacted areas will have a border of 1 point, in the borderColor. When it is false, no border will be drawn. If omitted, this parameter will default to true.

borderColor - The color to draw the border around the "normal" appearance of each area. If omitted, and fillColor is not omitted, no border will be drawn. If both fillColor and BorderColor is omitted, border will be drawn in internalColor. If internalColor is also omitted, border will be drawn in black.

fillNormal - When true, the areas being redacted will be drawn, in the "normal" appearance, with an overlaying fill of the fillColor at the fillOpacity. When false, there will be no overlay fill. This paramter is considered false if omitted.

fillColor - The color applied as an overlay to the "normal" (Non redacted) area within the redaction areas. If this color is omitted, a "white" fill will be presumed.

fillOpacity - A value from 0 to 1.0 which is the opacity of the fill color(If this value is one, then the content of the redacted area will not be visible in the "normal" mode. If it is zero, then there will be no visible color overlaying the content to be redacted). If omitted, this will default to 1.0.

overlayText - The value of the string to be displayed over the redacted area. It will be scaled and/or repeated according to the value of later parameters. If omitted, it will be an empty string, and there will be no overlay text drawn.

textColor - The color to use in drawing the OverlayText. If this is omitted, white will be presumed.

textSize - The size, in points, to draw the text too. This may be overridden the scaleTofit value below. If omitted, it will default to 12.0.

repeat - When true, the overlay text will be repeated to fill the redacted area, when false, the overlay text will be displayed only once. When omitted, it is presumed to be false.

scaleToFit - When true, the text size will be decreased to just fill the redacted area. When false, the text size will be constant, as described in textSize. When omitted, this is presumed to be false.

Redaction

public Redaction(Page page,
 List<Quad> regions,
 Font font)

Create a new Redaction annotation object with extended options .When Overlay Text is used, font is provided as a font. To create a potental redaction and place it elsewhere in the page's annotation array.

Parameters:

page - The page where this redaction mark is found.

regions - A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.

font - The font to be used when creating overlay text. For most efficiency, this font should be created prior to the first redaction, and used for all redactions. After the last redaction is created the font may be subset and embedded. Using this option, rather than specifying a font name, significantly speeds the creation of many redactions.

internalColor - The color of the redaction mark. This color is also used as the fill color when generating the replacement form for this redaction mark. The replacement form is the content that will be placed on the page when this mark is applied and the underlying content is removed.

fillRedacted - When true, the area being redacted will be filled with the internalColor in the redacted appearance(and in the final document, after redactions are applied). If omitted, this parameter will default to true.

drawBorder - When true, the "normal" appearance of the redacted areas will have a border of 1 point, in the borderColor. When it is false, no border will be drawn. If omitted, this parameter will default to true.

borderColor - The color to draw the border around the "normal" appearance of each area. If omitted, and fillColor is not omitted, no border will be drawn. If both fillColor and BorderColor is omitted, border will be drawn in internalColor. If internalColor is also omitted, border will be drawn in black.

fillNormal - When true, the areas being redacted will be drawn, in the "normal" appearance, with an overlaying fill of the fillColor at the fillOpacity. When false, there will be no overlay fill. This paramter is considered false if omitted.

fillColor - The color applied as an overlay to the "normal" (Non redacted) area within the redaction areas. If this color is omitted, a "white" fill will be presumed.

fillOpacity - A value from 0 to 1.0 which is the opacity of the fill color(If this value is one, then the content of the redacted area will not be visible in the "normal" mode. If it is zero, then there will be no visible color overlaying the content to be redacted). If omitted, this will default to 1.0.

overlayText - The value of the string to be displayed over the redacted area. It will be scaled and/or repeated according to the value of later parameters. If omitted, it will be an empty string, and there will be no overlay text drawn.

textColor - The color to use in drawing the OverlayText. If this is omitted, white will be presumed.

textSize - The size, in points, to draw the text too. This may be overridden the scaleTofit value below. If omitted, it will default to 12.0.

repeat - When true, the overlay text will be repeated to fill the redacted area, when false, the overlay text will be displayed only once. When omitted, it is presumed to be false.

scaleToFit - When true, the text size will be decreased to just fill the redacted area. When false, the text size will be constant, as described in textSize. When omitted, this is presumed to be false.

Method Details

delete

public void delete()

Overrides:

delete in class Annotation

getInternalColor

public Color getInternalColor()

Get the color used as the replacement background.

Returns:

Color used for the replacement.

setInternalColor

public void setInternalColor(Color col)

Set the color used as the replacement background.

Parameters:

col - The color of the redaction mark. This color is also used as the fill color when generating the replacement form for this redaction mark. The replacement form is the content that will be placed on the page when this mark is applied and the underlying content is removed.

getBorderColor

public Color getBorderColor()

Get the color used as the "normal" border.

Returns:

Color used for the "normal" border.

setBorderColor

public void setBorderColor(Color col)

Set the color used as the "normal" border.

Parameters:

col - The color of the border when the annotation is displayed in the page prior to application of redactions.

getTextColor

public Color getTextColor()

Get the color used for the overlay text.

Returns:

Color used for the overlay text.

setTextColor

public void setTextColor(Color col)

Set the color used for the overlay text.

Parameters:

col - The color of the text when the annotation is displayed as redacted, or when the redactions are applied.

setFillColor

public void setFillColor(Color col,
 double opacity)

Set the color used to fill the "normal" appearance.

Parameters:

col - The color which will fill the annotation when it is viewed in the "normal" or pre-redacted appearance.

opacity - The amount of opacity to apply to the fill color. If this value is zero, not color will be seen. If it is 1.0, then the underlying content of the unredacted document will not be visible.

getFillColor

public Color getFillColor()

Get the color used to fill the "normal" appearance area.

Returns:

Color used to fill the "normal" appearance area.

getFillOpacity

public double getFillOpacity()

Get the opacity applied to the fill color in "normal" appearance.

Returns:

Opacity applied to the fill color in "normal" appearance.

getAnnotationFeatureLevel

public double getAnnotationFeatureLevel()

Get the minimum PDF version necessary to support the features used in this annotation.

Overrides:

getAnnotationFeatureLevel in class Annotation

Returns:

PDF Version Number

setAnnotationFeatureLevel

public void setAnnotationFeatureLevel(double featureLevel)

Removes features not supported in the supplied version number.

Overrides:

setAnnotationFeatureLevel in class Annotation

Parameters:

featureLevel - Target PDF version number

getPageNo

public int getPageNo()

Get the page number where the redaction occurs.

Returns:

base zero page number

setPageNo

public void setPageNo(int pgNo)

Sets the page number where the redaction occurs.

Parameters:

pgNo - Base zero page number

getQuads

public List<Quad> getQuads()

A list of quads to mark. Each quad encompasses a word or group of contiguous words in the text underlying the annotation.

Returns:

A vector of CQuad objects for the redaction.

setQuads

public void setQuads(List<Quad> theQuads)

A list of quads to mark. Each quad encompasses a word or group of contiguous words in the text underlying the annotation.

Parameters:

theQuads - std::vector of Quads

getOverlayText

public String getOverlayText()

Get the optional overlay text of the redaction.

Returns:

the overlay text of the redaction

setOverlayText

public void setOverlayText(String otext)

Set the optional overlay text of the redaction.

Parameters:

otext - std::wstring of text to be written over redaction.

getAlign

public HorizontalAlignment getAlign()

Get the horizontal alignment for the redaction text.

Returns:

Horiziontal Alignment

setAlign

public void setAlign(HorizontalAlignment halign)

Sets the horizontal alignment for the redaction text.

Parameters:

halign - desired Horiziontal alignment

setFontSize

public void setFontSize(double fontsize)

Set font size for text

Parameters:

fontsize - Size to draw overlay type at. if set to zero, 10.0 point type will be drawn.

getFontSize

public double getFontSize()

Get font size for the text;

Returns:

current font size

setFontFace

public void setFontFace(String fontName)

Set Font face for the text

Parameters:

fontName - std::wstring name of font to use for type. if omitted, "Helvetica" will be used.

getFontFace

public String getFontFace()

Get Font face for the text

Returns:

current Font face

setNote

public void setNote(String notetext)

Set the text string to be used as the Popup Contents

Parameters:

notetext - Contents to use on the popup comments box.

getNote

public String getNote()

Get the text string to be used as the Popup contents

Returns:

Note text

setRepeat

public void setRepeat(boolean Value)

Set the repeat value

Parameters:

Value - True will repeat fill string, false will display string only once.

getRepeat

public boolean getRepeat()

Get the repeat value

Returns:

repeat value

setScaleToFit

public void setScaleToFit(boolean Value)

Set the ScaleToFit value

Parameters:

Value - True will scale text down to fit into area, false will not.

getScaleToFit

public boolean getScaleToFit()

Get the ScaleToFit value

Returns:

Scale To Fit value

getDrawBorder

public boolean getDrawBorder()

Get Draw Border option

Returns:

boolean value of Draw Border Option If true, border will be drawn in Normal appearance in specified color, If false, no border will be drawn in Normal Appearance.

setDrawBorder

public void setDrawBorder(boolean Option)

Set Draw Border option

Parameters:

Option - boolean value to set Draw Border Option If true, border will be drawn in Normal appearance in specified color, If false, no border will be drawn in Normal Appearance.

getFillNormal

public boolean getFillNormal()

Get Fill Normal Appearance option

Returns:

boolean value of Fill Normal Appearance Option If true, the Normal Appearance will show as filled with the fill color and opacity, If false, Normal Appearance areas will not be filled.

setFillNormal

public void setFillNormal(boolean Option)

Set Fill Normal Appearance option

Parameters:

Option - boolean value to set Draw Border Option If true, the Normal Appearance will show as filled with the fill color and opacity, If false, Normal Appearance areas will not be filled.

getFillRedacted

public boolean getFillRedacted()

Get Fill Redacted Appearance option

Returns:

boolean value of Fill redacted Appearance Option If true, the Redacted Appearance will show as filled with the specfied color. If false, Redacted Appearance areas will not be filled (They will be left white).

setFillRedacted

public void setFillRedacted(boolean Option)

Set Fill Redacted Appearance option

Parameters:

Option - boolean value to set Draw Border Option If true, the Redacted Appearance will show as filled with the specfied, If false, Redacted Appearance areas will not be filled (They will be left white).

getOverlayFont

public Font getOverlayFont()

Get Overlay Text Font

Returns:

CFont value of overlay Text Font

setOverlayFont

public void setOverlayFont(Font font)

Set Overlay Text Font

Parameters:

font - When the specified font is not null, it will be used to display the overlay text. When this value is not null, the Overlay Font Name will be ignored.