SignImageOptions (GroupDocs.Signature for Java (18.4) API Reference)

java.lang.Object
- com.groupdocs.signature.options.SignOptions
- - com.groupdocs.signature.options.imagesignature.SignImageOptions

All Implemented Interfaces:

IAlignment, IOpacity, IRectangle, IRotation

Direct Known Subclasses:

CellsSignImageOptions, ImagesSignImageOptions, PdfSignImageOptions, SignDigitalOptions, SlidesSignImageOptions, StampSignOptions, WordsSignImageOptions
```
public abstract class SignImageOptions
extends SignOptions
implements IRectangle, IAlignment, IRotation, IOpacity
```
Represents the Image Signature Options.

Constructor Summary

Constructors
Constructor and Description
`SignImageOptions()` Initializes a new instance of the SignImageOptions class with default values.
`SignImageOptions(InputStream imageStream)` Initializes a new instance of the SignImageOptions class with image stream.
`SignImageOptions(String imageGuid)` Initializes a new instance of the SignImageOptions class with image file.

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`getHeight()` Height of Signature on Document Page in Measure values (pixels or percent see `MeasureType` SizeMeasureType).
`int`	`getHorizontalAlignment()` Horizontal alignment of signature on document page.
`String`	`getImageGuid()` Gets or sets the signature image file name.
`protected com.groupdocs.signature.domain.helpers.ImageHelper`	`getImageHelper()`
`InputStream`	`getImageStream()` Gets or sets the signature image stream.
`int`	`getLeft()` Left X position of Signature on Document Page in Measure values (pixels or percent see `MeasureType` LocationMeasureType).
`int`	`getLocationMeasureType()` Measure type (pixels or percent) for Left and Top properties.
`Padding`	`getMargin()` Gets or sets the space between Sign and Document edges.
`int`	`getMarginMeasureType()` Gets or sets the measure type (pixels or percent) for Margin.
`double`	`getOpacity()` Gets or sets the additional opacity for sign image (value from 0.0 (clear) through 1.0 (opaque)).
`Rectangle`	`getRectangle()` Rectangle of area to put the image on document.
`int`	`getRotationAngle()` Rotation angle of signature on document page (clockwise).
`boolean`	`getSignAllPages()` Put signature on all document pages.
`int`	`getSizeMeasureType()` Measure type (pixels or percent) for Width and Height properties.
`int`	`getStretch()` Stretch mode on Document Page.
`int`	`getTop()` Top Y Position of Signature on Document Page in Measure values (pixels or percent see `MeasureType` LocationMeasureType).
`int`	`getVerticalAlignment()` Vertical alignment of signature on document page.
`int`	`getWidth()` Width of Signature on Document Page in Measure values (pixels or percent see `MeasureType` SizeMeasureType).
`void`	`setHeight(int value)` Height of Signature on Document Page in Measure values (pixels or percent see `MeasureType` SizeMeasureType).
`void`	`setHorizontalAlignment(int value)` Horizontal alignment of signature on document page.
`void`	`setImageGuid(String value)` Gets or sets the signature image file name.
`void`	`setImageStream(InputStream value)` Gets or sets the signature image stream.
`void`	`setLeft(int value)` Left X position of Signature on Document Page in Measure values (pixels or percent see `MeasureType` LocationMeasureType).
`void`	`setLocationMeasureType(int value)` Measure type (pixels or percent) for Left and Top properties.
`void`	`setMargin(Padding value)` Gets or sets the space between Sign and Document edges.
`void`	`setMarginMeasureType(int value)` Gets or sets the measure type (pixels or percent) for Margin.
`void`	`setOpacity(double value)` Gets or sets the additional opacity for sign image (value from 0.0 (clear) through 1.0 (opaque)).
`void`	`setRotationAngle(int value)` Rotation angle of signature on document page (clockwise).
`void`	`setSignAllPages(boolean value)` Put signature on all document pages.
`void`	`setSizeMeasureType(int value)` Measure type (pixels or percent) for Width and Height properties.
`void`	`setStretch(int value)` Stretch mode on Document Page.
`void`	`setTop(int value)` Top Y Position of Signature on Document Page in Measure values (pixels or percent see `MeasureType` LocationMeasureType).
`void`	`setVerticalAlignment(int value)` Vertical alignment of signature on document page.
`void`	`setWidth(int value)` Width of Signature on Document Page in Measure values (pixels or percent see `MeasureType` SizeMeasureType).
`String`	`toString()` Override string conversion.

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
  - SignImageOptions
