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

public Class FDFTemplate

extends Object
implements COSObjectable
Class Inheritance
All Implemented Interfaces
org.apache.pdfbox.pdmodel.common.COSObjectable
Imports
java.util.ArrayList, .List, org.apache.pdfbox.cos.COSArray, .COSDictionary, .COSName, org.apache.pdfbox.pdmodel.common.COSArrayList, .COSObjectable
This represents an FDF template that is part of the FDF page.
Author
Ben Litchfield

Field Summary

Modifier and TypeField and Description
private final COSDictionary
template

Constructor Summary

AccessConstructor and Description
public
FDFTemplate()

Default constructor.

public
FDFTemplate(COSDictionary
The FDF page template.
t)

Constructor.

Method Summary

Modifier and TypeMethod and Description
public COSDictionary

Returns:

The cos object that matches this Java object.
getCOSObject()

Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject.

Convert this standard java object to a COS object.

public List<FDFField>

Returns:

A list of fields.
getFields()

This will get a list of fields that are part of this template.

public FDFNamedPageReference

Returns:

The template reference.
getTemplateReference()

This is the template reference.

public void
setFields(List<FDFField>
The list of fields to set for this template.
fields)

This will set a list of fields for this template.

public void
setRename(boolean
The flag value.
value)

This will set if the fields can be renamed.

public void
setTemplateReference(FDFNamedPageReference
The template reference.
tRef)

This will set the template reference.

public boolean

Returns:

A flag telling if the fields can be renamed.
shouldRename()

A flag telling if the fields imported from the template may be renamed if there are conflicts.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

templateback to summary
private final COSDictionary template

Constructor Detail

FDFTemplateback to summary
public FDFTemplate()

Default constructor.

FDFTemplateback to summary
public FDFTemplate(COSDictionary t)

Constructor.

Parameters
t:COSDictionary

The FDF page template.

Method Detail

getCOSObjectback to summary
public COSDictionary getCOSObject()

Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject.

Convert this standard java object to a COS object.

Returns:COSDictionary

The cos object that matches this Java object.

Annotations
@Override
getFieldsback to summary
public List<FDFField> getFields()

This will get a list of fields that are part of this template.

Returns:List<FDFField>

A list of fields.

getTemplateReferenceback to summary
public FDFNamedPageReference getTemplateReference()

This is the template reference.

Returns:FDFNamedPageReference

The template reference.

setFieldsback to summary
public void setFields(List<FDFField> fields)

This will set a list of fields for this template.

Parameters
fields:List<FDFField>

The list of fields to set for this template.

setRenameback to summary
public void setRename(boolean value)

This will set if the fields can be renamed.

Parameters
value:boolean

The flag value.

setTemplateReferenceback to summary
public void setTemplateReference(FDFNamedPageReference tRef)

This will set the template reference.

Parameters
tRef:FDFNamedPageReference

The template reference.

shouldRenameback to summary
public boolean shouldRename()

A flag telling if the fields imported from the template may be renamed if there are conflicts.

Returns:boolean

A flag telling if the fields can be renamed.