ImagePlacement

Inheritance: java.lang.Object

public final class ImagePlacement

Represents characteristics of an image placed to Pdf document page.

The example demonstrates how to find images on the first PDF document page and get images as bitmaps with visible dimensions.


 // Open document
 Document doc = new Document("D:\\Tests\\input.pdf");
 // Create ImagePlacementAbsorber object to perform image placement search
 ImagePlacementAbsorber abs = new ImagePlacementAbsorber();
 // Accept the absorber for first page
 doc.getPages().get_Item(1).accept(abs);
 // Retrieve images with visible dimensions
 for (ImagePlacement imagePlacement : ```
(Iterable)
```abs.getImagePlacements())
 {
     BufferedImage scaledImage;
     ByteArrayOutputStream imageStream = new ByteArrayOutputStream())

         // Retrieve image from resources
         imagePlacement.getImage().save(imageStream, ImageFormatInternal.Png);
         BufferedImage resourceImage = (BufferedImage) ImageIO.read(imageStream);
         // Create new bitmap with actual dimensions
         scaledImage = new BufferedImage(resourceImage, (int)imagePlacement.getRectangle().getWidth(), (int)imagePlacement.getRectangle().getHeight());

 }

When an image is placed to a page it may have dimensions other than physical dimensions defined in Resources . The object ImagePlacement is intended to provide such information like dimensions, resolution and so on.

Methods

Method	Description
getMatrix()	Current transformation matrix for this image.
getRectangle()	Gets rectangle of the Image.
getOperator()	Operator used for displaying the image.
hide()	Delete image from the page.
getRotation()	Gets rotation angle of the Image.
getResolution()	Gets resolution of the Image.
getImage()	Gets related XImage resource object.
getPage()	Gets the page containing the image.
getCompositingParameters()	Gets compositing parameters of graphics state active for the image placed to the page.
replace(InputStream image)	Replace image in collection with another image.
save(OutputStream outputStream)	Saves image with corresponding transformations: scaling, rotation and resolution.
save(OutputStream outputStream, ImageType format)	Saves image with corresponding transformations: scaling, rotation and resolution.

getMatrix()

public Matrix getMatrix()

Current transformation matrix for this image.

Returns: Matrix - Matrix object

getRectangle()

public Rectangle getRectangle()

Gets rectangle of the Image.

Returns: Rectangle - Rectangle object

getOperator()

public final Operator getOperator()

Operator used for displaying the image.

Returns: Operator - Operator instance

hide()

public final void hide()

Delete image from the page.

getRotation()

public float getRotation()

Gets rotation angle of the Image.

Returns: float - int value

getResolution()

public Resolution getResolution()

Gets resolution of the Image.

Returns: Resolution - Resolution object

getImage()

public XImage getImage()

Gets related XImage resource object.

Returns: XImage - XImage object

getPage()

public Page getPage()

Gets the page containing the image.

Returns: Page - Page object

getCompositingParameters()

public CompositingParameters getCompositingParameters()

Gets compositing parameters of graphics state active for the image placed to the page.

Returns: CompositingParameters - CompositingParameters object

replace(InputStream image)

public void replace(InputStream image)

Replace image in collection with another image.

Parameters:

Parameter	Type	Description
image	java.io.InputStream	Stream containing image data.

save(OutputStream outputStream)

public void save(OutputStream outputStream)

Saves image with corresponding transformations: scaling, rotation and resolution.

Parameters:

Parameter	Type	Description
outputStream	java.io.OutputStream	Stream where image will be saved

save(OutputStream outputStream, ImageType format)

public void save(OutputStream outputStream, ImageType format)

Saves image with corresponding transformations: scaling, rotation and resolution.

Parameters:

Parameter	Type	Description
outputStream	java.io.OutputStream	Stream where image will be saved
format	ImageType	Format which will be used for image enconding. ImageFormat

ImageFormat ImagePlacementAbsorber