com.qoppa.pdf.annotations

Interface Callout

All Superinterfaces:

Annotation, FreeText

public interface Callout
extends FreeText

Interface representing a Callout annotation in a PDF document. Callout annotations are displayed as a small text box with an arrow. No annotation will be drawn if setRectangle method is not called. Similarly, no inner rectangle will be drawn if setInnerRect is not called, and no arrow will be drawn if setArrow() is not called.

Author:

Qoppa Software

Field Summary

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

ALIGN_BOTTOM, ALIGN_CENTER, ALIGN_LEFT, ALIGN_MIDDLE, ALIGN_RIGHT, ALIGN_TOP, INTENT_TYPE_WRITER

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
double[]	getArrow() Returns an array representing the coordinates of the arrow
Rectangle2D	getInnerRect() Returns the rectangle that holds the text of the annotation.
void	setArrow(double[] arrow) Sets the coordinates of the callout arrow
void	setInnerRect(Rectangle2D innerRect) Sets the innerRect relative to the annotation rectangle.

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

getAlignHorizontal, getAlignVertical, getBorderColor, getBorderRect, getContents, getCreationDate, getFontName, getFontSize, getIntent, getRichContents, getRotation, getStroke, getTextColor, isIntentTypeWriter, setAlignHorizontal, setAlignVertical, setBorderColor, setBorderRect, setContents, setIntent, setPDFFont, setRichContents, setRotation, setStroke, setTextColor

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

setInnerRect

void setInnerRect(Rectangle2D innerRect)

Sets the innerRect relative to the annotation rectangle.

Parameters:

innerRect - Where innerRect.x is the distance between the inner rectangle and left of the annotation rectangle, innerRect.y is the distance between the inner rectangle and the top of the annotation rectangle, innerRect.width is the width of the inner rectangle, and innerRect.height is the height of innerRectangle

getInnerRect

Rectangle2D getInnerRect()

Returns the rectangle that holds the text of the annotation.

Returns:

The text rectangle.

setArrow

void setArrow(double[] arrow)

Sets the coordinates of the callout arrow

Parameters:

arrow - An array of either 4 or 6 components. If 6 components, the components represent: {startingPointX, startingPointY, kneePointX, kneePointY, endPointX, endPointY} If 4 components, the components represent: {startingPointX, startingPointY, endPointX, endPointY}

getArrow

double[] getArrow()

Returns an array representing the coordinates of the arrow

Returns:

The arrow coordinates.