Redaction Class

class Redaction : Annotation

Namespace:com::datalogics::PDFL

Inherits from:: Annotation

Detailed Description

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

Referenced by

Document

Uses types

Annotation Color Font Form OptionalContentContext OptionalContentMembershipDict PDFDict Page Quad Rect

Constructor & Destructor Documentation

Redaction(Page page, java.util.List< Quad > regions)

Parameters

page: Page: The page where this redaction mark is found.
regions: java.util.List< Quad >: A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.

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.

Redaction(Page page, java.util.List< Quad > regions, Color internalColor)

Parameters

page: Page: The page where this redaction mark is found.
regions: java.util.List< Quad >: A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.
internalColor: Color: 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.

Redaction(Page page, java.util.List< Quad > regions, Color internalColor, boolean fillRedacted)

Parameters

page: Page: The page where this redaction mark is found.
regions: java.util.List< Quad >: A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.
internalColor: Color: 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: boolean: 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.

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

Parameters

page: Page: The page where this redaction mark is found.
regions: java.util.List< Quad >: A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.
internalColor: Color: 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: boolean: 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: boolean: 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.

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

Parameters

page: Page: The page where this redaction mark is found.
regions: java.util.List< Quad >: A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.
internalColor: Color: 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: boolean: 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: boolean: 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: Color: 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.

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

Parameters

page: Page: The page where this redaction mark is found.
regions: java.util.List< Quad >: A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.
internalColor: Color: 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: boolean: 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: boolean: 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: Color: 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: boolean: 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.

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

Parameters

page: Page: The page where this redaction mark is found.
regions: java.util.List< Quad >: A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.
internalColor: Color: 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: boolean: 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: boolean: 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: Color: 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: boolean: 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: Color: 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.

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

Parameters

page: Page: The page where this redaction mark is found.
regions: java.util.List< Quad >: A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.
internalColor: Color: 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: boolean: 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: boolean: 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: Color: 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: boolean: 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: Color: 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: double: 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.

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

Parameters

page: Page: The page where this redaction mark is found.
regions: java.util.List< Quad >: A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.
internalColor: Color: 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: boolean: 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: boolean: 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: Color: 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: boolean: 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: Color: 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: double: 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: String: 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.

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

Parameters

page: Page: The page where this redaction mark is found.
regions: java.util.List< Quad >: A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.
internalColor: Color: 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: boolean: 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: boolean: 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: Color: 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: boolean: 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: Color: 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: double: 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: String: 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: Color: The color to use in drawing the OverlayText. If this is omitted, white will be presumed.

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

Parameters

page: Page: The page where this redaction mark is found.
regions: java.util.List< Quad >: A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.
internalColor: Color: 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: boolean: 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: boolean: 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: Color: 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: boolean: 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: Color: 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: double: 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: String: 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: Color: The color to use in drawing the OverlayText. If this is omitted, white will be presumed.
fontName: String: 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.

Redaction(Page page, java.util.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)

Parameters

page: Page: The page where this redaction mark is found.
regions: java.util.List< Quad >: A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.
internalColor: Color: 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: boolean: 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: boolean: 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: Color: 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: boolean: 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: Color: 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: double: 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: String: 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: Color: The color to use in drawing the OverlayText. If this is omitted, white will be presumed.
fontName: String: 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: double: 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.

Redaction(Page page, java.util.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)

Parameters

page: Page: The page where this redaction mark is found.
regions: java.util.List< Quad >: A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.
internalColor: Color: 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: boolean: 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: boolean: 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: Color: 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: boolean: 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: Color: 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: double: 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: String: 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: Color: The color to use in drawing the OverlayText. If this is omitted, white will be presumed.
fontName: String: 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: double: 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: boolean: 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.

Redaction(Page page, java.util.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)

Parameters

page: Page: The page where this redaction mark is found.
regions: java.util.List< Quad >: A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.
internalColor: Color: 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: boolean: 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: boolean: 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: Color: 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: boolean: 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: Color: 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: double: 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: String: 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: Color: The color to use in drawing the OverlayText. If this is omitted, white will be presumed.
fontName: String: 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: double: 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: boolean: 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: boolean: 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(Page page, java.util.List< Quad > regions, Font font)

Parameters

page: Page: The page where this redaction mark is found.
regions: java.util.List< Quad >: A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.
font: 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.

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.

