public class PdfFieldTree
extends java.lang.Object
Modifier and Type | Class and Description |
---|---|
protected class |
PdfFieldTree.FieldTreeIterator
An iterator over the tree of field dictionaries in a PDF document.
|
Modifier and Type | Field and Description |
---|---|
protected PdfCatalog |
_catalog
The catalog associated with this document.
|
protected static java.util.Set |
_inheritable
Defines the set of inheritable field attributes.
|
protected static java.util.Set |
_inheritableAcroForm
Defines the set of field attributes that are inheritable
from the AcroForm.
|
protected PdfManager |
_m
The manager associated with this document.
|
protected java.util.Stack |
_nested
A stack for holding nested levels of field nodes.
|
protected static PdfName |
PDFNAME_ACROFORM |
protected static PdfName |
PDFNAME_FIELDS |
protected static PdfName |
PDFNAME_KIDS |
protected static PdfName |
PDFNAME_PARENT |
protected static PdfName |
PDFNAME_T |
protected static PdfName |
PDFNAME_TYPE |
Constructor and Description |
---|
PdfFieldTree(PdfManager manager)
Constructs a
PdfFieldTree instance based on a
specified PdfManager . |
Modifier and Type | Method and Description |
---|---|
protected PdfObject |
getAcroForm()
Returns the interactive form dictionary of the document.
|
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.
|
protected java.util.Stack _nested
protected PdfManager _m
protected PdfCatalog _catalog
protected static java.util.Set _inheritable
protected static java.util.Set _inheritableAcroForm
protected static final PdfName PDFNAME_ACROFORM
protected static final PdfName PDFNAME_KIDS
protected static final PdfName PDFNAME_FIELDS
protected static final PdfName PDFNAME_PARENT
protected static final PdfName PDFNAME_T
protected static final PdfName PDFNAME_TYPE
public PdfFieldTree(PdfManager manager)
PdfFieldTree
instance based on a
specified PdfManager
.protected PdfObject getAcroForm() throws java.io.IOException, PdfFormatException
PdfDictionary
(the
AcroForm dictionary), a PdfReference
(an
indirect reference to the AcroForm dictionary), or
null
if there is no AcroForm dictionary
present.null
.java.io.IOException
PdfFormatException
public java.lang.String getFullyQualifiedName(PdfDictionary field) throws java.io.IOException, PdfFormatException
field
- the field dictionary.java.io.IOException
PdfFormatException
public PdfDictionary inheritAttributes(PdfDictionary field) throws java.io.IOException, PdfFormatException
field
- the field dictionary to be filled in with
inherited attributes.java.io.IOException
PdfFormatException
public PdfFieldTreeIterator getIterator() throws java.io.IOException, PdfFormatException
inheritAttributes(PdfDictionary)
should be used to obtain
inherited attributes.java.io.IOException
PdfFormatException