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

public Class FDFPage

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 page that is part of the FDF document.
Author
Ben Litchfield

Field Summary

Modifier and TypeField and Description
private final COSDictionary
page

Constructor Summary

AccessConstructor and Description
public
FDFPage()

Default constructor.

public
FDFPage(COSDictionary
The FDF page.
p)

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 FDFPageInfo

Returns:

The Page info.
getPageInfo()

This will get the FDF page info object.

public List<FDFTemplate>

Returns:

A list of templates.
getTemplates()

This will get a list of FDFTemplage objects that describe the named pages that serve as templates.

public void
setPageInfo(FDFPageInfo
The new page info dictionary.
info)

This will set the page info.

public void
setTemplates(List<FDFTemplate>
A list of templates for this Page.
templates)

A list of FDFTemplate objects.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

pageback to summary
private final COSDictionary page

Constructor Detail

FDFPageback to summary
public FDFPage()

Default constructor.

FDFPageback to summary
public FDFPage(COSDictionary p)

Constructor.

Parameters
p:COSDictionary

The FDF page.

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
getPageInfoback to summary
public FDFPageInfo getPageInfo()

This will get the FDF page info object.

Returns:FDFPageInfo

The Page info.

getTemplatesback to summary
public List<FDFTemplate> getTemplates()

This will get a list of FDFTemplage objects that describe the named pages that serve as templates.

Returns:List<FDFTemplate>

A list of templates.

setPageInfoback to summary
public void setPageInfo(FDFPageInfo info)

This will set the page info.

Parameters
info:FDFPageInfo

The new page info dictionary.

setTemplatesback to summary
public void setTemplates(List<FDFTemplate> templates)

A list of FDFTemplate objects.

Parameters
templates:List<FDFTemplate>

A list of templates for this Page.