```
public SignImageOptions()
```
    Initializes a new instance of the SignImageOptions class with default values.
  - SignImageOptions
```
public SignImageOptions(InputStream imageStream)
```
    Initializes a new instance of the SignImageOptions class with image stream.
    
    Parameters:
    imageStream - Image stream
  - SignImageOptions
```
public SignImageOptions(String imageGuid)
```
    Initializes a new instance of the SignImageOptions class with image file.
    
    Parameters:
    imageGuid - Image file GUID
- Method Detail
  - getHeight
```
public int getHeight()
```
    Height of Signature on Document Page in Measure values (pixels or percent see MeasureType SizeMeasureType).
    
    Specified by:
    
    getHeight in interface IRectangle
  - getHorizontalAlignment
```
public int getHorizontalAlignment()
```
    Horizontal alignment of signature on document page.
    
    Specified by:
    
    getHorizontalAlignment in interface IAlignment
  - getImageGuid
```
public String getImageGuid()
```
    Gets or sets the signature image file name. This property is used only if ImageStream is not specified.
  - getImageHelper
```
protected com.groupdocs.signature.domain.helpers.ImageHelper getImageHelper()
```
  - getImageStream
```
public InputStream getImageStream()
```
    Gets or sets the signature image stream. If this property is specified it is always used instead ImageGuid.
  - getLeft
```
public int getLeft()
```
    Left X position of Signature on Document Page in Measure values (pixels or percent see MeasureType LocationMeasureType). (works if horizontal alignment is not specified).
    
    Specified by:
    
    getLeft in interface IRectangle
  - getLocationMeasureType
```
public int getLocationMeasureType()
```
    Measure type (pixels or percent) for Left and Top properties.
    
    Specified by:
    
    getLocationMeasureType in interface IRectangle
  - getMargin
```
public Padding getMargin()
```
    Gets or sets the space between Sign and Document edges. (works ONLY if horizontal or vertical alignment are specified).
    
    Specified by:
    
    getMargin in interface IAlignment
  - getMarginMeasureType
```
public int getMarginMeasureType()
```
    Gets or sets the measure type (pixels or percent) for Margin.
    
    Specified by:
    
    getMarginMeasureType in interface IAlignment
  - getOpacity
```
public double getOpacity()
```
    Gets or sets the additional opacity for sign image (value from 0.0 (clear) through 1.0 (opaque)). By default the value is 1.0.
    
    Specified by:
    
    getOpacity in interface IOpacity
  - getRectangle
```
public Rectangle getRectangle()
```
    Rectangle of area to put the image on document.
  - getRotationAngle
```
public int getRotationAngle()
```
    Rotation angle of signature on document page (clockwise).
    
    Specified by:
    
    getRotationAngle in interface IRotation
  - getSignAllPages
```
public boolean getSignAllPages()
```
    Put signature on all document pages.
  - getSizeMeasureType
```
public int getSizeMeasureType()
```
    Measure type (pixels or percent) for Width and Height properties.
    
    Specified by:
    
    getSizeMeasureType in interface IRectangle
  - getStretch
```
public int getStretch()
```
    Stretch mode on Document Page.
    
    Specified by:
    
    getStretch in interface IRectangle
  - getTop
```
public int getTop()
```
    Top Y Position of Signature on Document Page in Measure values (pixels or percent see MeasureType LocationMeasureType). (works if vertical alignment is not specified).
    
    Specified by:
    
    getTop in interface IRectangle
  - getVerticalAlignment
```
public int getVerticalAlignment()
```
    Vertical alignment of signature on document page.
    
    Specified by:
    
    getVerticalAlignment in interface IAlignment
  - getWidth
```
public int getWidth()
```
    Width of Signature on Document Page in Measure values (pixels or percent see MeasureType SizeMeasureType).
    
    Specified by:
    
    getWidth in interface IRectangle
  - setHeight
