ImageSignOptions

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, com.aspose.ms.System.IDisposable

public class ImageSignOptions extends SignOptions implements IRectangle, IAlignment, IRotation, ITransparency, System.IDisposable

Represents the Image signature options.

Constructors

Constructor Description
ImageSignOptions() Initializes a new instance of the ImageSignOptions class with default values.
ImageSignOptions(String imageFilePath) Initializes a new instance of the ImageSignOptions class with image file.
ImageSignOptions(InputStream imageStream) Initializes a new instance of the ImageSignOptions class with image stream.

Methods

Method Description
getImageFilePath() Gets or sets the signature image file path.
setImageFilePath(String value) Gets or sets the signature image file path.
getImageStream() Gets or sets the signature image stream.
setImageStream(InputStream value) Gets or sets the signature image stream.
getLeft() Left X position of Signature on Document Page in Measure values (pixels, percents or millimeters see MeasureType LocationMeasureType).
setLeft(int value) Left X position of Signature on Document Page in Measure values (pixels, percents or millimeters see MeasureType LocationMeasureType).
getTop() Top Y Position of Signature on Document Page in Measure values (pixels, percents or millimeters see MeasureType LocationMeasureType).
setTop(int value) Top Y Position of Signature on Document Page in Measure values (pixels, percents or millimeters see MeasureType LocationMeasureType).
getWidth() Width of Signature on Document Page in Measure values (pixels, percents or millimeters MeasureType SizeMeasureType).
setWidth(int value) Width of Signature on Document Page in Measure values (pixels, percents or millimeters MeasureType SizeMeasureType).
getHeight() Height of Signature on Document Page in Measure values (pixels, percents or millimeters see MeasureType SizeMeasureType).
setHeight(int value) Height of Signature on Document Page in Measure values (pixels, percents or millimeters see MeasureType SizeMeasureType).
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)).
getShapePosition() Defines where shape should be presented in the document layout
setShapePosition(int value) Defines where shape should be presented in the document layout
getRectangle() Rectangle of area to put the image on document.
getBorder() Specify border settings
setBorder(Border value) Specify border settings
toString() Override string conversion.
fromBase64(String base64Content) Creates a new instance of the ImageSignOptions class with predefined Image from Base64.
dispose() Clears internal resources

ImageSignOptions()

public ImageSignOptions()

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

ImageSignOptions(String imageFilePath)

public ImageSignOptions(String imageFilePath)

Initializes a new instance of the ImageSignOptions class with image file.

Parameters:

Parameter Type Description
imageFilePath java.lang.String Image file path

ImageSignOptions(InputStream imageStream)

public ImageSignOptions(InputStream imageStream)

Initializes a new instance of the ImageSignOptions class with image stream.

Parameters:

Parameter Type Description
imageStream java.io.InputStream Image stream

getImageFilePath()

public final String getImageFilePath()

Gets or sets the signature image file path. This property is used only if ImageStream is not specified.

Returns: java.lang.String

setImageFilePath(String value)

public final void setImageFilePath(String value)

Gets or sets the signature image file path. This property is used only if ImageStream is not specified.

Parameters:

Parameter Type Description
value java.lang.String

getImageStream()

public final InputStream getImageStream()

Gets or sets the signature image stream. If this property is specified it is always used instead ImageGuid.

Returns: java.io.InputStream

setImageStream(InputStream value)

public final void setImageStream(InputStream value)

Gets or sets the signature image stream. If this property is specified it is always used instead ImageGuid.

Parameters:

Parameter Type Description
value java.io.InputStream

getLeft()

public int getLeft()

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

Returns: int

setLeft(int value)

public void setLeft(int value)

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

Parameters:

Parameter Type Description
value int

getTop()

public int getTop()

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

Returns: int

setTop(int value)

public void setTop(int value)

Top Y Position of Signature on Document Page in Measure values (pixels, percents or millimeters see MeasureType LocationMeasureType). (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 MeasureType SizeMeasureType).

Returns: int

setWidth(int value)

public final void setWidth(int value)

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

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).

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).

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

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

getRectangle()

public final Rectangle getRectangle()

Rectangle of area to put the image on document.

Returns: java.awt.Rectangle

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

toString()

public String toString()

Override string conversion.

Returns: java.lang.String -

fromBase64(String base64Content)

public static ImageSignOptions fromBase64(String base64Content)

Creates a new instance of the ImageSignOptions class with predefined Image from Base64.

Parameters:

Parameter Type Description
base64Content java.lang.String Image content in Base64 string format

Returns: ImageSignOptions -

dispose()

public final void dispose()

Clears internal resources