com.silanis.esl.sdk.builder

Class TextAnchorBuilder

java.lang.Object

com.silanis.esl.sdk.builder.TextAnchorBuilder

public class TextAnchorBuilder
extends Object

The TextAnchorBuilder is a convenient class to define the position of signatures or fields relative to a text string present in the original document.

Method Summary

Modifier and Type	Method and Description
TextAnchorBuilder	atPosition(TextAnchorPosition position) Set the position relative to the bounding box of the searched string the position offset is calculated from.
TextAnchor	build() Builds the text anchor.
static TextAnchorBuilder	newTextAnchor(String anchorText) Creates a new textanchor for a given text string
TextAnchorBuilder	withCharacter(int character) Set character index of the anchor text for which to position the signature relative to.
TextAnchorBuilder	withOccurence(int occurence) Set the index of the occurrence of the text string we want to use for text anchor.
TextAnchorBuilder	withOffset(int x, int y) Offset in pixel, relative to the TextAnchorPosition atPosition(TextAnchorPosition) where the signature or field will be positioned.
TextAnchorBuilder	withSize(int width, int height) Size, in pixel, of the signature of form field.

Methods inherited from class java.lang.Object

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

Method Detail

newTextAnchor

public static TextAnchorBuilder newTextAnchor(String anchorText)

Creates a new textanchor for a given text string

Parameters:

anchorText - the text string that MUST be present in the document. @size(max="255")

Returns:

This

withOccurence

public TextAnchorBuilder withOccurence(int occurence)

Set the index of the occurrence of the text string we want to use for text anchor.

E.g.: If there are multiple occurrence of the string "signature:" in a document, this allows to indicate which occurrence we are actually looking for.

Parameters:

occurence - @min="0"

Returns:

This

withCharacter

public TextAnchorBuilder withCharacter(int character)

Set character index of the anchor text for which to position the signature relative to.

Parameters:

character - the index of the anchor text character to position the signature @min="0"

Returns:

This

atPosition

public TextAnchorBuilder atPosition(TextAnchorPosition position)

Set the position relative to the bounding box of the searched string the position offset is calculated from.

E.g.: We want to position a signature relative to the TOP_LEFT corner of the string "signature:"

Parameters:

position -

Returns:

This

withOffset

public TextAnchorBuilder withOffset(int x,
                                    int y)

Offset in pixel, relative to the TextAnchorPosition atPosition(TextAnchorPosition) where the signature or field will be positioned.

Parameters:

x - pixel offset @min="0"

y - pixel offset @min="0"

Returns:

This

withSize

public TextAnchorBuilder withSize(int width,
                                  int height)

Size, in pixel, of the signature of form field.

Parameters:

width - pixel width @min="0"

height - pixel height @min="0"

Returns:

This

build

public TextAnchor build()

Builds the text anchor.

Returns:

the text anchor