Package com.groupdocs.cloud.signature.model

Class SignTextOptions

java.lang.Object

com.groupdocs.cloud.signature.model.OptionsBase

com.groupdocs.cloud.signature.model.SignOptions

com.groupdocs.cloud.signature.model.SignTextOptions

Direct Known Subclasses:

SignBarcodeOptions, SignQRCodeOptions

public class SignTextOptions
extends SignOptions

Base container class for signature options data

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SignTextOptions.HorizontalAlignmentEnum	Horizontal alignment of signature on document page
static class	SignTextOptions.LocationMeasureTypeEnum	Measure type (pixels or percent) for Left and Top properties
static class	SignTextOptions.MarginMeasureTypeEnum	Gets or sets the measure type (pixels or percent) for Margin
static class	SignTextOptions.SizeMeasureTypeEnum	Measure type (pixels or percent) for Width and Height properties
static class	SignTextOptions.StretchEnum	Stretch mode on document page
static class	SignTextOptions.TextHorizontalAlignmentEnum	Horizontal alignment of text inside a signature
static class	SignTextOptions.TextVerticalAlignmentEnum	Vertical alignment of text inside a signature
static class	SignTextOptions.VerticalAlignmentEnum	Vertical alignment of signature on document page

Nested classes/interfaces inherited from class com.groupdocs.cloud.signature.model.OptionsBase

OptionsBase.SignatureTypeEnum

Constructor Summary

Constructors

Constructor	Description
SignTextOptions()

Method Summary

Modifier and Type	Method	Description
SignTextOptions	_native(Boolean _native)
SignTextOptions	backgroundBrush(Brush backgroundBrush)
SignTextOptions	backgroundColor(Color backgroundColor)
SignTextOptions	border(BorderLine border)
boolean	equals(Object o)
SignTextOptions	font(SignatureFont font)
SignTextOptions	foreColor(Color foreColor)
Brush	getBackgroundBrush()	Gets or sets the signature background brush.
Color	getBackgroundColor()	Gets or sets the background color of signature
BorderLine	getBorder()	Gets or sets the signature border properties
SignatureFont	getFont()	Gets or sets the font of signature
Color	getForeColor()	Gets or sets the fore color of signature
Integer	getHeight()	Height of Signature are on Document Page in Measure values (pixels or percent see MeasureType SizeMeasureType property)
SignTextOptions.HorizontalAlignmentEnum	getHorizontalAlignment()	Horizontal alignment of signature on document page
Integer	getLeft()	Left X position of Signature on Document Page in Measure values (pixels or percent see MeasureType LocationMeasureType property)
SignTextOptions.LocationMeasureTypeEnum	getLocationMeasureType()	Measure type (pixels or percent) for Left and Top properties
Padding	getMargin()	Gets or sets the space between Sign and Document edges (works ONLY if horizontal or vertical alignment are specified)
SignTextOptions.MarginMeasureTypeEnum	getMarginMeasureType()	Gets or sets the measure type (pixels or percent) for Margin
Boolean	getNative()	Gets or sets the native attribute.
Integer	getRotationAngle()	Rotation angle of signature on document page (clockwise)
SignTextOptions.SizeMeasureTypeEnum	getSizeMeasureType()	Measure type (pixels or percent) for Width and Height properties
SignTextOptions.StretchEnum	getStretch()	Stretch mode on document page
String	getText()	Text of signature
SignTextOptions.TextHorizontalAlignmentEnum	getTextHorizontalAlignment()	Horizontal alignment of text inside a signature
SignTextOptions.TextVerticalAlignmentEnum	getTextVerticalAlignment()	Vertical alignment of text inside a signature
Integer	getTop()	Top Y Position of Signature on Document Page in Measure values (pixels or percent see MeasureType LocationMeasureType property)
SignTextOptions.VerticalAlignmentEnum	getVerticalAlignment()	Vertical alignment of signature on document page
Integer	getWidth()	Width of Signature area on Document Page in Measure values (pixels or percent see MeasureType SizeMeasureType property)
Integer	getZorder()	Gets or sets the Z-order position of text signature.
int	hashCode()
SignTextOptions	height(Integer height)
SignTextOptions	horizontalAlignment(SignTextOptions.HorizontalAlignmentEnum horizontalAlignment)
SignTextOptions	left(Integer left)
SignTextOptions	locationMeasureType(SignTextOptions.LocationMeasureTypeEnum locationMeasureType)
SignTextOptions	margin(Padding margin)
SignTextOptions	marginMeasureType(SignTextOptions.MarginMeasureTypeEnum marginMeasureType)
SignTextOptions	rotationAngle(Integer rotationAngle)
void	setBackgroundBrush(Brush backgroundBrush)
void	setBackgroundColor(Color backgroundColor)
void	setBorder(BorderLine border)
void	setFont(SignatureFont font)
void	setForeColor(Color foreColor)
void	setHeight(Integer height)
void	setHorizontalAlignment(SignTextOptions.HorizontalAlignmentEnum horizontalAlignment)
void	setLeft(Integer left)
void	setLocationMeasureType(SignTextOptions.LocationMeasureTypeEnum locationMeasureType)
void	setMargin(Padding margin)
void	setMarginMeasureType(SignTextOptions.MarginMeasureTypeEnum marginMeasureType)
void	setNative(Boolean _native)
void	setRotationAngle(Integer rotationAngle)
void	setSizeMeasureType(SignTextOptions.SizeMeasureTypeEnum sizeMeasureType)
void	setStretch(SignTextOptions.StretchEnum stretch)
void	setText(String text)
void	setTextHorizontalAlignment(SignTextOptions.TextHorizontalAlignmentEnum textHorizontalAlignment)
void	setTextVerticalAlignment(SignTextOptions.TextVerticalAlignmentEnum textVerticalAlignment)
void	setTop(Integer top)
void	setVerticalAlignment(SignTextOptions.VerticalAlignmentEnum verticalAlignment)
void	setWidth(Integer width)
void	setZorder(Integer zorder)
SignTextOptions	sizeMeasureType(SignTextOptions.SizeMeasureTypeEnum sizeMeasureType)
SignTextOptions	stretch(SignTextOptions.StretchEnum stretch)
SignTextOptions	text(String text)
SignTextOptions	textHorizontalAlignment(SignTextOptions.TextHorizontalAlignmentEnum textHorizontalAlignment)
SignTextOptions	textVerticalAlignment(SignTextOptions.TextVerticalAlignmentEnum textVerticalAlignment)
SignTextOptions	top(Integer top)
String	toString()
SignTextOptions	verticalAlignment(SignTextOptions.VerticalAlignmentEnum verticalAlignment)
SignTextOptions	width(Integer width)
SignTextOptions	zorder(Integer zorder)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from class com.groupdocs.cloud.signature.model.OptionsBase

