org.apache.pdfbox.pdmodel.graphics.image

Class PDImageXObjectProxy

java.lang.Object

org.apache.pdfbox.pdmodel.graphics.PDXObject

org.apache.pdfbox.pdmodel.graphics.image.PDImageXObjectProxy

All Implemented Interfaces:

COSObjectable, PDInheritableResource

public class PDImageXObjectProxy
extends PDXObject

Author:

Maksim Bezrukov

Constructor Summary

Constructors

Constructor and Description
PDImageXObjectProxy(PDStream stream, PDResources resources)

Method Summary

Modifier and Type	Method and Description
int	getBitsPerComponent()
PDColorSpace	getColorSpace()
int	getHeight()
boolean	getInterpolate()
PDImageXObjectProxy	getMask() Returns the Mask Image XObject associated with this image, or null if there is none.
PDMetadata	getMetadata() Returns the metadata associated with this XObject, or null if there is none.
PDResources	getResources()
PDImageXObjectProxy	getSoftMask() Returns the Soft Mask Image XObject associated with this image, or null if there is none.
PDStream	getStream()
int	getStructParent() Returns the key of this XObject in the structural parent tree.
int	getWidth()
boolean	isStencil()

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

createXObject, getCOSObject, getCOSStream, getPDStream, isInherited, setInherited

Methods inherited from class java.lang.Object

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

Constructor Detail

PDImageXObjectProxy

public PDImageXObjectProxy(PDStream stream,
                           PDResources resources)

Method Detail

getInterpolate

public boolean getInterpolate()

isStencil

public boolean isStencil()

getColorSpace

public PDColorSpace getColorSpace()
                           throws IOException

Throws:

IOException

getMask

public PDImageXObjectProxy getMask()
                            throws IOException

Returns the Mask Image XObject associated with this image, or null if there is none.

Returns:

Mask Image XObject

Throws:

IOException

getSoftMask

public PDImageXObjectProxy getSoftMask()
                                throws IOException

Returns the Soft Mask Image XObject associated with this image, or null if there is none.

Returns:

the SMask Image XObject, or null.

Throws:

IOException

getHeight

public int getHeight()

getWidth

public int getWidth()

getStructParent

public int getStructParent()

Returns the key of this XObject in the structural parent tree.

Returns:

this object's key the structural parent tree

getBitsPerComponent

public int getBitsPerComponent()

getStream

public PDStream getStream()
                   throws IOException

Throws:

IOException

getResources

public PDResources getResources()

getMetadata

public PDMetadata getMetadata()

Returns the metadata associated with this XObject, or null if there is none.

Returns:

the metadata associated with this object.