org.jodconverter.local.filter.text

Class GraphicInserterFilter

java.lang.Object

org.jodconverter.local.filter.text.AbstractTextContentInserterFilter

org.jodconverter.local.filter.text.GraphicInserterFilter

All Implemented Interfaces:

Filter

public class GraphicInserterFilter
extends AbstractTextContentInserterFilter

This filter is used to insert a graphics into a document.

Constructor Summary

Constructors

Constructor and Description
GraphicInserterFilter(@NonNull String imagePath, int horizontalPosition, int verticalPosition) Creates a new filter that will insert the specified image at the specified location while converting a document.
GraphicInserterFilter(@NonNull String imagePath, int width, int height, int horizontalPosition, int verticalPosition) Creates a new filter that will insert the specified image at the specified location while converting a document.
GraphicInserterFilter(@NonNull String imagePath, int width, int height, @NonNull Map<String,Object> shapeProperties) Creates a new filter that will insert the specified image using the specified properties while converting a document.
GraphicInserterFilter(@NonNull String imagePath, @NonNull Map<String,Object> shapeProperties) Creates a new filter that will insert the specified image using the specified properties while converting a document.

Method Summary

Modifier and Type	Method and Description
void	doFilter(@NonNull org.jodconverter.core.office.OfficeContext context, @NonNull com.sun.star.lang.XComponent document, @NonNull FilterChain chain) The doFilter method of the Filter is called each time a document is passed through the chain due to a conversion request.

Methods inherited from class org.jodconverter.local.filter.text.AbstractTextContentInserterFilter

applyAnchorPageNoFix, createDefaultShapeProperties, getRectSize, getShapeProperties, setRectSize, toOfficeSize

Methods inherited from class java.lang.Object

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

Constructor Detail

GraphicInserterFilter

public GraphicInserterFilter(@NonNull String imagePath,
                             int horizontalPosition,
                             int verticalPosition)
                      throws org.jodconverter.core.office.OfficeException

Creates a new filter that will insert the specified image at the specified location while converting a document.

Parameters:

imagePath - The path to the image (file) on disk.

horizontalPosition - The horizontal position where to insert the image on the document (millimeters).

verticalPosition - The vertical position where to insert the image on the document (millimeters).

Throws:

org.jodconverter.core.office.OfficeException - If the size of the image cannot be detected.

GraphicInserterFilter

public GraphicInserterFilter(@NonNull String imagePath,
                             int width,
                             int height,
                             int horizontalPosition,
                             int verticalPosition)

Creates a new filter that will insert the specified image at the specified location while converting a document.

Parameters:

imagePath - The path to the image (file) on disk.

width - the width of the image to insert. The original image will be resize if required (millimeters).

height - The height of the image to insert. The original image will be resize if required (millimeters).

horizontalPosition - The horizontal position where to insert the image on the document (millimeters).

verticalPosition - The vertical position where to insert the image on the document (millimeters).

GraphicInserterFilter

public GraphicInserterFilter(@NonNull String imagePath,
                             @NonNull Map<String,Object> shapeProperties)
                      throws org.jodconverter.core.office.OfficeException

Creates a new filter that will insert the specified image using the specified properties while converting a document.

Parameters:

imagePath - The path to the image (file) on disk.

shapeProperties - The properties to apply to the created graphic shape.

Throws:

org.jodconverter.core.office.OfficeException - If the size of the image cannot be detected.

See Also:

Drawing Shapes

GraphicInserterFilter

public GraphicInserterFilter(@NonNull String imagePath,
                             int width,
                             int height,
                             @NonNull Map<String,Object> shapeProperties)

Creates a new filter that will insert the specified image using the specified properties while converting a document.

Parameters:

imagePath - The path to the image (file) on disk.

width - the width of the image to insert. The original image will be resize if required (millimeters).

height - The height of the image to insert. The original image will be resize if required (millimeters).

shapeProperties - The properties to apply to the created graphic shape.

See Also:

Drawing Shapes

Method Detail

doFilter

public void doFilter(@NonNull org.jodconverter.core.office.OfficeContext context,
                     @NonNull com.sun.star.lang.XComponent document,
                     @NonNull FilterChain chain)
              throws Exception

Description copied from interface: Filter

The doFilter method of the Filter is called each time a document is passed through the chain due to a conversion request. The FilterChain passed in to this method allows the Filter to pass on the document to the next entity in the chain.

A typical implementation of this method would either invoke the next filter in the chain using the FilterChain object (chain.doFilter()), or not pass on the document to the next filter in the filter chain to block the conversion processing.

Parameters:

context - The OfficeContext in use to pass along the chain.

document - The XComponent being converted to pass along the chain.

chain - The chain.

Throws:

Exception - If an error occurs processing the filter.