allPages, getAllPages, getPage, getPagesSetup, getSignatureType, page, pagesSetup, setAllPages, setPage, setPagesSetup, setSignatureType, signatureType

Methods inherited from class com.groupdocs.cloud.signature.model.SignOptions

appearance, getAppearance, setAppearance

Constructor Detail

SignTextOptions

public SignTextOptions()

Method Detail

left

public SignTextOptions left(Integer left)

getLeft

public Integer getLeft()

Left X position of Signature on Document Page in Measure values (pixels or percent see MeasureType LocationMeasureType property)

Returns:

left

setLeft

public void setLeft(Integer left)

top

public SignTextOptions top(Integer top)

getTop

public Integer getTop()

Top Y Position of Signature on Document Page in Measure values (pixels or percent see MeasureType LocationMeasureType property)

Returns:

top

setTop

public void setTop(Integer top)

width

public SignTextOptions width(Integer width)

getWidth

public Integer getWidth()

Width of Signature area on Document Page in Measure values (pixels or percent see MeasureType SizeMeasureType property)

Returns:

width

setWidth

public void setWidth(Integer width)

height

public SignTextOptions height(Integer height)

getHeight

public Integer getHeight()

Height of Signature are on Document Page in Measure values (pixels or percent see MeasureType SizeMeasureType property)

Returns:

height

setHeight

public void setHeight(Integer height)

locationMeasureType

public SignTextOptions locationMeasureType(SignTextOptions.LocationMeasureTypeEnum locationMeasureType)

getLocationMeasureType

public SignTextOptions.LocationMeasureTypeEnum getLocationMeasureType()

Measure type (pixels or percent) for Left and Top properties

Returns:

locationMeasureType

setLocationMeasureType

public void setLocationMeasureType(SignTextOptions.LocationMeasureTypeEnum locationMeasureType)

sizeMeasureType

public SignTextOptions sizeMeasureType(SignTextOptions.SizeMeasureTypeEnum sizeMeasureType)

getSizeMeasureType

public SignTextOptions.SizeMeasureTypeEnum getSizeMeasureType()

Measure type (pixels or percent) for Width and Height properties

Returns:

sizeMeasureType

setSizeMeasureType

public void setSizeMeasureType(SignTextOptions.SizeMeasureTypeEnum sizeMeasureType)

stretch

public SignTextOptions stretch(SignTextOptions.StretchEnum stretch)

getStretch

public SignTextOptions.StretchEnum getStretch()

Stretch mode on document page

Returns:

stretch

setStretch

public void setStretch(SignTextOptions.StretchEnum stretch)

rotationAngle

public SignTextOptions rotationAngle(Integer rotationAngle)

getRotationAngle

public Integer getRotationAngle()

Rotation angle of signature on document page (clockwise)

Returns:

rotationAngle

setRotationAngle

public void setRotationAngle(Integer rotationAngle)

horizontalAlignment

public SignTextOptions horizontalAlignment(SignTextOptions.HorizontalAlignmentEnum horizontalAlignment)

getHorizontalAlignment

public SignTextOptions.HorizontalAlignmentEnum getHorizontalAlignment()

Horizontal alignment of signature on document page

