Redaction Class Documentation

classRedaction : 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

Constructor & Destructor Documentation

Redaction

Redaction(Pagepage, 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

Redaction(Pagepage, java.util.List< Quad >regions, ColorinternalColor)

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.

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

Redaction(Pagepage, java.util.List< Quad >regions, ColorinternalColor, booleanfillRedacted)

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.

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

Redaction(Pagepage, java.util.List< Quad >regions, ColorinternalColor, booleanfillRedacted, booleandrawBorder)

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.

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

Redaction(Pagepage, java.util.List< Quad >regions, ColorinternalColor, booleanfillRedacted, booleandrawBorder, ColorborderColor)

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.

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

Redaction(Pagepage, java.util.List< Quad >regions, ColorinternalColor, booleanfillRedacted, booleandrawBorder, ColorborderColor, booleanfillNormal)

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.

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

Redaction(Pagepage, java.util.List< Quad >regions, ColorinternalColor, booleanfillRedacted, booleandrawBorder, ColorborderColor, booleanfillNormal, ColorfillColor)

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.

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

Redaction(Pagepage, java.util.List< Quad >regions, ColorinternalColor, booleanfillRedacted, booleandrawBorder, ColorborderColor, booleanfillNormal, ColorfillColor, doublefillOpacity)

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.

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

Redaction(Pagepage, java.util.List< Quad >regions, ColorinternalColor, booleanfillRedacted, booleandrawBorder, ColorborderColor, booleanfillNormal, ColorfillColor, doublefillOpacity, StringoverlayText)

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.

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

Redaction(Pagepage, java.util.List< Quad >regions, ColorinternalColor, booleanfillRedacted, booleandrawBorder, ColorborderColor, booleanfillNormal, ColorfillColor, doublefillOpacity, StringoverlayText, ColortextColor)

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.

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

Redaction(Pagepage, java.util.List< Quad >regions, ColorinternalColor, booleanfillRedacted, booleandrawBorder, ColorborderColor, booleanfillNormal, ColorfillColor, doublefillOpacity, StringoverlayText, ColortextColor, StringfontName)

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.

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

Redaction(Pagepage, java.util.List< Quad >regions, ColorinternalColor, booleanfillRedacted, booleandrawBorder, ColorborderColor, booleanfillNormal, ColorfillColor, doublefillOpacity, StringoverlayText, ColortextColor, StringfontName, doubletextSize)

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.

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

Redaction(Pagepage, java.util.List< Quad >regions, ColorinternalColor, booleanfillRedacted, booleandrawBorder, ColorborderColor, booleanfillNormal, ColorfillColor, doublefillOpacity, StringoverlayText, ColortextColor, StringfontName, doubletextSize, booleanrepeat)

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.

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

Redaction(Pagepage, java.util.List< Quad >regions, ColorinternalColor, booleanfillRedacted, booleandrawBorder, ColorborderColor, booleanfillNormal, ColorfillColor, doublefillOpacity, StringoverlayText, ColortextColor, StringfontName, doubletextSize, booleanrepeat, booleanscaleToFit)

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.

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

Redaction(Pagepage, java.util.List< Quad >regions, Fontfont)

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

Redaction(Pagepage, java.util.List< Quad >regions, Fontfont, ColorinternalColor)

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.

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

Redaction(Pagepage, java.util.List< Quad >regions, Fontfont, ColorinternalColor, booleanfillRedacted)

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.

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

Redaction(Pagepage, java.util.List< Quad >regions, Fontfont, ColorinternalColor, booleanfillRedacted, booleandrawBorder)

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.

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

Redaction(Pagepage, java.util.List< Quad >regions, Fontfont, ColorinternalColor, booleanfillRedacted, booleandrawBorder, ColorborderColor)

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.

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

Redaction(Pagepage, java.util.List< Quad >regions, Fontfont, ColorinternalColor, booleanfillRedacted, booleandrawBorder, ColorborderColor, booleanfillNormal)

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.

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

Redaction(Pagepage, java.util.List< Quad >regions, Fontfont, ColorinternalColor, booleanfillRedacted, booleandrawBorder, ColorborderColor, booleanfillNormal, ColorfillColor)

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.

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

Redaction(Pagepage, java.util.List< Quad >regions, Fontfont, ColorinternalColor, booleanfillRedacted, booleandrawBorder, ColorborderColor, booleanfillNormal, ColorfillColor, doublefillOpacity)

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.

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

Redaction(Pagepage, java.util.List< Quad >regions, Fontfont, ColorinternalColor, booleanfillRedacted, booleandrawBorder, ColorborderColor, booleanfillNormal, ColorfillColor, doublefillOpacity, StringoverlayText)

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.

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

Redaction(Pagepage, java.util.List< Quad >regions, Fontfont, ColorinternalColor, booleanfillRedacted, booleandrawBorder, ColorborderColor, booleanfillNormal, ColorfillColor, doublefillOpacity, StringoverlayText, ColortextColor)

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.

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

Redaction(Pagepage, java.util.List< Quad >regions, Fontfont, ColorinternalColor, booleanfillRedacted, booleandrawBorder, ColorborderColor, booleanfillNormal, ColorfillColor, doublefillOpacity, StringoverlayText, ColortextColor, doubletextSize)

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.

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

Redaction(Pagepage, java.util.List< Quad >regions, Fontfont, ColorinternalColor, booleanfillRedacted, booleandrawBorder, ColorborderColor, booleanfillNormal, ColorfillColor, doublefillOpacity, StringoverlayText, ColortextColor, doubletextSize, booleanrepeat)

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.

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

Redaction(Pagepage, java.util.List< Quad >regions, Fontfont, ColorinternalColor, booleanfillRedacted, booleandrawBorder, ColorborderColor, booleanfillNormal, ColorfillColor, doublefillOpacity, StringoverlayText, ColortextColor, doubletextSize, booleanrepeat, booleanscaleToFit)

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.

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.

Member Function Documentation

DisposeChildren

voidDisposeChildren()

Returns:

void

[static initializer]

static void[static initializer]()

delete

synchronized voiddelete(Booleandisposing)

Parameters

disposing: Boolean

Returns:

synchronized void

delete

synchronized voiddelete()

Returns:

synchronized void

equals

booleanequals(Objectrhs)

Parameters

rhs: Object

Returns:

boolean

finalize

voidfinalize()

Returns:

void

generateAppearance

FormgenerateAppearance()

Returns:

Form

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.

getAlign

HorizontalAlignmentgetAlign()

Returns:

Horiziontal Alignment

Get the horizontal alignment for the redaction text.

getAnnotationFeatureLevel

doublegetAnnotationFeatureLevel()

Returns:

PDF Version Number

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

getBorderColor

ColorgetBorderColor()

Returns:

Color used for the "normal" border.

Get the color used as the "normal" border.

getColor

ColorgetColor()

Returns:

Color

The color of the annotation.

getContents

StringgetContents()

Returns:

String

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.

getDrawBorder

booleangetDrawBorder()

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.

Get Draw Border option

getFillColor

ColorgetFillColor()

Returns:

Color used to fill the "normal" appearance area.

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

getFillNormal

booleangetFillNormal()

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.

Get Fill Normal Appearance option

getFillOpacity

doublegetFillOpacity()

Returns:

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

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

getFillRedacted

booleangetFillRedacted()

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

Get Fill Redacted Appearance option

getFlags

java.util.EnumSet< AnnotationFlags >getFlags()

Returns:

java.util.EnumSet< AnnotationFlags >

The flags for the annotation.

getFontFace

StringgetFontFace()

Returns:

current Font face

Get Font face for the text

getFontSize

doublegetFontSize()

Returns:

current font size

Get font size for the text;

getInteriorColor

ColorgetInteriorColor()

Returns:

Color

The interior color with which to fill the annotation's line endings.

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

getInternalColor

ColorgetInternalColor()

Returns:

Color used for the replacement.

Get the color used as the replacement background.

getNormalAppearance

FormgetNormalAppearance()

Returns:

Form

getNote

StringgetNote()

Returns:

Note text

Get the text string to be used as the Popup contents

getOpacity

doublegetOpacity()

Returns:

double

The optional constant opacity value that shall be used in painting a Markup annotation.

Opacity is a range from 0.0 (fully transparent) to 1.0 (fully opaque).

getOptionalContentMembershipDict

OptionalContentMembershipDictgetOptionalContentMembershipDict()

Returns:

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.

getOverlayFont

FontgetOverlayFont()

Returns:

CFont value of overlay Text Font

Get Overlay Text Font

getOverlayText

StringgetOverlayText()

Returns:

the overlay text of the redaction

Get the optional overlay text of the redaction.

getPDFDict

PDFDictgetPDFDict()

Returns:

PDFDict

Retrieve the PDFObject representation of this object

getPageNo

intgetPageNo()

Returns:

base zero page number

Get the page number where the redaction occurs.

getQuads

Returns:

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.

getRect

RectgetRect()

Returns:

Rect

The size and location of the annotation on its page

getRepeat

booleangetRepeat()

Returns:

repeat value

Get the repeat value

getScaleToFit

booleangetScaleToFit()

Returns:

Scale To Fit value

Get the ScaleToFit value

getSubtype

StringgetSubtype()

Returns:

String

The annotation's subtype

getTextColor

ColorgetTextColor()

Returns:

Color used for the overlay text.

Get the color used for the overlay text.

getTitle

StringgetTitle()

Returns:

String

The title of the annotation.

hasRichTextData

booleanhasRichTextData()

Returns:

boolean

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.

isCurrentlyVisible

booleanisCurrentlyVisible(OptionalContentContextocc)

Parameters

Returns:

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.

setAlign

voidsetAlign(HorizontalAlignmenthalign)

Parameters

halign: HorizontalAlignment

desired Horiziontal alignment

Returns:

void

Sets the horizontal alignment for the redaction text.

setAnnotationFeatureLevel

voidsetAnnotationFeatureLevel(doublefeatureLevel)

Parameters

featureLevel: double

Target PDF version number

Returns:

void

Removes features not supported in the supplied version number.

setBorderColor

voidsetBorderColor(Colorcol)

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.

setColor

voidsetColor(Colorarg0)

Parameters

arg0: Color

Returns:

void

The color of the annotation.

setContents

voidsetContents(Stringarg0)

Parameters

arg0: String

Returns:

void

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.

setDrawBorder

voidsetDrawBorder(booleanOption)

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

setFillColor

voidsetFillColor(Colorcol, doubleopacity)

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.

setFillNormal

voidsetFillNormal(booleanOption)

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

setFillRedacted

voidsetFillRedacted(booleanOption)

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

setFlags

voidsetFlags(java.util.EnumSet< AnnotationFlags >arg0)

Parameters

arg0: java.util.EnumSet< AnnotationFlags >

Returns:

void

The flags for the annotation.

setFontFace

voidsetFontFace(StringfontName)

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

setFontSize

voidsetFontSize(doublefontsize)

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

setInteriorColor

voidsetInteriorColor(Colorcolor)

Parameters

color: Color

Returns:

void

The interior color with which to fill the annotation's line endings.

Only RGB colors are allowed.

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

setInternalColor

voidsetInternalColor(Colorcol)

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.

setNormalAppearance

voidsetNormalAppearance(Formform)

Parameters

form: Form

Returns:

void

setNote

voidsetNote(Stringnotetext)

Parameters

notetext: String

Contents to use on the popup comments box.

Returns:

void

Set the text string to be used as the Popup Contents

setOpacity

voidsetOpacity(doubleopacityValue)

Parameters

opacityValue: double

Returns:

void

The optional constant opacity value that shall be used in painting a Markup annotation.

Opacity is a range from 0.0 (fully transparent) to 1.0 (fully opaque).

setOptionalContentMembershipDict

voidsetOptionalContentMembershipDict(OptionalContentMembershipDictocmd)

Parameters

ocmd: OptionalContentMembershipDict

the OptionalContentMembershipDict

Returns:

void

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.

setOverlayFont

voidsetOverlayFont(Fontfont)

Parameters

font: Font

Returns:

boolean value of Fill redacted Appearance Option

Set Overlay Text Font

setOverlayText

voidsetOverlayText(Stringotext)

Parameters

otext: String

UTF-8 text to be written over redaction.

Returns:

void

Set the optional overlay text of the redaction.

setPageNo

voidsetPageNo(intpgNo)

Parameters

pgNo: int

Base zero page number

Returns:

void

Sets the page number where the redaction occurs.

setQuads

voidsetQuads(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.

setRect

voidsetRect(Rectrect)

Parameters

rect: Rect

Returns:

void

The size and location of the annotation on its page

setRepeat

voidsetRepeat(booleanValue)

Parameters

Value: boolean

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

Returns:

void

Set the repeat value

setScaleToFit

voidsetScaleToFit(booleanValue)

Parameters

Value: boolean

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

Returns:

void

Set the ScaleToFit value

setTextColor

voidsetTextColor(Colorcol)

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.

setTitle

voidsetTitle(Stringtitle)

Parameters

title: String

Returns:

void

The title of the annotation.

toString

StringtoString()

Returns:

String