org.pdfbox.pdmodel.graphics.xobject

Class PDXObjectForm

Implemented Interfaces:
COSObjectable

public class PDXObjectForm
extends PDXObject

A form xobject.
Version:
$Revision: 1.5 $
Author:
Ben Litchfield

Field Summary

static String
SUB_TYPE
The XObject subtype.

Constructor Summary

PDXObjectForm(COSStream formStream)
Standard constuctor.
PDXObjectForm(PDStream formStream)
Standard constuctor.

Method Summary

int
getFormType()
This will get the form type, currently 1 is the only form type.
PDResources
getResources()
This will get the resources at this page and not look up the hierarchy.
void
setFormType(int formType)
Set the form type.
void
setResources(PDResources resources)
This will set the resources for this page.

Methods inherited from class org.pdfbox.pdmodel.graphics.xobject.PDXObject

createXObject, getCOSObject, getCOSStream, getMetadata, getPDStream, setMetadata

Field Details

SUB_TYPE

public static final String SUB_TYPE
The XObject subtype.

Constructor Details

PDXObjectForm

public PDXObjectForm(COSStream formStream)
Standard constuctor.
Parameters:
formStream - The XObject is passed as a COSStream.

PDXObjectForm

public PDXObjectForm(PDStream formStream)
Standard constuctor.
Parameters:
formStream - The XObject is passed as a COSStream.

Method Details

getFormType

public int getFormType()
This will get the form type, currently 1 is the only form type.
Returns:
The form type.

getResources

public PDResources getResources()
This will get the resources at this page and not look up the hierarchy. This attribute is inheritable, and findResources() should probably used. This will return null if no resources are available at this level.
Returns:
The resources at this level in the hierarchy.

setFormType

public void setFormType(int formType)
Set the form type.
Parameters:
formType - The new form type.

setResources

public void setResources(PDResources resources)
This will set the resources for this page.
Parameters:
resources - The new resources for this page.