com.groupdocs.signature.options.qrcodesignature

Class QRCodeSignOptions

java.lang.Object

com.groupdocs.signature.options.SignOptions

com.groupdocs.signature.options.textsignature.SignTextOptions

com.groupdocs.signature.options.qrcodesignature.QRCodeSignOptions

All Implemented Interfaces:

IAlignment, IOpacity, IRectangle, IRotation

Direct Known Subclasses:

CellsQRCodeSignOptions, ImagesQRCodeSignOptions, PdfQRCodeSignOptions, SlidesQRCodeSignOptions, WordsQRCodeSignOptions

public abstract class QRCodeSignOptions
extends SignTextOptions
implements IOpacity

Represents the QR-Code Signature Options.

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
Brush	getBackgroundBrushStyle() Gets or sets the signature background brush.
Color	getBackgroundColor() Gets or sets the background color of signature.
Color	getBorderColor() Gets or sets the border color of signature.
int	getBorderDashStyle() Gets or sets the signature border style.
boolean	getBorderVisiblity() Gets or sets the signature border visibility.
double	getBorderWeight() Gets or sets the weight of the signature border.
int	getCodeTextAlignment() Gets or sets the alignment of text in the result QR-code image.
QRCodeType	getEncodeType() Get or set QRCode type.
Color	getForeColor() Gets or sets the Fore color of QR-Code bars Using of this property could cause problems with verification.
protected com.groupdocs.signature.domain.helpers.ImageHelper	getImageHelper()
Padding	getInnerMargins() Gets or sets the space between QRCode elements and result image borders.
String	getLogoGuid() Gets or sets the QR-code logo image file name.
InputStream	getLogoStream() Gets or sets the QR-code logo image stream.
double	getOpacity() Gets or sets the signature opacity (value from 0.0 (clear) through 1.0 (opaque)).
void	setBackgroundBrushStyle(Brush value) Gets or sets the signature background brush.
void	setBackgroundColor(Color value) Gets or sets the background color of signature.
void	setBorderColor(Color value) Gets or sets the border color of signature.
void	setBorderDashStyle(int value) Gets or sets the signature border style.
void	setBorderVisiblity(boolean value) Gets or sets the signature border visibility.
void	setBorderWeight(double value) Gets or sets the weight of the signature border.
void	setCodeTextAlignment(int value) Gets or sets the alignment of text in the result QR-code image.
void	setEncodeType(QRCodeType value) Get or set QRCode type.
void	setForeColor(Color value) Gets or sets the Fore color of QR-Code bars Using of this property could cause problems with verification.
void	setInnerMargins(Padding value) Gets or sets the space between QRCode elements and result image borders.
void	setLogoGuid(String value) Gets or sets the QR-code logo image file name.
void	setLogoStream(InputStream value) Gets or sets the QR-code logo image stream.
void	setOpacity(double value) Gets or sets the signature opacity (value from 0.0 (clear) through 1.0 (opaque)).
String	toString() Override string conversion.

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

getFont, getHeight, getHorizontalAlignment, getLeft, getLocationMeasureType, getMargin, getMarginMeasureType, getRotationAngle, getSignAllPages, getSizeMeasureType, getStretch, getText, getTop, getVerticalAlignment, getWidth, setFont, setHeight, setHorizontalAlignment, setLeft, setLocationMeasureType, setMargin, setMarginMeasureType, setRotationAngle, setSignAllPages, setSizeMeasureType, setStretch, setText, setTop, setVerticalAlignment, setWidth

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

getAppearance, getDocumentPageNumber, getExtensions, getPagesSetup, release, setAppearance, setDocumentPageNumber, setPagesSetup, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

QRCodeSignOptions

public QRCodeSignOptions()

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

QRCodeSignOptions

public QRCodeSignOptions(String text)

Initializes a new instance of the QRCodeSignOptions 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. BackgroundBrushStyle has limited scope of application for Qr-codes. SolidBrush, LinearGradientBrush (ColorStart) and RadialGradientBrush (ColorInner) are used instead BackgroundColor. TextureBrush is not used.

Overrides:

getBackgroundBrushStyle in class SignTextOptions

getBackgroundColor

public Color getBackgroundColor()

Gets or sets the background color of signature. Using of this property could cause problems with verification. Use it carefully.

Overrides:

getBackgroundColor in class SignTextOptions

getBorderColor

public Color getBorderColor()

