com.qoppa.pdf.annotations

Interface ShapeAnnotation

All Superinterfaces:

Annotation

All Known Subinterfaces:

Circle, Ink, Line, Polygon, Polyline, Redaction, Square

public interface ShapeAnnotation
extends Annotation

Abstract class to be extended by annotations that contain textual content.

Author:

Qoppa Software

Field Summary

Fields

Modifier and Type	Field and Description
static int	LE_BUTT
static String	LE_BUTT_STR
static int	LE_CIRCLE
static String	LE_CIRCLE_STR
static int	LE_CLOSEDARROW
static String	LE_CLOSEDARROW_STR
static int	LE_DIAMOND
static String	LE_DIAMOND_STR
static int	LE_NONE
static String	LE_NONE_STR
static int	LE_OPENARROW
static String	LE_OPENARROW_STR
static int	LE_SQUARE
static String	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
String	getContents() Returns the string contents for this annotation.
Color	getInternalColor() Gets the fill color for this annotation.
BasicStroke	getStroke() Gets the stroke to use when drawing the ink annotation.
void	setContents(String contents) Sets the string contents for this annotation.
void	setInternalColor(Color internalColor) Sets the fill color for this annotation.
void	setStroke(BasicStroke stroke) Sets the stroke used when drawing the ink annotation.

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

getActions, getBorderStyle, getBorderWidth, getCheckmarkStatus, getColor, getComponent, getCreator, getFlags, getModifiedDate, getName, getOpacity, getRectangle, getReviewHistory, getSubject, getSubtype, getTriggerActions, isHidden, isInvisible, 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, setSubtype, setTriggerActions, shiftRectangle

Field Detail

LE_NONE

static final int LE_NONE

See Also:

Constant Field Values

LE_SQUARE

static final int LE_SQUARE

See Also:

Constant Field Values

LE_CIRCLE

static final int LE_CIRCLE

See Also:

Constant Field Values

LE_DIAMOND

static final int LE_DIAMOND

See Also:

Constant Field Values

LE_OPENARROW

static final int LE_OPENARROW

See Also:

Constant Field Values

LE_CLOSEDARROW

static final int LE_CLOSEDARROW

See Also:

Constant Field Values

LE_BUTT

static final int LE_BUTT

See Also:

Constant Field Values

LE_NONE_STR

static final String LE_NONE_STR

See Also:

Constant Field Values

LE_SQUARE_STR

static final String LE_SQUARE_STR

See Also:

Constant Field Values

LE_CIRCLE_STR

static final String LE_CIRCLE_STR

See Also:

Constant Field Values

LE_DIAMOND_STR

static final String LE_DIAMOND_STR

See Also:

Constant Field Values

LE_OPENARROW_STR

static final String LE_OPENARROW_STR

See Also:

Constant Field Values

LE_CLOSEDARROW_STR

static final String LE_CLOSEDARROW_STR

See Also:

Constant Field Values

LE_BUTT_STR

static final String LE_BUTT_STR

See Also:

Constant Field Values

Method Detail

getContents

String getContents()

Returns the string contents for this annotation.

Specified by:

getContents in interface Annotation

Returns:

The annotation's contents.

setContents

void setContents(String contents)

Sets the string contents for this annotation.

getStroke

BasicStroke getStroke()

Gets the stroke to use when drawing the ink annotation.

Returns:

The stroke used in drawing.

setStroke

void setStroke(BasicStroke stroke)

Sets the stroke used when drawing the ink annotation.

Parameters:

stroke - The stroke to use when drawing the annotation.

getInternalColor

Color getInternalColor()

Gets the fill color for this annotation.

Returns:

The fill color, null if it is not defined.

setInternalColor

void setInternalColor(Color internalColor)

Sets the fill color for this annotation. If the value is set to null, the square will leave it's interior transparent.

Parameters:

internalColor - The color to use to fill the rectangle. If null, the interior will be transparent.