com.snowtide.pdf.annot

Class FreeTextAnnotation

java.lang.Object

com.snowtide.pdf.annot.FreeTextAnnotation

All Implemented Interfaces:

Annotation, DocumentLocation, Bounded

public class FreeTextAnnotation
extends java.lang.Object

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 FreeTextAnnotation.getRichContent() and FreeTextAnnotation.getRichContentStyle() functions, respectively.

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

Since:

v1.3.5

Version:

©2004-2024 Snowtide

Constructor Summary

Constructors

Constructor and Description
FreeTextAnnotation()

Method Summary

Modifier and Type	Method and Description
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 FreeTextAnnotation.getRichContent() function when that content is displayed.

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

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 FreeTextAnnotation.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'.