com.etymon.pjx.util
Class PdfFieldTree

java.lang.Object
  com.etymon.pjx.util.PdfFieldTree

public class PdfFieldTree

extends java.lang.Object

Provides methods for retrieving and modifying the field tree of a PDF document. This class is synchronized.

Constructor Summary

PdfFieldTree(PdfManager manager)
Constructs a PdfFieldTree instance based on a specified PdfManager.

Method Summary

java.lang.String	getFullyQualifiedName(PdfDictionary field) Determines the fully qualified field name of a specified field.
PdfFieldTreeIterator	getIterator() Returns an iterator over the terminal field objects in this document's field tree.
PdfDictionary	inheritAttributes(PdfDictionary field) Adds inherited attributes to a specified field dictionary object.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PdfFieldTree

public PdfFieldTree(PdfManager manager)

Constructs a PdfFieldTree instance based on a specified PdfManager.

Method Detail

getFullyQualifiedName

public java.lang.String getFullyQualifiedName(PdfDictionary field)
                                       throws java.io.IOException,
                                              PdfFormatException

Determines the fully qualified field name of a specified field.

Parameters:

field - the field dictionary.

Returns:

the fully qualified field name.

Throws:

java.io.IOException

PdfFormatException

inheritAttributes

public PdfDictionary inheritAttributes(PdfDictionary field)
                                throws java.io.IOException,
                                       PdfFormatException

Adds inherited attributes to a specified field dictionary object. The field object is cloned and the inherited attributes are made explicit in the cloned object's dictionary. The inherited attributes are retrieved by ascending the field tree and looking for inheritable attributes (if any) that are missing from the specified field dictionary. The interactive form dictionary is also checked (if necessary) for document-wide default values.

Parameters:

field - the field dictionary to be filled in with inherited attributes.

Returns:

a clone of the specified field dictionary, with all inherited attributes filled in.

Throws:

java.io.IOException

PdfFormatException

getIterator

public PdfFieldTreeIterator getIterator()
                                 throws java.io.IOException,
                                        PdfFormatException

Returns an iterator over the terminal field objects in this document's field tree. Note that terminal field objects do not include inherited attributes; inheritAttributes(PdfDictionary) should be used to obtain inherited attributes.

Returns:

the iterator over the terminal field objects.

Throws:

java.io.IOException

PdfFormatException