com.qoppa.pdf.annotations

Interface TextMarkup

All Superinterfaces:

Annotation

public interface TextMarkup
extends Annotation

Interface representing a Text Markup annotation in a PDF document. Text markup annotations are a way to mark text in a document by highlighting, crossing out, or underlining.

Author:

Qoppa Software

Field Summary

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.
String	getIntent() returns intent for this annotation
Vector<Point2D[]>	getQuadList() Returns a list of the quadrilaterals that compose this annotation.
String	getText(IPDFPage page)
void	setContents(String contents) Sets the text content for this annotation.
void	setQuadList(Vector<Point2D[]> quadList) Sets the list of quadrilaterals that compose this annotation.
void	setRectangleFromQuads() Convenience method to set the annotation rectangle from the quadrilaterals.
void	setSubtype(String subtype) Sets the annotation's subtype.

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

getActions, getAnnotationComponent, getBorderStyle, getBorderWidth, getCheckmarkStatus, getColor, getComponent, getContents, 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

Method Detail

setContents

void setContents(String contents)

Sets the text content for this annotation. The content is the comment that a user can enter when creating the annotation.

Parameters:

contents - the new comment.

getQuadList

Vector<Point2D[]> getQuadList()

Returns a list of the quadrilaterals that compose this annotation. Each item in the list is an array of 4 Point.Double objects that contains the 4 points needed for that quadrilateral.

Returns:

List of quadrilaterals.

setQuadList

void setQuadList(Vector<Point2D[]> quadList)

Sets the list of quadrilaterals that compose this annotation. Each item in the list should be an array of 4 Point.Double objects.

Parameters:

quadList - The new list of quadrilaterals.

setRectangleFromQuads

void setRectangleFromQuads()

Convenience method to set the annotation rectangle from the quadrilaterals.

getIntent

String getIntent()

returns intent for this annotation

Returns:

Returns the value of the Intent property. Possible values are StrikeOutTextEdit.

getText

String getText(IPDFPage page)
        throws PDFPermissionException

Parameters:

page - The page the annotation is located on.

Returns:

The text corresponding to this annotation's quadrilaterals.

Throws:

PDFPermissionException

setSubtype

void setSubtype(String subtype)

Sets the annotation's subtype.

Parameters:

subtype - The type of the markup annotation. Possible values are Highlight, Underline, StrikeOut, Squiggly.

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.