Redaction(Page page, java.util.List< Quad > regions, Font font, Color internalColor)

Parameters

page: Page: The page where this redaction mark is found.
regions: java.util.List< Quad >: A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.
font: 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: Color: 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.

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

Parameters

page: Page: The page where this redaction mark is found.
regions: java.util.List< Quad >: A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.
font: 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: Color: 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: boolean: 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.

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

Parameters

page: Page: The page where this redaction mark is found.
regions: java.util.List< Quad >: A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.
font: 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: Color: 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: boolean: 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: boolean: 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.

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

Parameters

page: Page: The page where this redaction mark is found.
regions: java.util.List< Quad >: A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.
font: 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: Color: 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: boolean: 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: boolean: 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: Color: 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.

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

Parameters

page: Page: The page where this redaction mark is found.
regions: java.util.List< Quad >: A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.
font: 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: Color: 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: boolean: 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: boolean: 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: Color: 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: boolean: 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.

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

Parameters

page: Page: The page where this redaction mark is found.
regions: java.util.List< Quad >: A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.
font: 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: Color: 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: boolean: 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: boolean: 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: Color: 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: boolean: 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: Color: 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.

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

Parameters

page: Page: The page where this redaction mark is found.
regions: java.util.List< Quad >: A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.
font: 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: Color: 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: boolean: 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: boolean: 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: Color: 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: boolean: 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: Color: 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: double: 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.

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

Parameters

page: Page: The page where this redaction mark is found.
regions: java.util.List< Quad >: A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.
font: 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: Color: 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: boolean: 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: boolean: 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: Color: 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: boolean: 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: Color: 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: double: 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: String: 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.

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

Parameters

page: Page: The page where this redaction mark is found.
regions: java.util.List< Quad >: A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.
font: 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: Color: 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: boolean: 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: boolean: 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: Color: 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: boolean: 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: Color: 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: double: 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: String: 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: Color: The color to use in drawing the OverlayText. If this is omitted, white will be presumed.

Redaction(Page page, java.util.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)

Parameters

page: Page: The page where this redaction mark is found.
regions: java.util.List< Quad >: A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.
font: 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: Color: 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: boolean: 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: boolean: 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: Color: 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: boolean: 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: Color: 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: double: 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: String: 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: Color: The color to use in drawing the OverlayText. If this is omitted, white will be presumed.
textSize: double: 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.

Redaction(Page page, java.util.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)

Parameters

page: Page: The page where this redaction mark is found.
regions: java.util.List< Quad >: A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.
font: 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: Color: 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: boolean: 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: boolean: 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: Color: 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: boolean: 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: Color: 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: double: 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: String: 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: Color: The color to use in drawing the OverlayText. If this is omitted, white will be presumed.
textSize: double: 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: boolean: 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.

Redaction(Page page, java.util.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)

Parameters

page: Page: The page where this redaction mark is found.
regions: java.util.List< Quad >: A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.
font: 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: Color: 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: boolean: 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: boolean: 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: Color: 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: boolean: 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: Color: 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: double: 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: String: 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: Color: The color to use in drawing the OverlayText. If this is omitted, white will be presumed.
textSize: double: 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: boolean: 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: boolean: 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.

Member Function Documentation

synchronized void delete(Boolean disposing)

Parameters

disposing: Boolean

Returns:

synchronized void

synchronized void delete()

Returns:

synchronized void

boolean equals(Object rhs)

Parameters

rhs: Object

Returns:

boolean

void finalize()

Returns:

void

Form generateAppearance()

Returns:

Form

A Form representing the visual appearance, or null if the appearance could not be generated.

Generate a new appearance stream with the current annotation properties. The resulting Form can then be used to set the annotation's appearance, such as by calling SetNormalAppearance.

HorizontalAlignment getAlign()

Returns:

HorizontalAlignment

Horiziontal Alignment

Get the horizontal alignment for the redaction text.

double getAnnotationFeatureLevel()

Returns:

double

PDF Version Number

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

Color getBorderColor()

Returns:

Color

Color used for the "normal" border.

Get the color used as the "normal" border.

Color getColor()

Returns:

Color

The annotation's color.

The color of the annotation.

String getContents()

Returns:

String

The annotation's text contents.

