TextSignOptions

Inheritance: java.lang.Object, com.groupdocs.signature.options.sign.SignOptions

All Implemented Interfaces: com.groupdocs.signature.domain.interfaces.IRectangle, com.groupdocs.signature.domain.interfaces.IAlignment, com.groupdocs.signature.domain.interfaces.IRotation, com.groupdocs.signature.domain.interfaces.ITransparency

public class TextSignOptions extends SignOptions implements IRectangle, IAlignment, IRotation, ITransparency

Represents the Text signature options.

Constructors

Constructor Description
TextSignOptions() Initializes a new instance of the SignTextOptions class with default values.
TextSignOptions(String text) Initializes a new instance of the SignTextOptions class with text.

Fields

Field Description
DEFAULT_TRANSPARENCY

Methods

Method Description
getLeft() Left X position of Signature on Document Page in Measure values (pixels, percents or millimeters see MeasureType LocationMeasureType property).
setLeft(int value) Left X position of Signature on Document Page in Measure values (pixels, percents or millimeters see MeasureType LocationMeasureType property).
getTop() Top Y Position of Signature on Document Page in Measure values (pixels, percents or millimeters see MeasureType LocationMeasureType property).
setTop(int value) Top Y Position of Signature on Document Page in Measure values (pixels, percents or millimeters see MeasureType LocationMeasureType property).
getWidth() Width of Signature on Document Page in Measure values (pixels, percents or millimeters see MeasureType SizeMeasureType property).
setWidth(int value) Width of Signature on Document Page in Measure values (pixels, percents or millimeters see MeasureType SizeMeasureType property).
getHeight() Height of Signature on Document Page in Measure values (pixels, percents or millimeters see MeasureType SizeMeasureType property).
setHeight(int value) Height of Signature on Document Page in Measure values (pixels, percents or millimeters see MeasureType SizeMeasureType property).
getLocationMeasureType() Measure type (pixels, percents or millimeters) for Left and Top properties.
setLocationMeasureType(int value) Measure type (pixels, percents or millimeters) for Left and Top properties.
getSizeMeasureType() Measure type (pixels, percents or millimeters) for Width and Height properties.
setSizeMeasureType(int value) Measure type (pixels, percents or millimeters) for Width and Height properties.
getStretch() Stretch mode on Document Page.
setStretch(int value) Stretch mode on Document Page.
getRotationAngle() Rotation angle of signature on document page (clockwise).
setRotationAngle(int value) Rotation angle of signature on document page (clockwise).
getHorizontalAlignment() Horizontal alignment of signature on document page.
setHorizontalAlignment(int value) Horizontal alignment of signature on document page.
getVerticalAlignment() Vertical alignment of signature on document page.
setVerticalAlignment(int value) Vertical alignment of signature on document page.
getMargin() Gets or sets the space between Sign and Document edges.
setMargin(Padding value) Gets or sets the space between Sign and Document edges.
getMarginMeasureType() Gets or sets the measure type (pixels, percents or millimeters) for Margin.
setMarginMeasureType(int value) Gets or sets the measure type (pixels, percents or millimeters) for Margin.
getTransparency() Gets or sets the signature transparency (value from 0.0 (opaque) through 1.0 (clear)).
setTransparency(double value) Gets or sets the signature transparency (value from 0.0 (opaque) through 1.0 (clear)).
getText() Gets or sets the text of signature.
setText(String value) Gets or sets the text of signature.
getFont() Gets or sets the font of signature.
setFont(SignatureFont value) Gets or sets the font of signature.
getForeColor() Gets or sets the fore color of signature.
setForeColor(Color value) Gets or sets the fore color of signature.
getSignatureImplementation() Gets or sets the type of text signature implementation.
setSignatureImplementation(int value) Gets or sets the type of text signature implementation.
getTextHorizontalAlignment() Horizontal alignment of text inside a signature.
setTextHorizontalAlignment(int value) Horizontal alignment of text inside a signature.
getTextVerticalAlignment() Vertical alignment of text inside a signature.
setTextVerticalAlignment(int value) Vertical alignment of text inside a signature.
getFormTextFieldTitle() Gets or sets the title of text form field to put text signature into it.
setFormTextFieldTitle(String value) Gets or sets the title of text form field to put text signature into it.
getFormTextFieldType() Gets or sets the type of form field to put text signature into it.
setFormTextFieldType(int value) Gets or sets the type of form field to put text signature into it.
getShapeType() Gets or sets the type of shape to put text.
setShapeType(int value) Gets or sets the type of shape to put text.
getSignatureID() Gets or sets the unique ID of signature.
setSignatureID(int value) Gets or sets the unique ID of signature.
getBorder() Specify border settings
setBorder(Border value) Specify border settings
getBackground() Gets or sets the signature background settings.
setBackground(Background value) Gets or sets the signature background settings.
getNative() Gets or sets the native attribute.
setNative(boolean value) Gets or sets the native attribute.
getShapePosition() Defines where shape should be presented in the document layout
setShapePosition(int value) Defines where shape should be presented in the document layout
validate() Internal method to validate the options parameters.
toString() Override string conversion.

