com.qoppa.android.pdf.annotations

Interface FreeText

All Superinterfaces:

Annotation

All Known Subinterfaces:

TypeWriter

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 java.lang.String	COURIER
static java.lang.String	FREE_TEXT_TYPEWRITER
static java.lang.String	HELVETICA
static java.lang.String	TIMESROMAN

Fields inherited from interface com.qoppa.android.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

Modifier and Type	Method and Description
int	getAlignHorizontal()
int	getAlignVertical()
int	getBorderColor()
java.lang.String	getContents() Returns the string contents for this annotation.
Typeface	getFont()
java.lang.String	getFontName()
float	getFontSize()
java.lang.String	getIntent() Returns the description of the intent of the FreeText Annotation
int	getRotation()
int	getTextColor()
boolean	hasFillColor() Returns true if this annotation has a fill color.
void	setAlignHorizontal(int align)
void	setAlignVertical(int align)
void	setBorderColor(int borderColor)
void	setContents(java.lang.String contents) Sets the string contents for this annotation.
void	setFont(java.lang.String font)
void	setFontSize(float textSize)
void	setHasFillColor(boolean hasFillColor) Set to true to use the fill color.
void	setIntent(java.lang.String intent) Set the description of the intent of the FreeText Annotation
void	setRotation(int rotation)
void	setTextColor(int textColor)

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

getActions, getAlpha, getBorderStyle, getBorderWidth, getColor, getCreationDate, getCreator, getDrawingPicture, getFlags, getName, getPage, getRectangle, getSubtype, getTriggerActions, isHidden, isInvisible, isLocked, isNoRotate, isNoView, isNoZoom, isPrintable, isReadOnly, paint, print, setActions, setAlpha, setBorderStyle, setBorderWidth, setColor, setCreationDate, setCreator, setFlags, setHidden, setInvisible, setLayer, setLocked, setName, setNoRotate, setNoView, setNoZoom, setPrintable, setReadOnly, setRectangle, 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 java.lang.String FREE_TEXT_TYPEWRITER

See Also:

Constant Field Values

HELVETICA

static final java.lang.String HELVETICA

See Also:

Constant Field Values

COURIER

static final java.lang.String COURIER

See Also:

Constant Field Values

TIMESROMAN

static final java.lang.String TIMESROMAN

See Also:

Constant Field Values

Method Detail

getContents

java.lang.String getContents()

Returns the string contents for this annotation.

Specified by:

getContents in interface Annotation

Returns:

The annotation's contents.

setContents

void setContents(java.lang.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

Typeface getFont()

getFontName

java.lang.String getFontName()

getTextColor

int getTextColor()

setTextColor

void setTextColor(int textColor)

getBorderColor

int getBorderColor()

setBorderColor

void setBorderColor(int borderColor)

getRotation

int getRotation()

setRotation

void setRotation(int rotation)

getIntent

java.lang.String getIntent()

Returns the description of the intent of the FreeText Annotation

Returns:

intent

setIntent

void setIntent(java.lang.String intent)

Set the description of the intent of the FreeText Annotation

Parameters:

intent - the intent to set

setFontSize

void setFontSize(float textSize)

setHasFillColor

void setHasFillColor(boolean hasFillColor)

Set to true to use the fill color. Set to false to remove the fill color.

Parameters:

hasFillColor -

hasFillColor

boolean hasFillColor()

Returns true if this annotation has a fill color.

Returns:

true if this annotation has a fill color.

getFontSize

float getFontSize()

setFont

void setFont(java.lang.String font)