org.jodconverter.local.filter.text

Class AbstractTextContentInserterFilter

java.lang.Object

org.jodconverter.local.filter.text.AbstractTextContentInserterFilter

All Implemented Interfaces:

Filter

Direct Known Subclasses:

GraphicInserterFilter, TextInserterFilter

public abstract class AbstractTextContentInserterFilter
extends Object
implements Filter

Base class for all filter used to insert a TextContent into a document.

Constructor Summary

Constructors

Constructor and Description
AbstractTextContentInserterFilter(@NonNull Dimension size, int horizontalPosition, int verticalPosition) Creates a new filter that will insert a text content (shape) of the specified size at the specified location while converting a document.
AbstractTextContentInserterFilter(@NonNull Dimension size, @NonNull Map<String,Object> shapeProperties) Creates a new filter that will insert a text content (shape) of the specified size using the specified shape properties while converting a document.
AbstractTextContentInserterFilter(int horizontalPosition, int verticalPosition) Creates a new filter that will insert a text content (shape) at the specified location while converting a document.
AbstractTextContentInserterFilter(@NonNull Map<String,Object> shapeProperties) Creates a new filter that will insert a text content (shape) using the specified shape properties while converting a document.

Method Summary

Modifier and Type	Method and Description
protected void	applyAnchorPageNoFix(@NonNull com.sun.star.text.XTextDocument docText, @NonNull com.sun.star.text.XTextCursor textCursor) Jumps to the page specified by the "AnchorPageNo" if present in the shape properties if this filter.
static @NonNull Map<String,Object>	createDefaultShapeProperties(int horizontalPosition, int verticalPosition) Creates the default shape properties that would insert text content at the specified position on the first page of a document.
@NonNull Dimension	getRectSize() Gets the rectangle's size of the shape that will be inserted.
@NonNull Map<String,Object>	getShapeProperties() Gets the shape's properties to apply when inserting the shape to the document.
protected void	setRectSize(@NonNull Dimension size) Sets the rectangle's size of the shape that will be inserted.
static com.sun.star.awt.Size	toOfficeSize(@NonNull Dimension size) Converts the specified size where units are millimeters to an office size where unit are 1/100 millimeters.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jodconverter.local.filter.Filter

doFilter

Constructor Detail

AbstractTextContentInserterFilter

public AbstractTextContentInserterFilter(int horizontalPosition,
                                         int verticalPosition)

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

Parameters:

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

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

AbstractTextContentInserterFilter

public AbstractTextContentInserterFilter(@NonNull Map<String,Object> shapeProperties)

Creates a new filter that will insert a text content (shape) using the specified shape properties while converting a document.

Parameters:

shapeProperties - The properties to apply to the created shape.

See Also:

Drawing Shapes

AbstractTextContentInserterFilter

public AbstractTextContentInserterFilter(@NonNull Dimension size,
                                         int horizontalPosition,
                                         int verticalPosition)

Creates a new filter that will insert a text content (shape) of the specified size at the specified location while converting a document.

Parameters:

size - The dimension of the shape that will be inserted (millimeters).

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

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

AbstractTextContentInserterFilter

public AbstractTextContentInserterFilter(@NonNull Dimension size,
                                         @NonNull Map<String,Object> shapeProperties)

Creates a new filter that will insert a text content (shape) of the specified size using the specified shape properties while converting a document.

Parameters:

size - The dimension of the shape that will be inserted (millimeters).

shapeProperties - The properties to apply to the created shape.

See Also:

Drawing Shapes

Method Detail

createDefaultShapeProperties

public static @NonNull Map<String,Object> createDefaultShapeProperties(int horizontalPosition,
                                                                       int verticalPosition)

Creates the default shape properties that would insert text content at the specified position on the first page of a document.

Parameters:

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

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

Returns:

A map containing The default shape properties.

toOfficeSize

public static com.sun.star.awt.Size toOfficeSize(@NonNull Dimension size)

Converts the specified size where units are millimeters to an office size where unit are 1/100 millimeters.

Parameters:

size - The size to convert, in millimeters.

Returns:

The converted size instance, in 1/100 millimeters.

applyAnchorPageNoFix

protected void applyAnchorPageNoFix(@NonNull com.sun.star.text.XTextDocument docText,
                                    @NonNull com.sun.star.text.XTextCursor textCursor)

Jumps to the page specified by the "AnchorPageNo" if present in the shape properties if this filter. This seems to be required for some output format.

Parameters:

docText - The text interface for the document.

textCursor - The text cursor of the document.

getRectSize

public @NonNull Dimension getRectSize()

Gets the rectangle's size of the shape that will be inserted.

Returns:

A Rectangle that represents the size of the shape. Units are millimeters.

setRectSize

protected void setRectSize(@NonNull Dimension size)

Sets the rectangle's size of the shape that will be inserted.

Parameters:

size - A Rectangle that represents the size of the shape. Units are millimeters.

getShapeProperties

public @NonNull Map<String,Object> getShapeProperties()

Gets the shape's properties to apply when inserting the shape to the document.

Returns:

A map that contains the properties.