The text contents of the annotation. The text to be displayed for the annotation or, if this type of annotation does not display text, an alternate description of the annotation's contents in human-readable form.

boolean getDrawBorder()

Returns:

boolean

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.

Get Draw Border option

Color getFillColor()

Returns:

Color

Color used to fill the "normal" appearance area.

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

boolean getFillNormal()

Returns:

boolean

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.

Get Fill Normal Appearance option

double getFillOpacity()

Returns:

double

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

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

boolean getFillRedacted()

Returns:

boolean

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).

Get Fill Redacted Appearance option

java.util.EnumSet< AnnotationFlags > getFlags()

Returns:

java.util.EnumSet< AnnotationFlags >

The annotation's flags.

The flags for the annotation.

String getFontFace()

Returns:

String

current Font face

Get Font face for the text

double getFontSize()

Returns:

double

current font size

Get font size for the text;

Color getInteriorColor()

Returns:

Color

The interior fill color, or null if no interior color is set.

The interior color with which to fill the annotation's rectangle or circle. The color of the border itself can be retrieved from Annotation.Color.

Color getInternalColor()

Returns:

Color

Color used for the replacement.

Get the color used as the replacement background.

Form getNormalAppearance()

Returns:

Form

A Form representing the annotation's normal appearance, or null if no normal appearance has been set.

The normal appearance of the annotation, represented as a Form XObject.

String getNote()

Returns:

String

Note text

Get the text string to be used as the Popup contents

double getOpacity()

Returns:

double

The opacity value for this annotation.

The constant opacity value used in painting a Markup annotation. Opacity is a range from 0.0 (fully transparent) to 1.0 (fully opaque).

OptionalContentMembershipDict getOptionalContentMembershipDict()

Returns:

OptionalContentMembershipDict

the OptionalContentMembershipDict

The OptionalContentMembershipDict property for this Annotation.

Setting this property will attach the Annotation to an OptionalContentMembershipDict; it will then be associated with the OptionalContentGroups and be subject to the VisibilityPolicy and VisibilityExpression of that MembershipDict.

By setting this property to null, the Annotation is detached from any OptionalContentMembershipDict.

Font getOverlayFont()

Returns:

Font

CFont value of overlay Text Font

Get Overlay Text Font

String getOverlayText()

Returns:

String

the overlay text of the redaction

Get the optional overlay text of the redaction.

PDFDict getPDFDict()

Returns:

PDFDict

The PDFDict associated with this annotation.

The underlying PDF dictionary for this annotation. Retrieves the PDFDict representation of this annotation object.

int getPageNo()

Returns:

int

base zero page number

Get the page number where the redaction occurs.

java.util.List< Quad > getQuads()

Returns:

java.util.List< Quad >

A vector of CQuad objects for the redaction.

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

Rect getRect()

Returns:

Rect

The annotation's bounding rectangle in user space coordinates.

The size and location of the annotation on its page.

boolean getRepeat()

Returns:

boolean

repeat value

Get the repeat value

boolean getScaleToFit()

Returns:

boolean

Scale To Fit value

Get the ScaleToFit value

String getSubtype()

Returns:

String

The subtype string (e.g. "Circle", "Square", "Line").

The annotation's subtype.

Color getTextColor()

Returns:

Color

Color used for the overlay text.

Get the color used for the overlay text.

String getTitle()

Returns:

String

The title string.

The title of the annotation.

boolean hasRichTextData()

Returns:

boolean

true if the annotation contains Rich Text String content.

Checks the annotation for Rich Text String content (PDFReference 1.7 Section 8.6.2). Annotations that contain Rich Text String content and do not have a normal appearance set will not be visible when rendering the page.

boolean isCurrentlyVisible(OptionalContentContext occ)

Parameters

occ: OptionalContentContext: The optional content context in which to check visibility.

Returns:

boolean

true if the annotation is currently visible.

Tests whether an annotation is visible in a given optional content context, considering the current ON-OFF states of the optional-content groups in the optional-content dictionary (OCMD) and the dictionary's visibility policy.

If the annotation occurs more than once within the content, this method only checks the visibility of the first occurrence of the annotation.

This method determines visibility without considering the visbility of the Content object that the annotation belongs to. To determine the visibility of an annotation while taking the Content's visibility into consideration, use the alternate version of this method.

