com.qoppa.pdf.annotations

Interface Text

All Superinterfaces:

Annotation

public interface Text
extends Annotation

Interface representing a Text annotation in a PDF document. Text annotations are displayed as a note icon on the PDF document and open a text box to show its contents when double-clicked.

Author:

Qoppa Software

Field Summary

Fields

Modifier and Type	Field and Description
static String	ICON_COMMENT
static String	ICON_DEFAULT
static String	ICON_HELP
static String	ICON_INSERT
static String	ICON_KEY
static String	ICON_NEWPARAGRAPH
static String	ICON_NOTE
static String	ICON_PARAGRAPH

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
String	getContents() Returns the string contents for this annotation.
String	getIconName() Returns the name of the icon for this annotation.
String	getState() Returns the string State for this annotation
String	getStateModel() Returns the string StateModel for this annotation
boolean	isInitialOpen() Returns the value of the InitialOpen flag.
void	setContents(String contents) Sets the string contents for this annotation.
void	setIconName(String iconName)
void	setInitialOpen(boolean initOpen) Sets the initial open flag.
void	setState(String state) Sets the State for this annotation.
void	setStateModel(String stateModel) Sets the StateModel for this 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, 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

ICON_NOTE

static final String ICON_NOTE

See Also:

Constant Field Values

ICON_COMMENT

static final String ICON_COMMENT

See Also:

Constant Field Values

ICON_KEY

static final String ICON_KEY

See Also:

Constant Field Values

ICON_HELP

static final String ICON_HELP

See Also:

Constant Field Values

ICON_NEWPARAGRAPH

static final String ICON_NEWPARAGRAPH

See Also:

Constant Field Values

ICON_PARAGRAPH

static final String ICON_PARAGRAPH

See Also:

Constant Field Values

ICON_INSERT

static final String ICON_INSERT

See Also:

Constant Field Values

ICON_DEFAULT

static final String ICON_DEFAULT

See Also:

Constant Field Values

Method Detail

getIconName

String getIconName()

Returns the name of the icon for this annotation.

Returns:

Name of the icon.

isInitialOpen

boolean isInitialOpen()

Returns the value of the InitialOpen flag.

Returns:

Value of the flag.

setInitialOpen

void setInitialOpen(boolean initOpen)

Sets the initial open flag.

Parameters:

initOpen - The new value of the initial open flag.

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.

setIconName

void setIconName(String iconName)

setState

void setState(String state)

Sets the State for this annotation.

Parameters:

state - The new value of the State.

getState

String getState()

Returns the string State for this annotation

setStateModel

void setStateModel(String stateModel)

Sets the StateModel for this annotation.

Parameters:

stateModel - The new value of the StateModel.

getStateModel

String getStateModel()

Returns the string StateModel for this annotation