Top Description Fields Constructors Methods
org.apache.pdfbox.pdmodel.fdf

public Class FDFAnnotationStamp

extends FDFAnnotation
Class Inheritance
Imports
java.io.ByteArrayInputStream, .IOException, .OutputStream, javax.xml.xpath.XPath, .XPathExpressionException, .XPathFactory, org.apache.commons.logging.Log, .LogFactory, org.apache.pdfbox.cos.COSArray, .COSBoolean, .COSDictionary, .COSName, .COSNumber, .COSStream, org.apache.pdfbox.util.Hex, .XMLUtil, org.w3c.dom.Document, .Element, .Node, .NodeList

This represents a Stamp FDF annotation.
Authors
Ben Litchfield, Andrew Hung

Field Summary

Modifier and TypeField and Description
private static final Log
public static final String
SUBTYPE

COS Model value for SubType entry.

Inherited from org.apache.pdfbox.pdmodel.fdf.FDFAnnotation:
annot

Constructor Summary

AccessConstructor and Description
public
FDFAnnotationStamp()

Default constructor.

public
FDFAnnotationStamp(COSDictionary
An existing FDF Annotation.
a
)

Constructor.

public
FDFAnnotationStamp(Element
An XFDF element.
element
)

Constructor.

Method Summary

Modifier and TypeMethod and Description
private COSArray
private COSDictionary
private COSDictionary
parseStampAnnotationAppearanceXML(Element
The XML element that contains the appearance data.
appearanceXML
)

This will create an Appearance dictionary from an appearance XML element.

private COSStream
Inherited from org.apache.pdfbox.pdmodel.fdf.FDFAnnotation:
creategetBorderEffectgetBorderStylegetColorgetContentsgetCOSObjectgetCreationDategetDategetIntentgetNamegetOpacitygetPagegetRectanglegetRichContentsgetStringOrStreamgetSubjectgetTitleisHiddenisInvisibleisLockedisLockedContentsisNoRotateisNoViewisNoZoomisPrintedisReadOnlyisToggleNoViewsetBorderEffectsetBorderStylesetColorsetContentssetCreationDatesetDatesetHiddensetIntentsetInvisiblesetLockedsetLockedContentssetNamesetNoRotatesetNoViewsetNoZoomsetOpacitysetPagesetPrintedsetReadOnlysetRectanglesetRichContentssetSubjectsetTitlesetToggleNoView

Field Detail

LOGback to summary
private static final Log LOG

Hides org.apache.pdfbox.pdmodel.fdf.FDFAnnotation.LOG.

SUBTYPEback to summary
public static final String SUBTYPE

COS Model value for SubType entry.

Constructor Detail

FDFAnnotationStampback to summary
public FDFAnnotationStamp()

Default constructor.

FDFAnnotationStampback to summary
public FDFAnnotationStamp(COSDictionary a)

Constructor.

Parameters
a:COSDictionary

An existing FDF Annotation.

FDFAnnotationStampback to summary
public FDFAnnotationStamp(Element element) throws IOException

Constructor.

Parameters
element:Element

An XFDF element.

Exceptions
IOException:
If there is an error extracting information from the element.

Method Detail

parseArrayElementback to summary
private COSArray parseArrayElement(Element arrayEl) throws IOException
parseDictElementback to summary
private COSDictionary parseDictElement(Element dictEl) throws IOException
parseStampAnnotationAppearanceXMLback to summary
private COSDictionary parseStampAnnotationAppearanceXML(Element appearanceXML) throws IOException

This will create an Appearance dictionary from an appearance XML element.

Parameters
appearanceXML:Element

The XML element that contains the appearance data.

parseStreamElementback to summary
private COSStream parseStreamElement(Element streamEl) throws IOException