ShowSignatureCaptureRequest

java.lang.Object
- com.six.timapi.ShowSignatureCaptureRequest

public class ShowSignatureCaptureRequest
extends Object

Ecr show signature capture request.

Constructor Summary

Constructors
Constructor and Description
`ShowSignatureCaptureRequest()` Create show signature capture request.
`ShowSignatureCaptureRequest(ShowSignatureCaptureRequest request)` Create copy of show signature capture request.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Color`	`getBackgroundColor()` Background color.
`List<BrandBarBrand>`	`getBrandBar()` Brand bar.
`BrandMode`	`getBrandMode()` Brand mode.
`ImageFileFormat`	`getImageFileFormat()` Image file format to use.
`int`	`getImageFileHeight()` Image file height in pixels.
`int`	`getImageFileWidth()` Image file width in pixels.
`String`	`getLanguage()` Language.
`ResourceId`	`getResourceId()` Resource identifier.
`Color`	`getSignatureColor()` Signature color.
`Theme`	`getTheme()` Theme.
`int`	`getTimeout()` Timeout in seconds.
`Color`	`getWatermarkColor()` Watermark color.
`List<String>`	`getWatermarkItems()` List of watermark items.
`void`	`setBackgroundColor(Color backgroundColor)` Set background color.
`void`	`setBrandBar(List<BrandBarBrand> brandBar)` Set brand bar.
`void`	`setBrandMode(BrandMode brandMode)` Set brand mode.
`void`	`setImageFileFormat(ImageFileFormat imageFileFormat)` Set image file format to use.
`void`	`setImageFileHeight(int imageFileHeight)` Set image file height in pixels.
`void`	`setImageFileWidth(int imageFileWidth)` Set image file width in pixels.
`void`	`setLanguage(String language)` Set language.
`void`	`setResourceId(ResourceId resourceId)` Set resource identifier.
`void`	`setSignatureColor(Color signatureColor)` Set signature color.
`void`	`setTheme(Theme theme)` Set theme.
`void`	`setTimeout(int timeout)` Set timeout in seconds.
`void`	`setWatermarkColor(Color watermarkColor)` Set watermark color.
`void`	`setWatermarkItems(List<String> items)` Set list of watermark items.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ShowSignatureCaptureRequest
```
public ShowSignatureCaptureRequest()
```
    Create show signature capture request.
  - ShowSignatureCaptureRequest
```
public ShowSignatureCaptureRequest(ShowSignatureCaptureRequest request)
```
    Create copy of show signature capture request.
- Method Detail
  - getBrandBar
```
public List<BrandBarBrand> getBrandBar()
```
    Brand bar. Used if brand mode is BrandMode.SELECTED.
  - setBrandBar
```
public void setBrandBar(List<BrandBarBrand> brandBar)
```
    Set brand bar. Used if brand mode is BrandMode.SELECTED.
    
    Throws:
    
    IllegalArgumentException - brandBar is null.
  - getBrandMode
```
public BrandMode getBrandMode()
```
    Brand mode.
  - setBrandMode
```
public void setBrandMode(BrandMode brandMode)
```
    Set brand mode.
    
    Throws:
    
    IllegalArgumentException - brandBarMode is null.
  - getBackgroundColor
```
public Color getBackgroundColor()
```
    Background color.
  - setBackgroundColor
```
public void setBackgroundColor(Color backgroundColor)
```
    Set background color.
    
    Throws:
    
    IllegalArgumentException - backgroundColor is null.
  - getImageFileFormat
```
public ImageFileFormat getImageFileFormat()
```
    Image file format to use.
  - setImageFileFormat
```
public void setImageFileFormat(ImageFileFormat imageFileFormat)
```
    Set image file format to use.
    
    Throws:
    
    IllegalArgumentException - imageFileFormat is null.
  - getImageFileWidth
```
public int getImageFileWidth()
```
    Image file width in pixels.
  - setImageFileWidth
```
public void setImageFileWidth(int imageFileWidth)
```
    Set image file width in pixels.
    
    Throws:
    
    IllegalArgumentException - imageFileWidth is less than 0.
  - getImageFileHeight
```
public int getImageFileHeight()
```
    Image file height in pixels.
  - setImageFileHeight
```
public void setImageFileHeight(int imageFileHeight)
```
    Set image file height in pixels.
    
    Throws:
    
    IllegalArgumentException - imageFileHeight is less than 0.
  - getResourceId
```
public ResourceId getResourceId()
```
    Resource identifier.
  - setResourceId
```
public void setResourceId(ResourceId resourceId)
```
    Set resource identifier.
    
    Throws:
    
    IllegalArgumentException - resourceId is null.
  - getSignatureColor
```
public Color getSignatureColor()
```
    Signature color.
  - setSignatureColor
```
public void setSignatureColor(Color signatureColor)
```
    Set signature color.
  - getTheme
```
public Theme getTheme()
```
    Theme.
  - setTheme
```
public void setTheme(Theme theme)
```
    Set theme.
  - getTimeout
```
public int getTimeout()
```
    Timeout in seconds.
  - setTimeout
```
public void setTimeout(int timeout)
```
    Set timeout in seconds.
  - getLanguage
```
public String getLanguage()
```
    Language. Can be null if not set.
  - setLanguage
```
public void setLanguage(String language)
```
    Set language. Can be null if not set.
  - getWatermarkColor
```
public Color getWatermarkColor()
```
    Watermark color.
  - setWatermarkColor
```
public void setWatermarkColor(Color watermarkColor)
```
    Set watermark color.
  - getWatermarkItems
```
public List<String> getWatermarkItems()
```
    List of watermark items.
  - setWatermarkItems
```
public void setWatermarkItems(List<String> items)
```
    Set list of watermark items.

Class ShowSignatureCaptureRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ShowSignatureCaptureRequest

ShowSignatureCaptureRequest

Method Detail

getBrandBar

setBrandBar

getBrandMode

setBrandMode

getBackgroundColor

setBackgroundColor

getImageFileFormat

setImageFileFormat

getImageFileWidth

setImageFileWidth

getImageFileHeight

setImageFileHeight

getResourceId

setResourceId

getSignatureColor

setSignatureColor

getTheme

setTheme

getTimeout

setTimeout

getLanguage

setLanguage

getWatermarkColor

setWatermarkColor

getWatermarkItems

setWatermarkItems