WatermarkOptions
Inheritance: java.lang.Object, com.groupdocs.conversion.contracts.ValueObject
All Implemented Interfaces: java.lang.Cloneable, java.io.Serializable
public abstract class WatermarkOptions extends ValueObject implements Cloneable, Serializable
Options for settings watermark to the converted document
Constructors
| Constructor | Description |
|---|---|
| WatermarkOptions() | Create WatermarkOptions class and set watermark text |
Methods
| Method | Description |
|---|---|
| getWidth() | Watermark width |
| setWidth(int value) | Watermark width |
| getHeight() | Watermark height |
| setHeight(int value) | Watermark height |
| getTop() | Watermark top position |
| setTop(int value) | Watermark top position |
| getLeft() | Watermark left position |
| setLeft(int value) | Watermark left position |
| getRotationAngle() | Watermark rotation angle |
| setRotationAngle(int value) | Watermark rotation angle |
| getTransparency() | Watermark transparency. |
| setTransparency(double value) | Watermark transparency. |
| getBackground() | Indicates that the watermark is stamped as background. |
| setBackground(boolean value) | Indicates that the watermark is stamped as background. |
| isAutoAlign() | |
| setAutoAlign(boolean autoAlign) | |
| deepClone() | Clone current instance |
WatermarkOptions()
public WatermarkOptions()
Create WatermarkOptions class and set watermark text
getWidth()
public final int getWidth()
Watermark width
Returns: int
setWidth(int value)
public final void setWidth(int value)
Watermark width
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
getHeight()
public final int getHeight()
Watermark height
Returns: int
setHeight(int value)
public final void setHeight(int value)
Watermark height
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
getTop()
public final int getTop()
Watermark top position
Returns: int
setTop(int value)
public final void setTop(int value)
Watermark top position
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
getLeft()
public final int getLeft()
Watermark left position
Returns: int
setLeft(int value)
public final void setLeft(int value)
Watermark left position
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
getRotationAngle()
public final int getRotationAngle()
Watermark rotation angle
Returns: int
setRotationAngle(int value)
public final void setRotationAngle(int value)
Watermark rotation angle
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
getTransparency()
public final double getTransparency()
Watermark transparency. Value between 0 and 1. Value 0 is fully visible, value 1 is invisible.
Returns: double
setTransparency(double value)
public final void setTransparency(double value)
Watermark transparency. Value between 0 and 1. Value 0 is fully visible, value 1 is invisible.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | double |
getBackground()
public final boolean getBackground()
Indicates that the watermark is stamped as background. If the value is true, the watermark is laid at the bottom. By default is false and the watermark is laid on top.
Returns: boolean
setBackground(boolean value)
public final void setBackground(boolean value)
Indicates that the watermark is stamped as background. If the value is true, the watermark is laid at the bottom. By default is false and the watermark is laid on top.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
isAutoAlign()
public boolean isAutoAlign()
Returns: boolean
setAutoAlign(boolean autoAlign)
public void setAutoAlign(boolean autoAlign)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| autoAlign | boolean |
deepClone()
public final Object deepClone()
Clone current instance
Returns: java.lang.Object - instance