com.qoppa.pdf.annotations
Interface MarkUpText

All Superinterfaces:

Annotation

public interface MarkUpText

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

static int	TYPE_HIGHLIGHT
static int	TYPE_INSERT
static int	TYPE_REPLACEMENT
static int	TYPE_SQUIGGLY
static int	TYPE_STRIKEOUT
static int	TYPE_UNDERLINE

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

BORDERSTYLE_BEVELED, 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

String	getIntent() returns intent for this annotation
int	getMarkupType() Gets the type of markup that this annotation represents.
Vector	getQuadList() Returns a list of the quadrilaterals that compose this annotation.
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.

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

getActions, getBorderStyle, getBorderWidth, getColor, getComponent, getContents, getCreationDate, getCreator, getFlags, getName, getOpacity, getRectangle, getSubtype, getTriggerActions, isHidden, isInvisible, isLocked, isNoRotate, isNoView, isNoZoom, isPrintable, isReadOnly, paint, paint, print, revalidate, setActions, setBorderStyle, setBorderWidth, setColor, setComponent, setComponentVisible, setCreationDate, setCreator, setFlags, setHidden, setInvisible, setLayer, setLocked, setName, setNoRotate, setNoView, setNoZoom, setOpacity, setPrintable, setReadOnly, setRectangle, setSubtype, setTriggerActions, shiftRectangle

Field Detail

TYPE_HIGHLIGHT

public static final int TYPE_HIGHLIGHT

See Also:

Constant Field Values

TYPE_UNDERLINE

public static final int TYPE_UNDERLINE

See Also:

Constant Field Values

TYPE_SQUIGGLY

public static final int TYPE_SQUIGGLY

See Also:

Constant Field Values

TYPE_STRIKEOUT

public static final int TYPE_STRIKEOUT

See Also:

Constant Field Values

TYPE_REPLACEMENT

public static final int TYPE_REPLACEMENT

See Also:

Constant Field Values

TYPE_INSERT

public static final int TYPE_INSERT

See Also:

Constant Field Values

Method Detail

getMarkupType

public int getMarkupType()

Gets the type of markup that this annotation represents.

Returns:

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

setContents

public 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

public 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

public 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

public void setRectangleFromQuads()

Convenience method to set the annotation rectangle from the quadrilaterals.

getIntent

public String getIntent()

returns intent for this annotation

Returns:

Returns the value of the Intent property.