com.qoppa.pdf.annotations

Interface Redaction

All Superinterfaces:

Annotation, ShapeAnnotation

public interface Redaction
extends ShapeAnnotation

Interface representing a Redaction annotation in a PDF document.

Author:

Qoppa Software

Field Summary

Fields

Modifier and Type	Field and Description
static int	OVERLAY_ALIGNMENT_CENTER Indicates center alignment for overlay text; used by setOverlayTextAlignment(int).
static int	OVERLAY_ALIGNMENT_LEFT Indicates left alignment for overlay text; used by setOverlayTextAlignment(int).
static int	OVERLAY_ALIGNMENT_RIGHT Indicates right alignment for overlay text; used by setOverlayTextAlignment(int).

Fields inherited from interface com.qoppa.pdf.annotations.ShapeAnnotation

LE_BUTT, LE_BUTT_STR, LE_CIRCLE, LE_CIRCLE_STR, LE_CLOSEDARROW, LE_CLOSEDARROW_STR, LE_DIAMOND, LE_DIAMOND_STR, LE_NONE, LE_NONE_STR, LE_OPENARROW, LE_OPENARROW_STR, LE_REVERSE_CLOSED_ARROW, LE_REVERSE_CLOSED_ARROW_STR, LE_REVERSE_OPEN_ARROW, LE_REVERSE_OPEN_ARROW_STR, LE_SLASH, LE_SLASH_STR, LE_SQUARE, LE_SQUARE_STR

Fields inherited from interface com.qoppa.pdf.annotations.Annotation

BORDERSTYLE_BEVELED, BORDERSTYLE_CLOUD, BORDERSTYLE_DASHED, BORDERSTYLE_INSETS, BORDERSTYLE_SOLID, BORDERSTYLE_UNDERLINE, FLAGS_HIDDEN, FLAGS_INVISIBLE, FLAGS_LOCKED, FLAGS_LOCKEDCONTENTS, FLAGS_NOROTATE, FLAGS_NOVIEW, FLAGS_NOZOOM, FLAGS_PRINTABLE, FLAGS_READONLY

Method Summary

Modifier and Type	Method and Description
Date	getCreationDate() Returns the date and time when the annotation was created.
Color	getFillColor() Returns the annotation's fill color.
String	getOverlayFontName() Returns the overlay text font name.
float	getOverlayFontSize() Returns the overlay text font size.
String	getOverlayText() Returns the text string specifying the overlay text that should be drawn over the redacted region.
int	getOverlayTextAlignment() Returns the overlay text alignment.
Color	getOverlayTextColor() Returns the overlay text color
Vector<Point2D[]>	getQuadList() Returns a list of the quadrilaterals that compose this annotation if any.
boolean	isOverlayTextRepeats() Returns the flag to determine if the overlay text should repeat.
void	setFillColor(Color c) Sets the annotation's fill color.
void	setOverlayFont(String fontName, float fontSize) Sets the name and point size of the overlay text Font.
void	setOverlayText(String text) Sets the text string specifying the overlay text that should be drawn over the redacted region.
void	setOverlayTextAlignment(int alignment) Sets the overlay text alignment.
void	setOverlayTextColor(Color color) Sets the overlay text color.
void	setOverlayTextRepeats(boolean repeats) Sets the flag to determine if the overlay text should repeat.

Methods inherited from interface com.qoppa.pdf.annotations.ShapeAnnotation

getContents, getInternalColor, getStroke, setContents, setInternalColor, setStroke

Methods inherited from interface com.qoppa.pdf.annotations.Annotation

getActions, getAnnotationComponent, getBorderStyle, getBorderWidth, getCheckmarkStatus, getColor, getComponent, getCreator, getFlags, getIRTAnnotation, getModifiedDate, getName, getOpacity, getPageIndex, getRectangle, getReviewHistory, getSubject, getSubtype, getTriggerActions, isHidden, isInvisible, isIRTGroup, isLocked, isLockedContents, isNoRotate, isNoView, isNoZoom, isPrintable, isReadOnly, paint, print, revalidate, setActions, setBorderStyle, setBorderWidth, setColor, setComponent, setComponentVisible, setCreator, setFlags, setHidden, setInvisible, setLayer, setLocked, setLockedContents, setModifiedDate, setName, setNoRotate, setNoView, setNoZoom, setOpacity, setPrintable, setReadOnly, setRectangle, setSubject, setTriggerActions, shiftRectangle