void setAlign(HorizontalAlignment halign)

Parameters

halign: HorizontalAlignment: desired Horiziontal alignment

Returns:

void

Sets the horizontal alignment for the redaction text.

void setAnnotationFeatureLevel(double featureLevel)

Parameters

featureLevel: double: Target PDF version number

Returns:

void

Removes features not supported in the supplied version number.

void setBorderColor(Color col)

Parameters

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

Returns:

void

Set the color used as the "normal" border.

void setColor(Color color)

Parameters

color: Color: The new color to set.

Returns:

void

The color of the annotation.

void setContents(String contents)

Parameters

contents: String: The new text contents.

Returns:

void

void setDrawBorder(boolean Option)

Parameters

Option: boolean: 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.

Returns:

void

Set Draw Border option

void setFillColor(Color col, double opacity)

Parameters

col: Color: The color which will fill the annotation when it is viewed in the "normal" or pre-redacted appearance.
opacity: double: 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.

Returns:

void

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

void setFillNormal(boolean Option)

Parameters

Option: boolean: 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.

Returns:

void

Set Fill Normal Appearance option

void setFillRedacted(boolean Option)

Parameters

Option: boolean: 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).

Returns:

void

Set Fill Redacted Appearance option

void setFlags(java.util.EnumSet< AnnotationFlags > flags)

Parameters

flags: java.util.EnumSet< AnnotationFlags >: The new annotation flags to set.

Returns:

void

The flags for the annotation.

void setFontFace(String fontName)

Parameters

fontName: String: UTF-8 name of font to use for type. if omitted, "Helvetica" will be used.

Returns:

void

Set Font face for the text

void setFontSize(double fontsize)

Parameters

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

Returns:

void

Set font size for text

void setInteriorColor(Color color)

Parameters

color: Color: The new interior fill color. Pass null to remove the interior color.

Returns:

void

The interior color with which to fill the annotation's rectangle or circle. Only RGB colors are allowed.

The color of the border itself can be retrieved from Annotation.Color.

void setInternalColor(Color col)

Parameters

col: Color: 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.

Returns:

void

Set the color used as the replacement background.

void setNormalAppearance(Form form)

Parameters

form: Form: The Form to use as the annotation's normal appearance.

Returns:

void

The normal appearance of the annotation, represented as a Form XObject.

void setNote(String notetext)

Parameters

notetext: String: Contents to use on the popup comments box.

Returns:

void

Set the text string to be used as the Popup Contents

void setOpacity(double opacityValue)

Parameters

opacityValue: double: The new opacity value to set.

Returns:

void

The constant opacity value used in painting a Markup annotation. Opacity is a range from 0.0 (fully transparent) to 1.0 (fully opaque).

void setOptionalContentMembershipDict(OptionalContentMembershipDict ocmd)

Parameters

ocmd: OptionalContentMembershipDict: the OptionalContentMembershipDict

Returns:

void

The OptionalContentMembershipDict property for this Annotation.

By setting this property to null, the Annotation is detached from any OptionalContentMembershipDict.

void setOverlayFont(Font font)

Parameters

font: Font: The font to use for drawing the overlay text.

Returns:

void

Set Overlay Text 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.

void setOverlayText(String otext)

Parameters

otext: String: UTF-8 text to be written over redaction.

Returns:

void

Set the optional overlay text of the redaction.

void setPageNo(int pgNo)

Parameters

pgNo: int: Base zero page number

Returns:

void

Sets the page number where the redaction occurs.

void setQuads(java.util.List< Quad > theQuads)

Parameters

theQuads: java.util.List< Quad >: std.vector of Quads

Returns:

void

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

void setRect(Rect rect)

Parameters

rect: Rect: The new bounding rectangle in user space coordinates.

Returns:

void

The size and location of the annotation on its page.

void setRepeat(boolean Value)

Parameters

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

Returns:

void

Set the repeat value

void setScaleToFit(boolean Value)

Parameters

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

Returns:

void

Set the ScaleToFit value

void setTextColor(Color col)

Parameters

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

Returns:

void

Set the color used for the overlay text.

void setTitle(String title)

Parameters

title: String: The new title string.

Returns:

void

The title of the annotation.

String toString()

Returns:

String

A string describing this annotation, including its type and rectangle.

Returns a string representation of this annotation.