com.qoppa.pdf.annotations

Interface FreeText

All Superinterfaces:

Annotation

All Known Subinterfaces:

Callout

public interface FreeText
extends Annotation

Interface representing a FreeText annotation in a PDF document. This annotation is called Text Box in the user interface. FreeText annotations are displayed as a text box on the PDF document.

Author:

Qoppa Software

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALIGN_BOTTOM
static int	ALIGN_CENTER
static int	ALIGN_LEFT
static int	ALIGN_RIGHT
static int	ALIGN_TOP
static String	FREE_TEXT_TYPEWRITER

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_NOROTATE, FLAGS_NOVIEW, FLAGS_NOZOOM, FLAGS_PRINTABLE, FLAGS_READONLY

Method Summary

Methods

Modifier and Type	Method and Description
int	getAlignHorizontal()
int	getAlignVertical()
Color	getBorderColor()
Rectangle2D.Double	getBorderRect()
String	getContents() Returns the string contents for this annotation.
Font	getFont()
String	getIntent() Returns the description of the intent of the FreeText Annotation
int	getRotation()
BasicStroke	getStroke() Gets the stroke to use when drawing the annotation.
Color	getTextColor()
boolean	isIntentTypeWriter()
void	setAlignHorizontal(int align)
void	setAlignVertical(int align)
void	setBorderColor(Color borderColor)
void	setBorderRect(Rectangle2D.Double borderRect)
void	setContents(String contents) Sets the string contents for this annotation.
void	setFont(Font font)
void	setIntent(String intent) Set the description of the intent of the FreeText Annotation
void	setRotation(int rotation)
void	setStroke(BasicStroke stroke) Sets the stroke used when drawing the annotation.
void	setTextColor(Color textColor)

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, isNoRotate, isNoView, isNoZoom, isPrintable, isReadOnly, paint, print, revalidate, setActions, setBorderStyle, setBorderWidth, setColor, setComponent, setComponentVisible, setCreator, setFlags, setHidden, setInvisible, setLayer, setLocked, setModifiedDate, setName, setNoRotate, setNoView, setNoZoom, setOpacity, setPrintable, setReadOnly, setRectangle, setSubject, setSubtype, setTriggerActions, shiftRectangle

Field Detail

ALIGN_LEFT

static final int ALIGN_LEFT

See Also:

Constant Field Values

ALIGN_CENTER

static final int ALIGN_CENTER

See Also:

Constant Field Values

ALIGN_RIGHT

static final int ALIGN_RIGHT

See Also:

Constant Field Values

ALIGN_TOP

static final int ALIGN_TOP

See Also:

Constant Field Values

ALIGN_BOTTOM

static final int ALIGN_BOTTOM

See Also:

Constant Field Values

FREE_TEXT_TYPEWRITER

static final String FREE_TEXT_TYPEWRITER

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.

getAlignHorizontal

int getAlignHorizontal()

setAlignHorizontal

void setAlignHorizontal(int align)

getAlignVertical

int getAlignVertical()

setAlignVertical

void setAlignVertical(int align)

getFont

Font getFont()

setFont

void setFont(Font font)

getTextColor

Color getTextColor()

setTextColor

void setTextColor(Color textColor)

getBorderColor

Color getBorderColor()

setBorderColor

void setBorderColor(Color borderColor)

getBorderRect

Rectangle2D.Double getBorderRect()

setBorderRect

void setBorderRect(Rectangle2D.Double borderRect)

getRotation

int getRotation()

setRotation

void setRotation(int rotation)

getIntent

String getIntent()

Returns the description of the intent of the FreeText Annotation

Returns:

intent

setIntent

void setIntent(String intent)

Set the description of the intent of the FreeText Annotation

Parameters:

intent - the intent to set

isIntentTypeWriter

boolean isIntentTypeWriter()

getStroke

BasicStroke getStroke()

Gets the stroke to use when drawing the annotation.

Returns:

The stroke used in drawing.

setStroke

void setStroke(BasicStroke stroke)

Sets the stroke used when drawing the annotation.

Parameters:

stroke - The stroke to use when drawing the annotation.