com.qoppa.pdf.annotations

Interface Ink

All Superinterfaces:

Annotation, ShapeAnnotation

public interface Ink
extends ShapeAnnotation

Interface representing an Ink annotation in a PDF document. Ink annotation consist of a list of x,y coordinates that are connected using lines when displayed. The annotation can be double-clicked to display its content.

Author:

Qoppa Software

Field Summary

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
Vertices	addGesture() Creates a new line and returns it to the calling function.
Date	getCreationDate() Returns the date and time when the annotation was created.
GestureList	getGestures() Returns the list of gestures that represent the Ink annotation.
void	revalidateRectangle()

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

Method Detail

revalidateRectangle

void revalidateRectangle()

getGestures

GestureList getGestures()

Returns the list of gestures that represent the Ink annotation. Each object in the list is of type Vertices and contains a list of vertices to draw the gesture.

Returns:

A list of Vertices objects.

addGesture

Vertices addGesture()

Creates a new line and returns it to the calling function. The returned Vertices object is the actual Vertices object by the annotation, so any changes to the vertices will be reflected in the annotation.

Returns:

A Vertices object that holds the vertices in the gesture.

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.