COSObjectable
PDCcitt
, PDJpeg
, PDPixelMap
public abstract class PDXObjectImage extends PDXObject
Modifier and Type | Field | Description |
---|---|---|
static java.lang.String |
SUB_TYPE |
The XObject subtype.
|
Constructor | Description |
---|---|
PDXObjectImage(PDStream imageStream,
java.lang.String fileSuffix) |
Standard constructor.
|
PDXObjectImage(PDDocument doc,
java.lang.String fileSuffix) |
Standard constuctor.
|
Modifier and Type | Method | Description |
---|---|---|
java.awt.image.BufferedImage |
applyMasks(java.awt.image.BufferedImage baseImage) |
|
static PDXObject |
createThumbnailXObject(COSBase xobject) |
Create the correct thumbnail from the cos base.
|
int |
getBitsPerComponent() |
The bits per component of this image.
|
PDColorSpace |
getColorSpace() |
This will get the color space.
|
COSArray |
getDecode() |
Returns the Decode Array of an XObjectImage.
|
int |
getHeight() |
Get the height of the image.
|
boolean |
getImageMask() |
Get the ImageMask flag.
|
COSBase |
getMask() |
Returns the optional mask of a XObjectImage if there is one.
|
abstract java.awt.image.BufferedImage |
getRGBImage() |
Returns an java.awt.Image, that can be used for display etc.
|
PDXObjectImage |
getSMaskImage() |
Returns a PDXObjectImage of the SMask image, if there is one.
|
PDColorState |
getStencilColor() |
Returns the non stroking colorstate to be used to create stencil makes images.
|
java.lang.String |
getSuffix() |
This will get the suffix for this image type, jpg/png.
|
int |
getWidth() |
Get the width of the image.
|
boolean |
hasMask() |
|
java.awt.image.BufferedImage |
imageMask(java.awt.image.BufferedImage baseImage) |
|
java.awt.image.BufferedImage |
mask(java.awt.image.BufferedImage baseImage) |
|
void |
setBitsPerComponent(int bpc) |
Set the number of bits per component.
|
void |
setColorSpace(PDColorSpace cs) |
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(java.io.File file) |
Writes the image to a file with the filename + an appropriate
suffix, like "Image.jpg".
|
void |
write2file(java.lang.String filename) |
Writes the image to a file with the filename + an appropriate suffix, like "Image.jpg".
|
abstract void |
write2OutputStream(java.io.OutputStream out) |
Writes the Image to out.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
clear, commonXObjectCreation, createXObject, getCOSObject, getCOSStream, getMetadata, getPDStream, getStructParent, setMetadata, setStructParent
public static final java.lang.String SUB_TYPE
public PDXObjectImage(PDStream imageStream, java.lang.String fileSuffix)
imageStream
- The XObject is passed as a COSStream.fileSuffix
- The file suffix, jpg/png.public PDXObjectImage(PDDocument doc, java.lang.String fileSuffix)
doc
- The document to store the stream in.fileSuffix
- The file suffix, jpg/png.public static PDXObject createThumbnailXObject(COSBase xobject) throws java.io.IOException
xobject
- The cos level xobject to create.java.io.IOException
- If there is an error creating the xobject.public abstract java.awt.image.BufferedImage getRGBImage() throws java.io.IOException
java.io.IOException
- If there is an error creating the image.public PDXObjectImage getSMaskImage() throws java.io.IOException
null
.java.io.IOException
- if an I/O error occurs creating an XObjectpublic java.awt.image.BufferedImage applyMasks(java.awt.image.BufferedImage baseImage) throws java.io.IOException
java.io.IOException
public boolean hasMask() throws java.io.IOException
java.io.IOException
public java.awt.image.BufferedImage imageMask(java.awt.image.BufferedImage baseImage) throws java.io.IOException
java.io.IOException
public java.awt.image.BufferedImage mask(java.awt.image.BufferedImage baseImage) throws java.io.IOException
java.io.IOException
public abstract void write2OutputStream(java.io.OutputStream out) throws java.io.IOException
out
- the OutputStream that the Image is written to.java.io.IOException
- when somethings wrong with outpublic void write2file(java.lang.String filename) throws java.io.IOException
filename
- the filenamejava.io.IOException
- When somethings wrong with the corresponding file.public void write2file(java.io.File file) throws java.io.IOException
file
- the filejava.io.IOException
- When somethings wrong with the corresponding file.public int getHeight()
public void setHeight(int height)
height
- The height of the image.public int getWidth()
public void setWidth(int width)
width
- The width of the image.public int getBitsPerComponent()
public void setBitsPerComponent(int bpc)
bpc
- The number of bits per component.public PDColorSpace getColorSpace() throws java.io.IOException
java.io.IOException
- If there is an error getting the colorspace.public void setColorSpace(PDColorSpace cs)
cs
- The color space for this image.public java.lang.String getSuffix()
public boolean getImageMask()
public void setStencilColor(PDColorState stencilColorValue)
stencilColorValue
- The non stroking colorstatepublic PDColorState getStencilColor()
public COSArray getDecode()
public COSBase getMask()