com.snowtide.pdf.annot
Class FreeTextAnnotation

java.lang.Object
  com.snowtide.pdf.annot.BaseAnnotation
      com.snowtide.pdf.annot.FreeTextAnnotation

All Implemented Interfaces:

Annotation

public class FreeTextAnnotation
extends com.snowtide.pdf.annot.BaseAnnotation

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

FreeTextAnnotations differ from TextAnnotations in the following ways:

• FreeTextAnnotations can be made to integrate with their parent PDF content seamlessly; TextAnnotations should never appear to be part of the regular PDF content.
• FreeTextAnnotations can contain 'rich text' -- XHTML/XFA content styled using CSS attributes. The rich text and CSS style information can be retrieved using the getRichContent() and getRichContentStyle() functions, respectively.

FreeTextAnnotations should also contain a plain-text representation of their content suitable for indexing, etc., accessible using the getContents() function.

NOTE: If PDFTextStream is not fully licensed, then the value returned by getRichContent() of approximately half of all FreeTextAnnotation objects will be slightly modified.

Since:

v1.3.5

Version:

©2004-2012 Snowtide Informatics Systems, Inc.

Constructor Summary

FreeTextAnnotation()

Method Summary

int	getJustificationInd() Returns an int indicating how the text content of this annotation should be justified.
java.lang.String	getRichContent() Returns the rich text content held by this annotation.
java.lang.String	getRichContentStyle() Returns the CSS style information held by this annotation that should be applied to the rich text content returned by the getRichContent() function when that content is displayed.

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

Constructor Detail

FreeTextAnnotation

public FreeTextAnnotation()

Method Detail

getJustificationInd

public int getJustificationInd()

Returns an int indicating how the text content of this annotation should be justified. Possible values:

• 0 - left-justified
• 1 - centered
• 2 - right-justified

getRichContent

public java.lang.String getRichContent()

Returns the rich text content held by this annotation. This content should conform to the XFA Text Specification, which is a subset of XHTML. For details on this, consult the subsection titled 'Rich Text Strings' in Section 8.6 of the PDF document reference. A plain text representation of this content should be available through the getContents() function.

getRichContentStyle

public java.lang.String getRichContentStyle()

Returns the CSS style information held by this annotation that should be applied to the rich text content returned by the getRichContent() function when that content is displayed. This style information should conform to the CSS recommendations presented in the PDF document reference, Section 8.6, subsection 'Rich Text Strings'.