org.apache.pdfbox.pdmodel.graphics.xobject
Class PDXObjectForm

java.lang.Object
  extended by org.apache.pdfbox.pdmodel.graphics.xobject.PDXObject
      extended by org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectForm
All Implemented Interfaces:
COSObjectable

public class PDXObjectForm
extends PDXObject

A form xobject.

Version:
$Revision: 1.6 $
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
 PDRectangle getBBox()
          An array of four numbers in the form coordinate system (see below), giving the coordinates of the left, bottom, right, and top edges, respectively, of the form XObject's bounding box.
 int getFormType()
          This will get the form type, currently 1 is the only form type.
 Matrix getMatrix()
          This will get the optional Matrix of an XObjectForm.
 PDResources getResources()
          This will get the resources at this page and not look up the hierarchy.
 void setBBox(PDRectangle bbox)
          This will set the BBox (bounding box) for this form.
 void setFormType(int formType)
          Set the form type.
 void setMatrix(AffineTransform transform)
          Sets the optional Matrix entry for the form XObject.
 void setResources(PDResources resources)
          This will set the resources for this page.
 
Methods inherited from class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObject
createXObject, getCOSObject, getCOSStream, getMetadata, getPDStream, setMetadata
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

SUB_TYPE

public static final String SUB_TYPE
The XObject subtype.

See Also:
Constant Field Values
Constructor Detail

PDXObjectForm

public PDXObjectForm(PDStream formStream)
Standard constuctor.

Parameters:
formStream - The XObject is passed as a COSStream.

PDXObjectForm

public PDXObjectForm(COSStream formStream)
Standard constuctor.

Parameters:
formStream - The XObject is passed as a COSStream.
Method Detail

getFormType

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

Returns:
The form type.

setFormType

public void setFormType(int formType)
Set the form type.

Parameters:
formType - The new 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.

setResources

public void setResources(PDResources resources)
This will set the resources for this page.

Parameters:
resources - The new resources for this page.

getBBox

public PDRectangle getBBox()
An array of four numbers in the form coordinate system (see below), giving the coordinates of the left, bottom, right, and top edges, respectively, of the form XObject's bounding box. These boundaries are used to clip the form XObject and to determine its size for caching.

Returns:
The BBox of the form.

setBBox

public void setBBox(PDRectangle bbox)
This will set the BBox (bounding box) for this form.

Parameters:
bbox - The new BBox for this form.

getMatrix

public Matrix getMatrix()
This will get the optional Matrix of an XObjectForm. It maps the form space into the user space

Returns:
the form matrix

setMatrix

public void setMatrix(AffineTransform transform)
Sets the optional Matrix entry for the form XObject.

Parameters:
transform - the transformation matrix


Copyright © 2002-2012 Apache Software Foundation. All Rights Reserved.