com.snowtide.pdf.annot

Class TextAnnotation

java.lang.Object

com.snowtide.pdf.annot.TextAnnotation

All Implemented Interfaces:

Annotation, DocumentLocation, Bounded

public class TextAnnotation
extends Object

An Annotation implementation that represents a PDF annotation of type Text.

Text annotations are 'sticky notes', snippets of commentary associated with particular location within a PDF document's page.

The only attribute a text annotation may contain aside from those defined by the Annotation interface is the type of icon that should be displayed by a viewer to indicate the presence of a text annotation. The icon type can be retrieved using the TextAnnotation.getIconName() function.

Version:

©2004-2014 Snowtide

Constructor Summary

Constructors

Constructor and Description
TextAnnotation()

Method Summary

Modifier and Type	Method and Description
String	getIconName() Returns an optional String attribute indicating the type of icon to be used in displaying this annotation.

Methods inherited from interface com.snowtide.pdf.annot.Annotation

getAppearance, getContents, getModificationDate, getName, getTypeCd

Methods inherited from interface com.snowtide.pdf.DocumentLocation

pageNumber

Methods inherited from interface com.snowtide.pdf.layout.Bounded

bounds

Constructor Detail

TextAnnotation

public TextAnnotation()

Method Detail

getIconName

public String getIconName()

Returns an optional String attribute indicating the type of icon to be used in displaying this annotation. The following are standard icon names:

• Comment
• Key
• Note
• Help
• NewParagraph
• Paragraph
• Insert