Returns:

horizontalAlignment

setHorizontalAlignment

public void setHorizontalAlignment(SignTextOptions.HorizontalAlignmentEnum horizontalAlignment)

verticalAlignment

public SignTextOptions verticalAlignment(SignTextOptions.VerticalAlignmentEnum verticalAlignment)

getVerticalAlignment

public SignTextOptions.VerticalAlignmentEnum getVerticalAlignment()

Vertical alignment of signature on document page

Returns:

verticalAlignment

setVerticalAlignment

public void setVerticalAlignment(SignTextOptions.VerticalAlignmentEnum verticalAlignment)

margin

public SignTextOptions margin(Padding margin)

getMargin

public Padding getMargin()

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

Returns:

margin

setMargin

public void setMargin(Padding margin)

marginMeasureType

public SignTextOptions marginMeasureType(SignTextOptions.MarginMeasureTypeEnum marginMeasureType)

getMarginMeasureType

public SignTextOptions.MarginMeasureTypeEnum getMarginMeasureType()

Gets or sets the measure type (pixels or percent) for Margin

Returns:

marginMeasureType

setMarginMeasureType

public void setMarginMeasureType(SignTextOptions.MarginMeasureTypeEnum marginMeasureType)

text

public SignTextOptions text(String text)

getText

public String getText()

Text of signature

Returns:

text

setText

public void setText(String text)

font

public SignTextOptions font(SignatureFont font)

getFont

public SignatureFont getFont()

Gets or sets the font of signature

Returns:

font

setFont

public void setFont(SignatureFont font)

foreColor

public SignTextOptions foreColor(Color foreColor)

getForeColor

public Color getForeColor()

Gets or sets the fore color of signature

Returns:

foreColor

setForeColor

public void setForeColor(Color foreColor)

backgroundColor

public SignTextOptions backgroundColor(Color backgroundColor)

getBackgroundColor

public Color getBackgroundColor()

Gets or sets the background color of signature

Returns:

backgroundColor

setBackgroundColor

public void setBackgroundColor(Color backgroundColor)

backgroundBrush

public SignTextOptions backgroundBrush(Brush backgroundBrush)

getBackgroundBrush

public Brush getBackgroundBrush()

Gets or sets the signature background brush. Value by default is null. If this property has a value it will be used instead BackgroundBrush property. For Spreadsheet documents TextStamp implementation RadialGradientBrush is not applicable, it is replaced by LinearGradientBrush. Spreadsheets, Images, Presentations It is not used for Watermark implementation. PDF For Stamp implementation LinearGradientBrush (ColorStart) and RadialGradientBrush (ColorInner) are used as SolidBrush. PDF It is not used for Annotation, Sticker, TextToFormField and Watermark implementations. Presentations For TextStamp implementation RadialGradientBrush is not applicable, it is replaced by LinearGradientBrush. Word Processing For TextStamp implementation LinearGradientBrush (ColorStart) and RadialGradientBrush (ColorInner) are used as SolidBrush. Word Processing It is not used for TextToFormField and Watermark implementations

Returns:

backgroundBrush

setBackgroundBrush

public void setBackgroundBrush(Brush backgroundBrush)

border

public SignTextOptions border(BorderLine border)

getBorder

public BorderLine getBorder()

Gets or sets the signature border properties

Returns:

border

setBorder

public void setBorder(BorderLine border)

textHorizontalAlignment

public SignTextOptions textHorizontalAlignment(SignTextOptions.TextHorizontalAlignmentEnum textHorizontalAlignment)

getTextHorizontalAlignment

public SignTextOptions.TextHorizontalAlignmentEnum getTextHorizontalAlignment()

Horizontal alignment of text inside a signature

Returns:

textHorizontalAlignment

setTextHorizontalAlignment

public void setTextHorizontalAlignment(SignTextOptions.TextHorizontalAlignmentEnum textHorizontalAlignment)

textVerticalAlignment

public SignTextOptions textVerticalAlignment(SignTextOptions.TextVerticalAlignmentEnum textVerticalAlignment)

getTextVerticalAlignment

public SignTextOptions.TextVerticalAlignmentEnum getTextVerticalAlignment()

Vertical alignment of text inside a signature

Returns:

textVerticalAlignment

setTextVerticalAlignment

public void setTextVerticalAlignment(SignTextOptions.TextVerticalAlignmentEnum textVerticalAlignment)

zorder

public SignTextOptions zorder(Integer zorder)

getZorder

public Integer getZorder()

Gets or sets the Z-order position of text signature. Determines the display order of overlapping signatures.

Returns:

zorder

setZorder

public void setZorder(Integer zorder)

_native

public SignTextOptions _native(Boolean _native)

getNative

public 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:

_native

setNative

public void setNative(Boolean _native)

equals

public boolean equals(Object o)

Overrides:

equals in class SignOptions

hashCode

public int hashCode()

Overrides:

hashCode in class SignOptions

toString

public String toString()

Overrides:

toString in class SignOptions