org.pdfbox.pdmodel.fdf

Class FDFTemplate

Implemented Interfaces:
COSObjectable

public class FDFTemplate
extends java.lang.Object
implements COSObjectable

This represents an FDF template that is part of the FDF page.
Version:
$Revision: 1.3 $
Author:
Ben Litchfield

Constructor Summary

FDFTemplate()
Default constructor.
FDFTemplate(COSDictionary t)
Constructor.

Method Summary

COSDictionary
getCOSDictionary()
Convert this standard java object to a COS object.
COSBase
getCOSObject()
Convert this standard java object to a COS object.
List
getFields()
This will get a list of fields that are part of this template.
FDFNamedPageReference
getTemplateReference()
This is the template reference.
void
setFields(List fields)
This will set a list of fields for this template.
void
setRename(boolean value)
This will set if the fields can be renamed.
void
setTemplateReference(FDFNamedPageReference tRef)
This will set the template reference.
boolean
shouldRename()
A flag telling if the fields imported from the template may be renamed if there are conflicts.

Constructor Details

FDFTemplate

public FDFTemplate()
Default constructor.

FDFTemplate

public FDFTemplate(COSDictionary t)
Constructor.
Parameters:
t - The FDF page template.

Method Details

getCOSDictionary

public COSDictionary getCOSDictionary()
Convert this standard java object to a COS object.
Returns:
The cos object that matches this Java object.

getCOSObject

public COSBase getCOSObject()
Convert this standard java object to a COS object.
Specified by:
getCOSObject in interface COSObjectable
Returns:
The cos object that matches this Java object.

getFields

public List getFields()
This will get a list of fields that are part of this template.
Returns:
A list of fields.

getTemplateReference

public FDFNamedPageReference getTemplateReference()
This is the template reference.
Returns:
The template reference.

setFields

public void setFields(List fields)
This will set a list of fields for this template.
Parameters:
fields - The list of fields to set for this template.

setRename

public void setRename(boolean value)
This will set if the fields can be renamed.
Parameters:
value - The flag value.

setTemplateReference

public void setTemplateReference(FDFNamedPageReference tRef)
This will set the template reference.
Parameters:
tRef - The template reference.

shouldRename

public boolean shouldRename()
A flag telling if the fields imported from the template may be renamed if there are conflicts.
Returns:
A flag telling if the fields can be renamed.