Class PDXObjectImage
java.lang.Object
org.apache.pdfbox.pdmodel.graphics.xobject.PDXObject
org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectImage
- All Implemented Interfaces:
COSObjectable
- Direct Known Subclasses:
PDCcitt
,PDJpeg
,PDPixelMap
The prototype for all PDImages.
- Version:
- $Revision: 1.9 $
- Author:
- Ben Litchfield, mathiak
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionPDXObjectImage
(PDStream imageStream, String fileSuffix) Standard constructor.PDXObjectImage
(PDDocument doc, String fileSuffix) Standard constuctor. -
Method Summary
Modifier and TypeMethodDescriptionapplyMasks
(BufferedImage baseImage) static PDXObject
createThumbnailXObject
(COSBase xobject) Create the correct thumbnail from the cos base.int
The bits per component of this image.This will get the color space.Returns the Decode Array of an XObjectImage.int
Get the height of the image.boolean
Get the ImageMask flag.getMask()
Returns the optional mask of a XObjectImage if there is one.abstract BufferedImage
Returns an java.awt.Image, that can be used for display etc.Returns a PDXObjectImage of the SMask image, if there is one.Returns the non stroking colorstate to be used to create stencil makes images.This will get the suffix for this image type, jpg/png.int
getWidth()
Get the width of the image.boolean
hasMask()
imageMask
(BufferedImage baseImage) mask
(BufferedImage baseImage) void
setBitsPerComponent
(int bpc) Set the number of bits per component.void
This will set the color space for this image.void
setHeight
(int height) Set the height of the image.void
setStencilColor
(PDColorState stencilColorValue) Set the current non stroking colorstate.void
setWidth
(int width) Set the width of the image.void
write2file
(File file) Writes the image to a file with the filename + an appropriate suffix, like "Image.jpg".void
write2file
(String filename) Writes the image to a file with the filename + an appropriate suffix, like "Image.jpg".abstract void
Writes the Image to out.Methods inherited from class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObject
clear, commonXObjectCreation, createXObject, getCOSObject, getCOSStream, getMetadata, getPDStream, getStructParent, setMetadata, setStructParent
-
Field Details
-
SUB_TYPE
The XObject subtype.- See Also:
-
-
Constructor Details
-
PDXObjectImage
Standard constructor.- Parameters:
imageStream
- The XObject is passed as a COSStream.fileSuffix
- The file suffix, jpg/png.
-
PDXObjectImage
Standard constuctor.- Parameters:
doc
- The document to store the stream in.fileSuffix
- The file suffix, jpg/png.
-
-
Method Details
-
createThumbnailXObject
Create the correct thumbnail from the cos base.- Parameters:
xobject
- The cos level xobject to create.- Returns:
- a pdmodel xobject
- Throws:
IOException
- If there is an error creating the xobject.
-
getRGBImage
Returns an java.awt.Image, that can be used for display etc.- Returns:
- This PDF object as an AWT image.
- Throws:
IOException
- If there is an error creating the image.
-
getSMaskImage
Returns a PDXObjectImage of the SMask image, if there is one. See section 11.5 of the pdf specification for details on Soft Masks.- Returns:
- the PDXObjectImage of the SMask if there is one, else
null
. - Throws:
IOException
- if an I/O error occurs creating an XObject
-
applyMasks
- Throws:
IOException
-
hasMask
- Throws:
IOException
-
imageMask
- Throws:
IOException
-
mask
- Throws:
IOException
-
write2OutputStream
Writes the Image to out.- Parameters:
out
- the OutputStream that the Image is written to.- Throws:
IOException
- when somethings wrong with out
-
write2file
Writes the image to a file with the filename + an appropriate suffix, like "Image.jpg". The suffix is automatically set by the- Parameters:
filename
- the filename- Throws:
IOException
- When somethings wrong with the corresponding file.
-
write2file
Writes the image to a file with the filename + an appropriate suffix, like "Image.jpg". The suffix is automatically set by the- Parameters:
file
- the file- Throws:
IOException
- When somethings wrong with the corresponding file.
-
getHeight
public int getHeight()Get the height of the image.- Returns:
- The height of the image.
-
setHeight
public void setHeight(int height) Set the height of the image.- Parameters:
height
- The height of the image.
-
getWidth
public int getWidth()Get the width of the image.- Returns:
- The width of the image.
-
setWidth
public void setWidth(int width) Set the width of the image.- Parameters:
width
- The width of the image.
-
getBitsPerComponent
public int getBitsPerComponent()The bits per component of this image. This will return -1 if one has not been set.- Returns:
- The number of bits per component.
-
setBitsPerComponent
public void setBitsPerComponent(int bpc) Set the number of bits per component.- Parameters:
bpc
- The number of bits per component.
-
getColorSpace
This will get the color space.- Returns:
- The color space for this image or null if none exists or if it isn't known yet.
- Throws:
IOException
- If there is an error getting the colorspace.
-
setColorSpace
This will set the color space for this image.- Parameters:
cs
- The color space for this image.
-
getSuffix
This will get the suffix for this image type, jpg/png.- Returns:
- The image suffix.
-
getImageMask
public boolean getImageMask()Get the ImageMask flag. Used in Stencil Masking. Section 4.8.5 of the spec.- Returns:
- The ImageMask flag. This is optional and defaults to False, so if it does not exist, we return False
-
setStencilColor
Set the current non stroking colorstate. It'll be used to create stencil masked images.- Parameters:
stencilColorValue
- The non stroking colorstate
-
getStencilColor
Returns the non stroking colorstate to be used to create stencil makes images.- Returns:
- The current non stroking colorstate.
-
getDecode
Returns the Decode Array of an XObjectImage.- Returns:
- the decode array
-
getMask
Returns the optional mask of a XObjectImage if there is one.- Returns:
- The mask otherwise null.
-