public class

FDFField

extends Object
implements AutoCloseable
java.lang.Object
   ↳ com.pdftron.fdf.FDFField

Class Overview

TODO: need description FDFField represents FDFField

Summary

Public Constructors
FDFField(Obj field_dict, Obj fdf_dict)
Construct a FDF::FDFField from a SDF dictionary representing a terminal field node.
Public Methods
void close()
Frees the native memory of the object.
void destroy()
Frees the native memory of the object.
Obj findAttribute(String attrib)
The function returns the specified attribute.
String getName()
Get name of the FDFField
String getPartialName()
Get partial name of the FDFField
Obj getSDFObj()
Get underlying SDF object
Obj getValue()
Get value of the FDFField

Note: The format of field's value varies depending on the field type.

void setValue(Obj value)
Set the value of the FDFField (the value of the field's /V key).
[Expand]
Inherited Methods
From class java.lang.Object
From interface java.lang.AutoCloseable

Public Constructors

public FDFField (Obj field_dict, Obj fdf_dict)

Construct a FDF::FDFField from a SDF dictionary representing a terminal field node.

Throws
PDFNetException

Public Methods

public void close ()

Frees the native memory of the object. This can be explicity called to control the deallocation of native memory and avoid situations where the garbage collector does not free the object in a timely manner.

Throws
PDFNetException

public void destroy ()

Frees the native memory of the object. This can be explicity called to control the deallocation of native memory and avoid situations where the garbage collector does not free the object in a timely manner.

Throws
PDFNetException

public Obj findAttribute (String attrib)

The function returns the specified attribute.

Returns
  • return the attribute value if the given attribute name was found or a NULL object if the given attribute name was not found.
Throws
PDFNetException

public String getName ()

Get name of the FDFField

Returns
  • a string representing the fully qualified name of the field (e.g. "employee.name.first").
Throws
PDFNetException

public String getPartialName ()

Get partial name of the FDFField

Returns
  • a string representing the partial name of the field (e.g. "first" when "employee.name.first" is fully qualified name).
Throws
PDFNetException

public Obj getSDFObj ()

Get underlying SDF object

Returns
  • the object to the underlying SDF/Cos object.
Throws
PDFNetException

public Obj getValue ()

Get value of the FDFField

Note: The format of field's value varies depending on the field type.

Returns
  • the value of the Field (the value of its /V key) or NULL if the value is not specified.
Throws
PDFNetException

public void setValue (Obj value)

Set the value of the FDFField (the value of the field's /V key). The format of field's value varies depending on the field type.

Note: in order to remove/erase the existing value use SetValue(SDF::Null)

Throws
PDFNetException