de.intarsys.pdf.pd
Class PDForm

java.lang.Object
  de.intarsys.pdf.cos.COSBasedObject
      de.intarsys.pdf.pd.PDObject
          de.intarsys.pdf.pd.PDXObject
              de.intarsys.pdf.pd.PDForm

All Implemented Interfaces:

IContentStreamProvider, ICOSObjectListener, IResourcesProvider, de.intarsys.tools.attribute.IAttributeSupport

public class PDForm
extends PDXObject
implements IContentStreamProvider

A form object. A form object specifies a reusable graphical object (not an AcroForm).

Nested Class Summary

static class

PDForm.MetaClass The meta class implementation

Field Summary

static COSName	CN_Subtype_Form
static COSName	DK_BBox
static COSName	DK_FormType
static COSName	DK_Group
static COSName	DK_Matrix
static COSName	DK_OPI
static COSName	DK_PieceInfo
static COSName	DK_PS
static COSName	DK_Subtype2
static PDForm.MetaClass	META The meta class instance

Fields inherited from class de.intarsys.pdf.pd.PDXObject

CN_Type_XObject, DK_Resources

Fields inherited from class de.intarsys.pdf.pd.PDObject

DK_Subtype, DK_Type

Method Summary

void	addMarkedContent(byte[] content) Add new marked content to the stream.
COSDictionary	cosGetPieceInfo() The piece info dictionary of the document.
COSDictionary	cosSetPieceInfo(COSDictionary dict) Set the piece info dictionary of the document.
PDApplicationData	getApplicationData(COSName name)
CDSRectangle	getBoundingBox() The bounding box of the receiver form.
CSContent	getContentStream() The CSContent contained in this.
CDSMatrix	getMatrix() The form matrix of the receiver form.
PDResources	getResources() The resource dictionary of the receiver form.
Rectangle2D	getTransformedBBox() Compute a box according to the PDF specification that completely encompasses the transformed bounding box of the form.
void	invalidateCaches() Invalidate all local caches as the base object may have changed.
boolean	isForm() true if this is a form.
void	setApplicationData(COSName name, PDApplicationData data)
void	setBoundingBox(CDSRectangle rect) Set the bounding box of the receiver.
void	setContentStream(CSContent content) Assign the new CSContent to this.
void	setMarkedContent(byte[] content) Set the new variable content of the stream.
void	setMatrix(CDSMatrix matrix) Set the matrix of the receiver.
void	setResources(PDResources resources)

Methods inherited from class de.intarsys.pdf.pd.PDXObject

cosGetDict, getBytes, isImage, isPostscript, setBytes

Methods inherited from class de.intarsys.pdf.pd.PDObject

cosGetFieldDescendant, cosGetFieldInheritable, cosGetFieldInherited, cosGetSubtype, cosGetType, cosRemoveFieldInheritable, cosSetFieldInheritable, cosSetSubtype, cosSetType, getDoc, getGenericChildren, getGenericParent, setGenericParent, toString

Methods inherited from class de.intarsys.pdf.cos.COSBasedObject

changed, cosGetArray, cosGetDoc, cosGetField, cosGetObject, cosGetStream, cosHasField, cosRemoveField, cosSetField, getAttribute, getFieldBoolean, getFieldDate, getFieldFixed, getFieldFixedArray, getFieldInt, getFieldMLString, getFieldString, removeAttribute, setAttribute, setFieldBoolean, setFieldFixed, setFieldInt, setFieldMLString, setFieldName, setFieldObject, setFieldString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

META

public static final PDForm.MetaClass META

The meta class instance

CN_Subtype_Form

public static final COSName CN_Subtype_Form

DK_BBox

public static final COSName DK_BBox

DK_Matrix

public static final COSName DK_Matrix

DK_PieceInfo

public static final COSName DK_PieceInfo

DK_FormType

public static final COSName DK_FormType

DK_OPI

public static final COSName DK_OPI

DK_PS

public static final COSName DK_PS

DK_Subtype2

public static final COSName DK_Subtype2

DK_Group

public static final COSName DK_Group

Method Detail

setApplicationData

public void setApplicationData(COSName name,
                               PDApplicationData data)

getApplicationData

public PDApplicationData getApplicationData(COSName name)

setBoundingBox

public void setBoundingBox(CDSRectangle rect)

Set the bounding box of the receiver.

Parameters:

rect - The new bounding box of the receiver.

getBoundingBox

public CDSRectangle getBoundingBox()

The bounding box of the receiver form.

Returns:

The bounding box of the receiver form.

getContentStream

public CSContent getContentStream()

Description copied from interface: IContentStreamProvider

The CSContent contained in this.

Specified by:

getContentStream in interface IContentStreamProvider

Returns:

The CSContent contained in this.

setContentStream

public void setContentStream(CSContent content)

Description copied from interface: IContentStreamProvider

Assign the new CSContent to this.

Specified by:

setContentStream in interface IContentStreamProvider

Parameters:

content - The new content

isForm

public boolean isForm()

Description copied from class: PDXObject

true if this is a form.

Overrides:

isForm in class PDXObject

Returns:

true if this is a form.

setMarkedContent

public void setMarkedContent(byte[] content)

Set the new variable content of the stream.

Parameters:

content - The new variable content of the stream.

setMatrix

public void setMatrix(CDSMatrix matrix)

Set the matrix of the receiver.

Parameters:

matrix - The new matrix of the receiver.

getMatrix

public CDSMatrix getMatrix()

The form matrix of the receiver form.

Returns:

The form matrix of the receiver form.

getResources

public PDResources getResources()

The resource dictionary of the receiver form. This method can return null if no resource dictionary is available.

Specified by:

getResources in interface IResourcesProvider

Returns:

The resource dictionary of the receiver form.

setResources

public void setResources(PDResources resources)

Specified by:

setResources in interface IResourcesProvider

getTransformedBBox

public Rectangle2D getTransformedBBox()

Compute a box according to the PDF specification that completely encompasses the transformed bounding box of the form.

Returns:

a box according to the PDF specification that completely encompasses the transformed bounding box of the form.

addMarkedContent

public void addMarkedContent(byte[] content)

Add new marked content to the stream.

Parameters:

content - The new variable content of the stream.

cosGetPieceInfo

public COSDictionary cosGetPieceInfo()

The piece info dictionary of the document.

Returns:

The piece info dictionary of the document.

cosSetPieceInfo

public COSDictionary cosSetPieceInfo(COSDictionary dict)

Set the piece info dictionary of the document.

Parameters:

dict - The piece info dictionary of the document.

Returns:

The /PieceInfo entry previously associated with this.

invalidateCaches

public void invalidateCaches()

Description copied from class: COSBasedObject

Invalidate all local caches as the base object may have changed.

Overrides:

invalidateCaches in class COSBasedObject