Image Class Documentation

classImage : Element

Namespace:com::datalogics::PDFL

Inherits from:
Element

Detailed Description

An image resource can either be an image XObject or inline image found in a page's content stream. An Image Xobject is stored separately from the graphics content stream in a PDF, and so can be used multiple times in the document, even across pages. The image is described in the /Xobject entry in the resources dictionary on the PDF page.

Image size and resoultion: For images that are imported from raster image files, the design width and height are stored in the Image object's Matrix, in the A (width) and D (depth) Matrix members, when the image is imported. These are stored in PDF units.

To derive the effective resolution of an image imported from a raster image file:

Horizontal resolution: divide the Image Width by the Image's Matrix A member and multiply by 72 to scale to DPI (dots per inch).

Vertical resolution: divide the Image Height by the Image's Matrix D member and multiply by 72 to scale to DPI (dots per inch).

Referenced by

ImageImageCollectionOCREnginePage

Constructor & Destructor Documentation

Image

Image(StreamFilesf, booleanignore)

Parameters

sf: StreamFile
ignore: boolean

Image

Image(byte[]buffer, intwidth, intheight, ColorSpacecolorSpace)

Parameters

buffer: byte[]

contains Image's data

width: int

width of the image

height: int

height of the image

colorSpace: ColorSpace

colorspace with wich Image object will be created

Create an image from byte array. This constructor expects that input buffer is non-padded. If buffer doesn't correspond to the expected format, it will be stripped.
For example: The bitmap data generated by Page's drawContents(DrawParams) function is 32-bit aligned. The PDF image operator expects, however, 8-bit aligned image data. To remedy this difference, we check to see if the 32-bit aligned width is different from the 8-bit aligned width. If so, we fix the image data by stripping off the padding at the end.

Image

Image(javax.imageio.stream.ImageInputStreamstream)

Parameters

stream: javax.imageio.stream.ImageInputStream

Allows to create Image object from ImageInputStream.

Image

Image(StringfileName)

Parameters

fileName: String

the filename of the image file.

Create a new Image from an existing physical file. This file can be a bitmap, gif, jpeg, png, or a tiff file. An exception will be thrown if the image file is not any of the above.

NOTICE on tiff files: If the tiff file is multi-paged, then the first "page" only of the file will be converted to an Image. See ImageCollection to convert each page in a multi-page tiff file to an Image.

Image

Image(StringfileName, Documentdocument)

Parameters

fileName: String

the filename of the image file.

document: Document

the document in which the image is intended to be used.

Create a new Image from an existing physical file. This file can be a bitmap, gif, jpeg, png, or a tiff file. An exception will be thrown if the image file is not any of the above.

Specifying the document optimizes data usage for this image within that document.

NOTICE on tiff files: If the tiff file is multi-paged, then the first "page" only of the file will be converted to an Image. See ImageCollection to convert each page in a multi-page tiff file to an Image.

Member Function Documentation

DisposeChildren

voidDisposeChildren()

Returns:

void

[static initializer]

static void[static initializer]()

changeResolution

ImagechangeResolution(intdpi)

Parameters

dpi: int

the new resolution

Returns:

newimage - the original image modified to the new resolution.

Create a new image from an existing one modifying the resolution (dots per inch)

clone

Imageclone()

Returns:

The copied image.

Makes a copy of the image.

Make a copy of an image to obtain a new image that has a distinct set of attributes.

clone

Imageclone(java.util.EnumSet< ElementCloneFlags >cloneFlags)

Parameters

cloneFlags: java.util.EnumSet< ElementCloneFlags >

Flags that modify the cloning operation.

Returns:

The copied image.

Makes a copy of the image.

Make a copy of an image to obtain a new image that has a distinct set of attributes.

colorConvert

ImagecolorConvert(Documentdocument, ColorProfileprof, RenderIntentintent, booleanembed)

Parameters

document: Document

The document the element belongs to.

prof: ColorProfile

The ICC ColorProfile to be applied.

intent: RenderIntent

The ICC Rendering Intent for the ColorProfile

embed: boolean

If true, embed the color space and make the object calibrated. If it is false and the target profile is CMYK, RGB, or Gray, the colors space of the resulting object, after conversion, will be DeviceCMYK, DeviceRGB, or DeviceGray, respectively.

Returns:

A new Image with the applied ICC ColorProfile.

Applies the specified ICC ColorProfile to the Image

delete

synchronized voiddelete(Booleandisposing)

Parameters

disposing: Boolean

Returns:

synchronized void

delete

synchronized voiddelete()

Returns:

synchronized void

finalize

voidfinalize()

Returns:

void

getBitsPerComponent

intgetBitsPerComponent()

Returns:

The number of bits per component (e.g. 1, 2, 4, 8, or 16).

The number of bits per component in the image.

getBoundingBox

RectgetBoundingBox()

Returns:

The bounding box for this element. The coordinates of the bounding box are specified in user space coordinates, relative to the element's Content. Note that user space coordinates correspond to unrotated pages; any rotation specified in the page dictionary is not taken into account.

The bounding box for this element. The bounding box is a rectangle that is guaranteed to encompass the element, but it is not guaranteed to be the smallest box that could contain the element. For example, if the element is a Path that contains an arc, the bounding box encompasses the bezier control points, and not just the curve itself.

getBufferedImage

java.awt.image.BufferedImagegetBufferedImage()

Returns:

java.awt.image.BufferedImage

Return this PDF image as a Java BufferedImage.

Images in Gray or RGB color spaces are returned without conversion, while images in other spaces are first converted to RGB.

getClip

ClipgetClip()

Returns:

The current Clip for this Element, or NULL if no clip is set.

Gets the current Clip for an Element.

getColorSpace

ColorSpacegetColorSpace()

Returns:

