org.apache.pdfbox.pdmodel.interactive.annotation

Class PDAppearanceStream

java.lang.Object

org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceStream

All Implemented Interfaces:

COSObjectable

public class PDAppearanceStream
extends Object
implements COSObjectable

This class represents an appearance for an annotation.

Version:

$Revision: 1.4 $

Author:

Ben Litchfield

Constructor Summary

Constructors

Constructor and Description
PDAppearanceStream(COSStream s) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
PDRectangle	getBoundingBox() Get the bounding box for this appearance.
COSBase	getCOSObject() Convert this standard java object to a COS object.
Matrix	getMatrix() Gets the optional matrix for this appearance.
PDResources	getResources() This will get the resources for this appearance stream.
COSStream	getStream() This will return the underlying stream.
void	setBoundingBox(PDRectangle rectangle) This will set the bounding box for this appearance stream.
void	setMatrix(AffineTransform transform) Sets the optional Matrix entry for this appearance.
void	setResources(PDResources resources) This will set the new resources.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PDAppearanceStream

public PDAppearanceStream(COSStream s)

Constructor.

Parameters:

s - The cos stream for this appearance.

Method Detail

getStream

public COSStream getStream()

This will return the underlying stream.

Returns:

The wrapped stream.

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.

getBoundingBox

public PDRectangle getBoundingBox()

Get the bounding box for this appearance. This may return null in which case the Rectangle from the annotation should be used.

Returns:

The bounding box for this appearance.

setBoundingBox

public void setBoundingBox(PDRectangle rectangle)

This will set the bounding box for this appearance stream.

Parameters:

rectangle - The new bounding box.

getResources

public PDResources getResources()

This will get the resources for this appearance stream.

Returns:

The appearance stream resources.

setResources

public void setResources(PDResources resources)

This will set the new resources.

Parameters:

resources - The new resources.

getMatrix

public Matrix getMatrix()

Gets the optional matrix for this appearance. This may return null.

Returns:

The matrix of this appearance.

setMatrix

public void setMatrix(AffineTransform transform)

Sets the optional Matrix entry for this appearance.

Parameters:

transform - the transformation matrix