Gets or sets the border color of signature. Using of this property could cause problems with verification. Use it carefully.

Overrides:

getBorderColor in class SignTextOptions

getBorderDashStyle

public int getBorderDashStyle()

Gets or sets the signature border style. Using of this property could cause problems with verification. Use it carefully.

getBorderVisiblity

public boolean getBorderVisiblity()

Gets or sets the signature border visibility. Using of this property could cause problems with verification. Use it carefully.

getBorderWeight

public double getBorderWeight()

Gets or sets the weight of the signature border. Using of this property could cause problems with verification. Use it carefully.

getCodeTextAlignment

public int getCodeTextAlignment()

Gets or sets the alignment of text in the result QR-code image. Default value is None.

getEncodeType

public QRCodeType getEncodeType()

Get or set QRCode type.

getForeColor

public Color getForeColor()

Gets or sets the Fore color of QR-Code bars Using of this property could cause problems with verification. Use it carefully.

Overrides:

getForeColor in class SignTextOptions

getImageHelper

protected com.groupdocs.signature.domain.helpers.ImageHelper getImageHelper()

Overrides:

getImageHelper in class SignTextOptions

getInnerMargins

public Padding getInnerMargins()

Gets or sets the space between QRCode elements and result image borders.

getLogoGuid

public String getLogoGuid()

Gets or sets the QR-code logo image file name. This property in use only if LogoStream is not specified. Using of this property could cause problems with verification. Use it carefully.

getLogoStream

public InputStream getLogoStream()

Gets or sets the QR-code logo image stream. If this property is specified it is always used instead LogoGuid. Using of this property could cause problems with verification. Use it carefully.

getOpacity

public double getOpacity()

Gets or sets the signature opacity (value from 0.0 (clear) through 1.0 (opaque)). By default the value is 1.0. Using of this property could cause problems with verification. Use it carefully.

Specified by:

getOpacity in interface IOpacity

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. BackgroundBrushStyle has limited scope of application for Qr-codes. SolidBrush, LinearGradientBrush (ColorStart) and RadialGradientBrush (ColorInner) are used instead BackgroundColor. TextureBrush is not used.

Overrides:

setBackgroundBrushStyle in class SignTextOptions

setBackgroundColor

public void setBackgroundColor(Color value)

Gets or sets the background color of signature. Using of this property could cause problems with verification. Use it carefully.

Overrides:

setBackgroundColor in class SignTextOptions

setBorderColor

public void setBorderColor(Color value)

Gets or sets the border color of signature. Using of this property could cause problems with verification. Use it carefully.

Overrides:

setBorderColor in class SignTextOptions

setBorderDashStyle

public void setBorderDashStyle(int value)

Gets or sets the signature border style. Using of this property could cause problems with verification. Use it carefully.

setBorderVisiblity

public void setBorderVisiblity(boolean value)

Gets or sets the signature border visibility. Using of this property could cause problems with verification. Use it carefully.

setBorderWeight

public void setBorderWeight(double value)

Gets or sets the weight of the signature border. Using of this property could cause problems with verification. Use it carefully.

setCodeTextAlignment

public void setCodeTextAlignment(int value)

Gets or sets the alignment of text in the result QR-code image. Default value is None.

setEncodeType

public void setEncodeType(QRCodeType value)

Get or set QRCode type.

setForeColor

public void setForeColor(Color value)

Gets or sets the Fore color of QR-Code bars Using of this property could cause problems with verification. Use it carefully.

Overrides:

setForeColor in class SignTextOptions

setInnerMargins

public void setInnerMargins(Padding value)

Gets or sets the space between QRCode elements and result image borders.

setLogoGuid

public void setLogoGuid(String value)

Gets or sets the QR-code logo image file name. This property in use only if LogoStream is not specified. Using of this property could cause problems with verification. Use it carefully.

setLogoStream

public void setLogoStream(InputStream value)

Gets or sets the QR-code logo image stream. If this property is specified it is always used instead LogoGuid. Using of this property could cause problems with verification. Use it carefully.

setOpacity

public void setOpacity(double value)

Gets or sets the signature opacity (value from 0.0 (clear) through 1.0 (opaque)). By default the value is 1.0. Using of this property could cause problems with verification. Use it carefully.

Specified by:

setOpacity in interface IOpacity

toString

public String toString()

Override string conversion.

Overrides:

toString in class SignTextOptions

Returns: