com.snowtide.pdf.annot
Class TextAnnotation
java.lang.Object
com.snowtide.pdf.annot.BaseAnnotation
com.snowtide.pdf.annot.TextAnnotation
- All Implemented Interfaces:
- Annotation
public class TextAnnotation
- extends com.snowtide.pdf.annot.BaseAnnotation
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 the standard attributes
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 getIconName()
function.
- Version:
- ©2004-2012 Snowtide Informatics Systems, Inc.
Method Summary |
java.lang.String |
getIconName()
Returns an optional String attribute indicating the type of icon to be used in displaying this
annotation. |
Methods inherited from class com.snowtide.pdf.annot.BaseAnnotation |
getContents, getModificationDate, getName, getPageNumber, getRect, getTypeCd, readPageAnnotations |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
TextAnnotation
public TextAnnotation()
getIconName
public java.lang.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