com.so.net

Class DeviceApi.SignatureImage

java.lang.Object

com.so.net.DeviceApi.SignatureImage

Enclosing class:

DeviceApi

public static final class DeviceApi.SignatureImage
extends Object

Can get the signature image and change related options.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DeviceApi.SignatureImage.Alignment Has several alignment options.
static class	DeviceApi.SignatureImage.ResizeOption Has various resize options.

Method Summary

Modifier and Type	Method and Description
static Optional<BufferedImage>	get(int width, int height) Gets the signature image.
static Optional<DeviceApi.SignatureImage.Alignment>	getAlignment() Gets the alignment option.
static Optional<Color>	getBackgroundColor() Gets the background color.
static Optional<Color>	getLineColor() Gets the line color.
static Optional<Double>	getLineWidth() Gets the line width.
static boolean	multiplyLineWidth(double factor) Scales the line width
static boolean	setAlignment(DeviceApi.SignatureImage.Alignment alignment) Sets the alignment option.
static boolean	setBackgroundColor(Color color) Sets the background color.
static boolean	setLineColor(Color color) Sets the line color
static boolean	setLineWidth(double width) Sets the line width.
static boolean	setResizeOption(DeviceApi.SignatureImage.ResizeOption resizeOption) Sets the resize option.

Methods inherited from class java.lang.Object

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

Method Detail

get

public static Optional<BufferedImage> get(int width,
                                          int height)

Gets the signature image.

Parameters:

width - The desired width.

height - The desired height.

Returns:

Some image in case of success. Note that DeviceApi.SignatureImage.ResizeOptions have to be set for the width and height arguments to have an effect.

getAlignment

public static Optional<DeviceApi.SignatureImage.Alignment> getAlignment()

Gets the alignment option.

Returns:

Some alignment in case of success.

setAlignment

public static boolean setAlignment(DeviceApi.SignatureImage.Alignment alignment)

Sets the alignment option.

Parameters:

alignment - The desired alignment.

Returns:

True in case of success.

getBackgroundColor

public static Optional<Color> getBackgroundColor()

Gets the background color.

Returns:

Some color in case of success.

setBackgroundColor

public static boolean setBackgroundColor(Color color)

Sets the background color.

Parameters:

color - The color.

Returns:

True in case of success.

getLineColor

public static Optional<Color> getLineColor()

Gets the line color.

Returns:

Some color in case of success.

setLineColor

public static boolean setLineColor(Color color)

Sets the line color

Parameters:

color - The color.

Returns:

True in case of success.

getLineWidth

public static Optional<Double> getLineWidth()

Gets the line width.

Returns:

Some width in case of success.

setLineWidth

public static boolean setLineWidth(double width)

Sets the line width.

Parameters:

width - The width.

Returns:

True in case of success. Consider using multiplyLineWidth(double).

multiplyLineWidth

public static boolean multiplyLineWidth(double factor)

Scales the line width

Parameters:

factor - The scale factor.

Returns:

True in case success.

setResizeOption

public static boolean setResizeOption(DeviceApi.SignatureImage.ResizeOption resizeOption)

Sets the resize option.

Parameters:

resizeOption - The resize option.

Returns:

True in case of success.