TextSignOptions()

public TextSignOptions()

Initializes a new instance of the SignTextOptions class with default values.

TextSignOptions(String text)

public TextSignOptions(String text)

Initializes a new instance of the SignTextOptions class with text.

Parameters:

Parameter Type Description
text java.lang.String Signature text.

DEFAULT_TRANSPARENCY

public static final double DEFAULT_TRANSPARENCY

getLeft()

public final int getLeft()

Left X position of Signature on Document Page in Measure values (pixels, percents or millimeters see MeasureType LocationMeasureType property). (works if horizontal alignment is not specified).

Returns: int

setLeft(int value)

public final void setLeft(int value)

Left X position of Signature on Document Page in Measure values (pixels, percents or millimeters see MeasureType LocationMeasureType property). (works if horizontal alignment is not specified).

Parameters:

Parameter Type Description
value int

getTop()

public final int getTop()

Top Y Position of Signature on Document Page in Measure values (pixels, percents or millimeters see MeasureType LocationMeasureType property). (works if vertical alignment is not specified).

Returns: int

setTop(int value)

public final void setTop(int value)

Top Y Position of Signature on Document Page in Measure values (pixels, percents or millimeters see MeasureType LocationMeasureType property). (works if vertical alignment is not specified).

Parameters:

Parameter Type Description
value int

getWidth()

public final int getWidth()

Width of Signature on Document Page in Measure values (pixels, percents or millimeters see MeasureType SizeMeasureType property).

Returns: int

setWidth(int value)

public final void setWidth(int value)

Width of Signature on Document Page in Measure values (pixels, percents or millimeters see MeasureType SizeMeasureType property).

Parameters:

Parameter Type Description
value int

getHeight()

public final int getHeight()

Height of Signature on Document Page in Measure values (pixels, percents or millimeters see MeasureType SizeMeasureType property).

Returns: int

setHeight(int value)

public final void setHeight(int value)

Height of Signature on Document Page in Measure values (pixels, percents or millimeters see MeasureType SizeMeasureType property).

Parameters:

Parameter Type Description
value int

getLocationMeasureType()

public int getLocationMeasureType()

Measure type (pixels, percents or millimeters) for Left and Top properties.

Returns: int

setLocationMeasureType(int value)

public void setLocationMeasureType(int value)

Measure type (pixels, percents or millimeters) for Left and Top properties.

Parameters:

Parameter Type Description
value int

getSizeMeasureType()

public int getSizeMeasureType()

Measure type (pixels, percents or millimeters) for Width and Height properties.

Returns: int

setSizeMeasureType(int value)

public void setSizeMeasureType(int value)

Measure type (pixels, percents or millimeters) for Width and Height properties.

Parameters:

Parameter Type Description
value int

getStretch()

public final int getStretch()

Stretch mode on Document Page.

Returns: int

setStretch(int value)

public final void setStretch(int value)

Stretch mode on Document Page.

Parameters:

Parameter Type Description
value int

getRotationAngle()

public final int getRotationAngle()

Rotation angle of signature on document page (clockwise).

Returns: int

setRotationAngle(int value)

public final void setRotationAngle(int value)

Rotation angle of signature on document page (clockwise).

Parameters:

Parameter Type Description
value int

getHorizontalAlignment()

public final int getHorizontalAlignment()

Horizontal alignment of signature on document page.

Returns: int

setHorizontalAlignment(int value)

public final void setHorizontalAlignment(int value)

Horizontal alignment of signature on document page.

Parameters:

Parameter Type Description
value int

getVerticalAlignment()

public final int getVerticalAlignment()

Vertical alignment of signature on document page.

Returns: int

setVerticalAlignment(int value)

public final void setVerticalAlignment(int value)

Vertical alignment of signature on document page.

Parameters:

Parameter Type Description
value int

getMargin()

public Padding getMargin()

Gets or sets the space between Sign and Document edges. (works ONLY if horizontal or vertical alignment are specified).

Returns: Padding

setMargin(Padding value)

public void setMargin(Padding value)

Gets or sets the space between Sign and Document edges. (works ONLY if horizontal or vertical alignment are specified).

Parameters:

Parameter Type Description
value Padding

getMarginMeasureType()

public int getMarginMeasureType()

Gets or sets the measure type (pixels, percents or millimeters) for Margin.

Returns: int

setMarginMeasureType(int value)

public void setMarginMeasureType(int value)

Gets or sets the measure type (pixels, percents or millimeters) for Margin.

Parameters:

Parameter Type Description
value int

getTransparency()

public final double getTransparency()

Gets or sets the signature transparency (value from 0.0 (opaque) through 1.0 (clear)). Default value is 0 (opaque).

Returns: double

setTransparency(double value)

public final void setTransparency(double value)

Gets or sets the signature transparency (value from 0.0 (opaque) through 1.0 (clear)). Default value is 0 (opaque).

Parameters:

Parameter Type Description
value double

getText()

