com.qoppa.pdf.annotations

Interface Caret

All Superinterfaces:

Annotation

public interface Caret
extends Annotation

Interface representing a Caret annotation in a PDF document.

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
String	getContents() Returns the string contents for this annotation.
Date	getCreationDate() Returns the date and time when the annotation was created.
String	getIntent() Returns intent for this annotation.
int	getWidth() Gets the width of this Caret annotation.
void	setContents(String contents) Sets the string contents for this annotation.
void	setWidth(int width) Set the width of this Caret annotation.

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

Method Detail

getContents

String getContents()

Returns the string contents for this annotation.

Specified by:

getContents in interface Annotation

Returns:

The string content of this annotation.

setContents

void setContents(String contents)

Sets the string contents for this annotation.

Parameters:

contents - The new contents for this annotation.

getIntent

String getIntent()

Returns intent for this annotation.

Returns:

The intent value for this annotation.

setWidth

void setWidth(int width)

Set the width of this Caret annotation.

Parameters:

width - The new width of the annotation.

getWidth

int getWidth()

Gets the width of this Caret annotation.

Returns:

The width of the Caret annotation.

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.