com.groupdocs.signature.options.textsignature

Class ImagesSignTextOptions

java.lang.Object

com.groupdocs.signature.options.SignOptions

com.groupdocs.signature.options.textsignature.SignTextOptions

com.groupdocs.signature.options.textsignature.ImagesSignTextOptions

All Implemented Interfaces:

IAlignment, IOpacity, IRectangle, IRotation

public class ImagesSignTextOptions
extends SignTextOptions
implements IOpacity

Represents the Text Signature Options for Images Documents.

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
Brush	getBackgroundBrushStyle() Gets or sets the signature background brush.
double	getBackgroundTransparency() Gets or sets the signature background transparency (value from 0.0 (opaque) through 1.0 (clear)).
int	getBorderDashStyle() Gets or sets the signature border style.
double	getBorderTransparency() Gets or sets the signature border transparency (value from 0.0 (opaque) through 1.0 (clear)).
double	getBorderWeight() Gets or sets the weight of the signature border.
int	getDocumentPageNumber() Gets or sets document page number for signing.
double	getOpacity() Get or set Signature Opacity.
PagesSetup	getPagesSetup() Options to specify pages to be signed.
boolean	getSignAllPages() Put signature on all document pages.
int	getSignatureImplementation() Gets or sets the type of text signature implementation.
void	setBackgroundBrushStyle(Brush value) Gets or sets the signature background brush.
void	setBackgroundTransparency(double value) Gets or sets the signature background transparency (value from 0.0 (opaque) through 1.0 (clear)).
void	setBorderDashStyle(int value) Gets or sets the signature border style.
void	setBorderTransparency(double value) Gets or sets the signature border transparency (value from 0.0 (opaque) through 1.0 (clear)).
void	setBorderWeight(double value) Gets or sets the weight of the signature border.
void	setDocumentPageNumber(int value) Gets or sets document page number for signing.
void	setOpacity(double value) Get or set Signature Opacity.
void	setPagesSetup(PagesSetup value) Options to specify pages to be signed.
void	setSignAllPages(boolean value) Put signature on all document pages.
void	setSignatureImplementation(int value) Gets or sets the type of text signature implementation.

Methods inherited from class com.groupdocs.signature.options.textsignature.SignTextOptions

getBackgroundColor, getBorderColor, getFont, getForeColor, getHeight, getHorizontalAlignment, getImageHelper, getLeft, getLocationMeasureType, getMargin, getMarginMeasureType, getRotationAngle, getSizeMeasureType, getStretch, getText, getTop, getVerticalAlignment, getWidth, setBackgroundColor, setBorderColor, setFont, setForeColor, setHeight, setHorizontalAlignment, setLeft, setLocationMeasureType, setMargin, setMarginMeasureType, setRotationAngle, setSizeMeasureType, setStretch, setText, setTop, setVerticalAlignment, setWidth, toString

Methods inherited from class com.groupdocs.signature.options.SignOptions

getAppearance, getExtensions, release, setAppearance, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

ImagesSignTextOptions

public ImagesSignTextOptions()

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

ImagesSignTextOptions

public ImagesSignTextOptions(String text)

Initializes a new instance of the ImagesSignTextOptions class with text.

Parameters:

text - Signature text

Method Detail

getBackgroundBrushStyle

public Brush getBackgroundBrushStyle()

Gets or sets the signature background brush. Value by default is null. When property has a value it is used instead BackgroundBrush property. It is not used for Watermark implementation.

Overrides:

getBackgroundBrushStyle in class SignTextOptions

getBackgroundTransparency

public double getBackgroundTransparency()

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

getBorderDashStyle

public int getBorderDashStyle()

Gets or sets the signature border style.

getBorderTransparency

public double getBorderTransparency()

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

getBorderWeight

public double getBorderWeight()

Gets or sets the weight of the signature border.

getDocumentPageNumber

public int getDocumentPageNumber()

Gets or sets document page number for signing. This property can only be used for multi-frames image formats (Tiff). Minimal value is 1.

Overrides:

getDocumentPageNumber in class SignOptions

getOpacity

public double getOpacity()

Get or set Signature Opacity. This value should be in range 0 - 1 and it inverts BackgroundTransparency. Opacity = 1 - BackgroundTransparency.

Specified by:

getOpacity in interface IOpacity

getPagesSetup

public PagesSetup getPagesSetup()

Options to specify pages to be signed. This property can only be used for multi-frames image formats (Tiff).

Overrides:

getPagesSetup in class SignOptions

getSignAllPages

public boolean getSignAllPages()

Put signature on all document pages. This property can only be used for multi-frames image formats (Tiff).

Overrides:

getSignAllPages in class SignTextOptions

getSignatureImplementation

public int getSignatureImplementation()

Gets or sets the type of text signature implementation.

setBackgroundBrushStyle

public void setBackgroundBrushStyle(Brush value)

Gets or sets the signature background brush. Value by default is null. When property has a value it is used instead BackgroundBrush property. It is not used for Watermark implementation.

Overrides:

setBackgroundBrushStyle in class SignTextOptions

setBackgroundTransparency

public void setBackgroundTransparency(double value)

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

setBorderDashStyle

public void setBorderDashStyle(int value)

Gets or sets the signature border style.

setBorderTransparency

public void setBorderTransparency(double value)

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

setBorderWeight

public void setBorderWeight(double value)

Gets or sets the weight of the signature border.

setDocumentPageNumber

public void setDocumentPageNumber(int value)

Gets or sets document page number for signing. This property can only be used for multi-frames image formats (Tiff). Minimal value is 1.

Overrides:

setDocumentPageNumber in class SignOptions

setOpacity

public void setOpacity(double value)

Get or set Signature Opacity. This value should be in range 0 - 1 and it inverts BackgroundTransparency. Opacity = 1 - BackgroundTransparency.

Specified by:

setOpacity in interface IOpacity

setPagesSetup

public void setPagesSetup(PagesSetup value)

Options to specify pages to be signed. This property can only be used for multi-frames image formats (Tiff).

Overrides:

setPagesSetup in class SignOptions

setSignAllPages

public void setSignAllPages(boolean value)

Put signature on all document pages. This property can only be used for multi-frames image formats (Tiff).

Overrides:

setSignAllPages in class SignTextOptions

setSignatureImplementation

public void setSignatureImplementation(int value)

Gets or sets the type of text signature implementation.