org.jodconverter.local.filter.text

Class TextInserterFilter

java.lang.Object

org.jodconverter.local.filter.text.AbstractTextContentInserterFilter

org.jodconverter.local.filter.text.TextInserterFilter

All Implemented Interfaces:

Filter

public class TextInserterFilter
extends AbstractTextContentInserterFilter

This filter is used to insert text into a document.

Constructor Summary

Constructors

Constructor and Description
TextInserterFilter(@NonNull java.lang.String text, int width, int height, int horizontalPosition, int verticalPosition) Creates a new filter that will insert the specified text at the specified location while converting a document.
TextInserterFilter(@NonNull java.lang.String text, int width, int height, @NonNull java.util.Map<java.lang.String,java.lang.Object> shapeProperties) Creates a new filter that will insert the specified text at the specified location 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

TextInserterFilter

public TextInserterFilter(@NonNull java.lang.String text,
                          int width,
                          int height,
                          int horizontalPosition,
                          int verticalPosition)

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

Parameters:

text - The text to insert.

width - The width of the rectangle to insert (millimeters).

height - The height of the rectangle to insert (millimeters).

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

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

TextInserterFilter

public TextInserterFilter(@NonNull java.lang.String text,
                          int width,
                          int height,
                          @NonNull java.util.Map<java.lang.String,java.lang.Object> shapeProperties)

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

Parameters:

text - The text to insert.

width - The width of the rectangle to insert (millimeters).

height - The height of the rectangle to insert (millimeters).

shapeProperties - The properties to apply to the created rectangle 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 java.lang.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:

java.lang.Exception - If an error occurs processing the filter.