Field Detail

OVERLAY_ALIGNMENT_LEFT

static final int OVERLAY_ALIGNMENT_LEFT

Indicates left alignment for overlay text; used by setOverlayTextAlignment(int).

See Also:

Constant Field Values

OVERLAY_ALIGNMENT_CENTER

static final int OVERLAY_ALIGNMENT_CENTER

Indicates center alignment for overlay text; used by setOverlayTextAlignment(int).

See Also:

Constant Field Values

OVERLAY_ALIGNMENT_RIGHT

static final int OVERLAY_ALIGNMENT_RIGHT

Indicates right alignment for overlay text; used by setOverlayTextAlignment(int).

See Also:

Constant Field Values

Method Detail

getQuadList

Vector<Point2D[]> getQuadList()

Returns a list of the quadrilaterals that compose this annotation if any. Each item in the list is an array of 4 Point.Double objects that contains the 4 points needed for that quadrilateral. May return an empty list, in which case the annotation is defined by it's rectangular bounds.

Returns:

List of quadrilaterals.

setOverlayText

void setOverlayText(String text)

Sets the text string specifying the overlay text that should be drawn over the redacted region.

Parameters:

text - The overlay text string.

getOverlayText

String getOverlayText()

Returns the text string specifying the overlay text that should be drawn over the redacted region.

Returns:

The overlay text string.

setOverlayFont

void setOverlayFont(String fontName,
                    float fontSize)
             throws PDFException

Sets the name and point size of the overlay text Font.

The supported fonts are Helvetica, Helvetica-Bold, Helvetica-Oblique, Helvetica-BoldOblique, Courier, Courier-Bold, Courier-Oblique, Courier-BoldOblique, Times-Roman, Times-Bold, Times-Italic, Times-BoldItalic.

The default font is Helvetica. The default font size is 12. If the size is 0, then the text will be resized to fill the redacted region.

Parameters:

fontName - The font name.

fontSize - The Font size.

Throws:

PDFException

getOverlayFontName

String getOverlayFontName()

Returns the overlay text font name.

Returns:

The overlay text font name.

getOverlayFontSize

float getOverlayFontSize()

Returns the overlay text font size.

Returns:

The overlay text font size.

setOverlayTextColor

void setOverlayTextColor(Color color)

Sets the overlay text color. The default color is white.

Parameters:

color - The overlay text color.

getOverlayTextColor

Color getOverlayTextColor()

Returns the overlay text color

Returns:

The overlay text color.

setOverlayTextAlignment

void setOverlayTextAlignment(int alignment)

Sets the overlay text alignment. The possible values are OVERLAY_ALIGNMENT_LEFT, OVERLAY_ALIGNMENT_CENTER, OVERLAY_ALIGNMENT_RIGHT. The default alignment is OVERLAY_ALIGNMENT_LEFT;

Parameters:

alignment - The overlay text alignment.

getOverlayTextAlignment

int getOverlayTextAlignment()

Returns the overlay text alignment. The possible values are OVERLAY_ALIGNMENT_LEFT, OVERLAY_ALIGNMENT_CENTER, OVERLAY_ALIGNMENT_RIGHT.

Returns:

The overlay text alignment.

setOverlayTextRepeats

void setOverlayTextRepeats(boolean repeats)

Sets the flag to determine if the overlay text should repeat. If true, then the text will be repeated to fill the redacted region. The default value is false.

Parameters:

repeats - The overlay text repeats flag.

isOverlayTextRepeats

boolean isOverlayTextRepeats()

Returns the flag to determine if the overlay text should repeat.

Returns:

The overlay text repeats flag.

getCreationDate

Date getCreationDate()

Returns the date and time when the annotation was created. Milliseconds are always zero since the PDF date format doesn't support milliseconds.

Returns:

The date and time when the annotation was created.

setFillColor

void setFillColor(Color c)

Sets the annotation's fill color.

Parameters:

c - The new color.

getFillColor

Color getFillColor()

Returns the annotation's fill color.

Returns:

The annotation's fill color.