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

Modifier and Type	Field and Description
static int	TYPE_HIGHLIGHT Deprecated.
static int	TYPE_INSERT Deprecated.
static int	TYPE_REPLACEMENT Deprecated.
static int	TYPE_SQUIGGLY Deprecated.
static int	TYPE_STRIKEOUT Deprecated.
static int	TYPE_UNDERLINE Deprecated.

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_NOROTATE, FLAGS_NOVIEW, FLAGS_NOZOOM, FLAGS_PRINTABLE, FLAGS_READONLY

Method Summary

Methods

Modifier and Type	Method and Description
String	getIntent() returns intent for this annotation
int	getMarkupType() Deprecated. Use Annotation.getSubtype() instead. Possible values are Highlight, Underline, StrikeOut, Squiggly.
Vector	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 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, getBorderStyle, getBorderWidth, getCheckmarkStatus, getColor, getComponent, getContents, getCreator, getFlags, getModifiedDate, getName, getOpacity, getRectangle, getReviewHistory, getSubject, getSubtype, getTriggerActions, isHidden, isInvisible, isLocked, isNoRotate, isNoView, isNoZoom, isPrintable, isReadOnly, paint, print, revalidate, setActions, setBorderStyle, setBorderWidth, setColor, setComponent, setComponentVisible, setCreator, setFlags, setHidden, setInvisible, setLayer, setLocked, setModifiedDate, setName, setNoRotate, setNoView, setNoZoom, setOpacity, setPrintable, setReadOnly, setRectangle, setSubject, setTriggerActions, shiftRectangle

Field Detail

TYPE_HIGHLIGHT

static final int TYPE_HIGHLIGHT

Deprecated.

See Also:

Constant Field Values

TYPE_UNDERLINE

static final int TYPE_UNDERLINE

Deprecated.

See Also:

Constant Field Values

TYPE_SQUIGGLY

static final int TYPE_SQUIGGLY

Deprecated.

See Also:

Constant Field Values

TYPE_STRIKEOUT

static final int TYPE_STRIKEOUT

Deprecated.

See Also:

Constant Field Values

TYPE_REPLACEMENT

static final int TYPE_REPLACEMENT

Deprecated.

See Also:

Constant Field Values

TYPE_INSERT

static final int TYPE_INSERT

Deprecated.

See Also:

Constant Field Values

Method Detail

getMarkupType

int getMarkupType()

Deprecated. Use Annotation.getSubtype() instead. Possible values are Highlight, Underline, StrikeOut, Squiggly.

Gets the type of markup that this annotation represents.

Returns:

One of the predefined constants: TYPE_HIGHLIGHT, TYPE_UNDERLINE, TYPE_SQUIGGLY, etc.

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

Specified by:

setSubtype in interface Annotation

Parameters:

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