ColorSpace

return the ColorSpace with which this Image was created.

getCompression

CompressionCodegetCompression()

Returns:

A compression code which represents the filter used in the image data.

The compression filter applied to the image data.

getData

byte[]getData()

Returns:

A byte array containing the raw image data.

The actual bytes that make up the image, exactly as they appear in the image data.

getDidWarningsOccurDuringImport

booleangetDidWarningsOccurDuringImport()

Returns:

true if warnings were generated during the image import process, false otherwise.

Indicates whether warnings occurred during import of the raster image file.

getGraphicState

GraphicStategetGraphicState()

Returns:

The GraphicState associated with this image element.

The graphic state of the current element.

getHeight

intgetHeight()

Returns:

The height of the image in pixels.

The height of the image in pixels.

getIntent

StringgetIntent()

Returns:

The rendering intent name as a string.

The color rendering intent for the image.

getIsImageMask

booleangetIsImageMask()

Returns:

true if the image is an image mask, false otherwise.

Indicates whether this image is an image mask. An image mask is a 1-bit-per-pixel image used to select painting in the current color rather than displaying image samples.

getLargeData

java.util.List< ImageData >getLargeData()

Returns:

A list of ImageData chunks containing the decompressed image data.

Gets the decompressed image data from very large images. NOTE: This function is only supported in 64-bit, only if enough contiguous memory is available. The data size must exceed nearly 2GB, otherwise an exception is thrown and you would use the Data member instead to access the image data. The first members of the list returned contain a close to 2GB chunk of the data, but the last member containing the remaining data will be smaller in size. This facilitates retrieving the data in .NET and Java which have 2GB limits on object sizes.

getMatrix

MatrixgetMatrix()

Returns:

The current transformation matrix applied to this element.

The transformation matrix for the element.

getNumberComponents

intgetNumberComponents()

Returns:

The number of color components (e.g. 1 for grayscale, 3 for RGB, 4 for CMYK).

The number of color components in the image.

getSoftMask

ImagegetSoftMask()

Returns:

image - an image, the soft mask

Gets, for this image, the soft mask (also an image).

getStream

PDFStreamgetStream()

Returns:

The PDFStream object, or null if there is no stream associated with the image.

The PDFStream object associated with the image.

getWidth

intgetWidth()

Returns:

The width of the image in pixels.

The width of the image in pixels.

internalGetColorSpaceHival

longinternalGetColorSpaceHival()

Returns:

long

internalGetColorSpaceTable

byte[]internalGetColorSpaceTable()

Returns:

byte[]

internalGetData

voidinternalGetData(byte[]buffer)

Parameters

buffer: byte[]

Returns:

void

Retrieve the image data into the specified buffer.

internalGetData

voidinternalGetData(byte[]buffer, longstride)

Parameters

buffer: byte[]

the buffer into which the image data is copied

stride: long

the width of each row of pixels, of 0 if same as width of image.

Returns:

void

Retrieve the image data into the specified buffer.

internalGetNumColorSpaceComps

longinternalGetNumColorSpaceComps()

Returns:

long

rotate

voidrotate(doubleangle)

Parameters

angle: double

The rotation angle in degrees, counterclockwise.

Returns:

void

Rotate an image on (angle) degree using the matrix [cos(a), sin(a), -sin(a), cos(a), 0, 0]. For images, this rotate is done without regard to the primary scaling of the original image.

save

voidsave(Stringimagefilename, ImageTypeimageType)

Parameters

imagefilename: String

The physical image file which will be created.

imageType: ImageType

The IMAGETYPE used for saving the image.

Returns:

void

Save an image into a particular file format with default parameters for saving.

save

voidsave(Stringimagefilename, ImageTypeimageType, ImageSaveParamssaveparams)

Parameters

imagefilename: String

The physical image file which will be created.

imageType: ImageType

The ImageType used for saving the image.

saveparams: ImageSaveParams

The ImageSaveParams for saving the image.

Returns:

void

Save an image into a particular file format with the given parameters for saving.

scale

voidscale(doublesx, doublesy)

Parameters

sx: double

The horizontal scale factor.

sy: double

The vertical scale factor.

Returns:

void

Scale an element by (sx,sy) units using the matrix [ sx 0 0 sy 0 0 ].

setClip

voidsetClip(Clipclip)

Parameters

clip: Clip

The clip to set as the current clip for this element, or NULL to remove clipping.

Returns:

void

Sets the current Clip for an Element.

setCompression

voidsetCompression(CompressionCodecode)

Parameters

code: CompressionCode

The new new compression scheme to be applied.

Returns:

void

Set a Compression scheme for the image data.

setGraphicState

voidsetGraphicState(GraphicStategstate)

Parameters

gstate: GraphicState

the new/updated Graphic State for the element.

Returns:

void

Set the Graphic State of the current element.

setIntent

voidsetIntent(Stringintent)

Parameters

intent: String

the intent name

Returns:

void

SetIntent allows to set color rendering intent for the image.

setMatrix

voidsetMatrix(Matrixmatrix)

Parameters

matrix: Matrix

The transformation matrix for the element.

Returns:

void

Set the transformation matrix for the element.

setSoftMask

voidsetSoftMask(ImagesoftMask)

Parameters

softMask: Image

an image, the soft mask. If set to NULL, the soft mask is removed.

Returns:

void

Sets, for this image, the soft mask (also an image).

translate

voidtranslate(doubletx, doublety)

Parameters

tx: double

The horizontal translation distance in user space units.

ty: double

The vertical translation distance in user space units.

Returns:

void

Translate an image by (tx,ty) units using the matrix [ 1 0 0 1 tx ty ]. For images, this translation is done without regard to the scaling and rotation of the original image.

To ensure that this translation can be done, do the translation before any further rotation or scaling.