```
public void setHeight(int value)
```
    Height of Signature on Document Page in Measure values (pixels or percent see MeasureType SizeMeasureType).
    
    Specified by:
    
    setHeight in interface IRectangle
  - setHorizontalAlignment
```
public void setHorizontalAlignment(int value)
```
    Horizontal alignment of signature on document page.
    
    Specified by:
    
    setHorizontalAlignment in interface IAlignment
  - setImageGuid
```
public void setImageGuid(String value)
```
    Gets or sets the signature image file name. This property is used only if ImageStream is not specified.
  - setImageStream
```
public void setImageStream(InputStream value)
```
    Gets or sets the signature image stream. If this property is specified it is always used instead ImageGuid.
  - setLeft
```
public void setLeft(int value)
```
    Left X position of Signature on Document Page in Measure values (pixels or percent see MeasureType LocationMeasureType). (works if horizontal alignment is not specified).
    
    Specified by:
    
    setLeft in interface IRectangle
  - setLocationMeasureType
```
public void setLocationMeasureType(int value)
```
    Measure type (pixels or percent) for Left and Top properties.
    
    Specified by:
    
    setLocationMeasureType in interface IRectangle
  - setMargin
```
public void setMargin(Padding value)
```
    Gets or sets the space between Sign and Document edges. (works ONLY if horizontal or vertical alignment are specified).
    
    Specified by:
    
    setMargin in interface IAlignment
  - setMarginMeasureType
```
public void setMarginMeasureType(int value)
```
    Gets or sets the measure type (pixels or percent) for Margin.
    
    Specified by:
    
    setMarginMeasureType in interface IAlignment
  - setOpacity
```
public void setOpacity(double value)
```
    Gets or sets the additional opacity for sign image (value from 0.0 (clear) through 1.0 (opaque)). By default the value is 1.0.
    
    Specified by:
    
    setOpacity in interface IOpacity
  - setRotationAngle
```
public void setRotationAngle(int value)
```
    Rotation angle of signature on document page (clockwise).
    
    Specified by:
    
    setRotationAngle in interface IRotation
  - setSignAllPages
```
public void setSignAllPages(boolean value)
```
    Put signature on all document pages.
  - setSizeMeasureType
```
public void setSizeMeasureType(int value)
```
    Measure type (pixels or percent) for Width and Height properties.
    
    Specified by:
    
    setSizeMeasureType in interface IRectangle
  - setStretch
```
public void setStretch(int value)
```
    Stretch mode on Document Page.
    
    Specified by:
    
    setStretch in interface IRectangle
  - setTop
```
public void setTop(int value)
```
    Top Y Position of Signature on Document Page in Measure values (pixels or percent see MeasureType LocationMeasureType). (works if vertical alignment is not specified).
    
    Specified by:
    
    setTop in interface IRectangle
  - setVerticalAlignment
```
public void setVerticalAlignment(int value)
```
    Vertical alignment of signature on document page.
    
    Specified by:
    
    setVerticalAlignment in interface IAlignment
  - setWidth
```
public void setWidth(int value)
```
    Width of Signature on Document Page in Measure values (pixels or percent see MeasureType SizeMeasureType).
    
    Specified by:
    
    setWidth in interface IRectangle
  - toString
```
public String toString()
```
    Override string conversion.
    
    Overrides:
    
    toString in class SignOptions
    
    Returns:

Class SignImageOptions

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

SignImageOptions

SignImageOptions

SignImageOptions

Method Detail

getHeight

getHorizontalAlignment

getImageGuid

getImageHelper

getImageStream

getLeft

getLocationMeasureType

getMargin

getMarginMeasureType

getOpacity

getRectangle

getRotationAngle

getSignAllPages

getSizeMeasureType

getStretch

getTop

getVerticalAlignment

getWidth

setHeight

setHorizontalAlignment

setImageGuid

setImageStream

setLeft

setLocationMeasureType

setMargin

setMarginMeasureType

setOpacity

setRotationAngle

setSignAllPages

setSizeMeasureType

setStretch

setTop

setVerticalAlignment

setWidth

toString