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

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_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

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()
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	setTextColor(Color textColor)

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

getActions, getBorderStyle, getBorderWidth, getColor, getComponent, getCreationDate, getCreator, getFlags, getName, getOpacity, getRectangle, getSubtype, getTriggerActions, isHidden, isInvisible, isLocked, isNoRotate, isNoView, isNoZoom, isPrintable, isReadOnly, paint, paint, print, revalidate, setActions, setBorderStyle, setBorderWidth, setColor, setComponent, setComponentVisible, setCreationDate, setCreator, setFlags, setHidden, setInvisible, setLayer, setLocked, setName, setNoRotate, setNoView, setNoZoom, setOpacity, setPrintable, setReadOnly, setRectangle, setSubtype, setTriggerActions, shiftRectangle

Field Detail

ALIGN_LEFT

public static final int ALIGN_LEFT

See Also:

Constant Field Values

ALIGN_CENTER

public static final int ALIGN_CENTER

See Also:

Constant Field Values

ALIGN_RIGHT

public static final int ALIGN_RIGHT

See Also:

Constant Field Values

ALIGN_TOP

public static final int ALIGN_TOP

See Also:

Constant Field Values

ALIGN_BOTTOM

public static final int ALIGN_BOTTOM

See Also:

Constant Field Values

FREE_TEXT_TYPEWRITER

public static final String FREE_TEXT_TYPEWRITER

See Also:

Constant Field Values

Method Detail

getContents

public String getContents()

Returns the string contents for this annotation.

Specified by:

getContents in interface Annotation

Returns:

The annotation's contents.

setContents

public void setContents(String contents)

Sets the string contents for this annotation.

getAlignHorizontal

public int getAlignHorizontal()

setAlignHorizontal

public void setAlignHorizontal(int align)

getAlignVertical

public int getAlignVertical()

setAlignVertical

public void setAlignVertical(int align)

getFont

public Font getFont()

setFont

public void setFont(Font font)

getTextColor

public Color getTextColor()

setTextColor

public void setTextColor(Color textColor)

getBorderColor

public Color getBorderColor()

setBorderColor

public void setBorderColor(Color borderColor)

getBorderRect

public Rectangle2D.Double getBorderRect()

setBorderRect

public void setBorderRect(Rectangle2D.Double borderRect)

getRotation

public int getRotation()

setRotation

public void setRotation(int rotation)

getIntent

public String getIntent()

Returns the description of the intent of the FreeText Annotation

Returns:

intent

setIntent

public void setIntent(String intent)

Set the description of the intent of the FreeText Annotation

Parameters:

intent - the intent to set

isIntentTypeWriter

public boolean isIntentTypeWriter()