public final String getText()

Gets or sets the text of signature.

Returns: java.lang.String

setText(String value)

public final void setText(String value)

Gets or sets the text of signature.

Parameters:

Parameter Type Description
value java.lang.String

getFont()

public final SignatureFont getFont()

Gets or sets the font of signature.

Returns: SignatureFont

setFont(SignatureFont value)

public final void setFont(SignatureFont value)

Gets or sets the font of signature.

Parameters:

Parameter Type Description
value SignatureFont

getForeColor()

public Color getForeColor()

Gets or sets the fore color of signature.

Returns: java.awt.Color

setForeColor(Color value)

public void setForeColor(Color value)

Gets or sets the fore color of signature.

Parameters:

Parameter Type Description
value java.awt.Color

getSignatureImplementation()

public final int getSignatureImplementation()

Gets or sets the type of text signature implementation.

Returns: int

setSignatureImplementation(int value)

public final void setSignatureImplementation(int value)

Gets or sets the type of text signature implementation.

Parameters:

Parameter Type Description
value int

getTextHorizontalAlignment()

public final int getTextHorizontalAlignment()

Horizontal alignment of text inside a signature. This feature is supported only for Image and Annotation signature implementations (see TextSignatureImplementation SignatureImplementation property).

Returns: int

setTextHorizontalAlignment(int value)

public final void setTextHorizontalAlignment(int value)

Horizontal alignment of text inside a signature. This feature is supported only for Image and Annotation signature implementations (see TextSignatureImplementation SignatureImplementation property).

Parameters:

Parameter Type Description
value int

getTextVerticalAlignment()

public final int getTextVerticalAlignment()

Vertical alignment of text inside a signature. This feature is supported only for Image signature implementation (see TextSignatureImplementation SignatureImplementation property).

Returns: int

setTextVerticalAlignment(int value)

public final void setTextVerticalAlignment(int value)

Vertical alignment of text inside a signature. This feature is supported only for Image signature implementation (see TextSignatureImplementation SignatureImplementation property).

Parameters:

Parameter Type Description
value int

getFormTextFieldTitle()

public final String getFormTextFieldTitle()

Gets or sets the title of text form field to put text signature into it. This property could be used only with SignatureImplementation = TextToFormField.

Returns: java.lang.String

setFormTextFieldTitle(String value)

public final void setFormTextFieldTitle(String value)

Gets or sets the title of text form field to put text signature into it. This property could be used only with SignatureImplementation = TextToFormField.

Parameters:

Parameter Type Description
value java.lang.String

getFormTextFieldType()

public final int getFormTextFieldType()

Gets or sets the type of form field to put text signature into it. This property could be used only with SignatureImplementation = TextToFormField. Value by default is AllTextTypes.

Returns: int

setFormTextFieldType(int value)

public final void setFormTextFieldType(int value)

Gets or sets the type of form field to put text signature into it. This property could be used only with SignatureImplementation = TextToFormField. Value by default is AllTextTypes.

Parameters:

Parameter Type Description
value int

getShapeType()

public final int getShapeType()

Gets or sets the type of shape to put text. This property could be used only with SignatureImplementation = TextStamp. Value by default is Rectangle.

Returns: int

setShapeType(int value)

public final void setShapeType(int value)

Gets or sets the type of shape to put text. This property could be used only with SignatureImplementation = TextStamp. Value by default is Rectangle.

Parameters:

Parameter Type Description
value int

getSignatureID()

public final int getSignatureID()

Gets or sets the unique ID of signature. It can be used in signature verification options. Property is supported for Pdf documents only

Returns: int

setSignatureID(int value)

public final void setSignatureID(int value)

Gets or sets the unique ID of signature. It can be used in signature verification options. Property is supported for Pdf documents only

Parameters:

Parameter Type Description
value int

getBorder()

public final Border getBorder()

Specify border settings

Returns: Border

setBorder(Border value)

public final void setBorder(Border value)

Specify border settings

Parameters:

Parameter Type Description
value Border

getBackground()

public final Background getBackground()

Gets or sets the signature background settings.

Returns: Background

setBackground(Background value)

public final void setBackground(Background value)

Gets or sets the signature background settings.

Parameters:

Parameter Type Description
value Background

getNative()

public final boolean getNative()

Gets or sets the native attribute. If it is set document specific signatures could be used. Native text watermark for WordProcessing documents is different than regular, for example.

Returns: boolean

setNative(boolean value)

public final void setNative(boolean value)

Gets or sets the native attribute. If it is set document specific signatures could be used. Native text watermark for WordProcessing documents is different than regular, for example.

Parameters:

Parameter Type Description
value boolean

getShapePosition()

public final int getShapePosition()

Defines where shape should be presented in the document layout

Returns: int

setShapePosition(int value)

public final void setShapePosition(int value)

Defines where shape should be presented in the document layout

Parameters:

Parameter Type Description
value int

validate()

public void validate()

Internal method to validate the options parameters.

toString()

public String toString()

Override string conversion.

Returns: java.lang.String -