@Deprecated public abstract class Watermark extends Object
Represents a watermark to be added to the document.
Modifier and Type | Method and Description |
---|---|
boolean |
getConsiderParentMargins()
Deprecated.
Gets a value indicating whether the watermark size and coordinates are calculated considering parent margins.
|
double |
getHeight()
Deprecated.
Gets the desired height of this
Watermark . |
int |
getHorizontalAlignment()
Deprecated.
Gets the horizontal alignment of this
Watermark . |
Margins |
getMargins()
Deprecated.
Gets the margin settings of this
Watermark . |
double |
getOpacity()
Deprecated.
Gets the opacity of this
Watermark . |
double |
getRotateAngle()
Deprecated.
Gets the rotate angle of this
Watermark in degrees. |
double |
getScaleFactor()
Deprecated.
Gets a value that defines how watermark size depends on parent size.
|
int |
getSizingType()
Deprecated.
Gets a value specifying a way watermark should be sized.
|
int |
getVerticalAlignment()
Deprecated.
Gets the vertical alignment of this
Watermark . |
double |
getWidth()
Deprecated.
Gets the desired width of this
Watermark . |
double |
getX()
Deprecated.
Gets the x-coordinate of this
Watermark . |
double |
getY()
Deprecated.
Gets the y-coordinate of this
Watermark . |
boolean |
isBackground()
Deprecated.
Gets a value indicating whether the watermark should be placed at background.
|
void |
setBackground(boolean value)
Deprecated.
Sets a value indicating whether the watermark should be placed at background.
|
void |
setConsiderParentMargins(boolean value)
Deprecated.
Sets a value indicating whether the watermark size and coordinates are calculated considering parent margins.
|
void |
setHeight(double value)
Deprecated.
Sets the desired height of this
Watermark . |
void |
setHorizontalAlignment(int value)
Deprecated.
Sets the horizontal alignment of this
Watermark . |
void |
setMargins(Margins value)
Deprecated.
Sets the margin settings of this
Watermark . |
void |
setOpacity(double value)
Deprecated.
Sets the opacity of this
Watermark . |
void |
setRotateAngle(double value)
Deprecated.
Sets the rotate angle of this
Watermark in degrees. |
void |
setScaleFactor(double value)
Deprecated.
Sets a value that defines how watermark size depends on parent size.
|
void |
setSizingType(int value)
Deprecated.
Sets a value specifying a way watermark should be sized.
|
void |
setVerticalAlignment(int value)
Deprecated.
Sets the vertical alignment of this
Watermark . |
void |
setWidth(double value)
Deprecated.
Sets the desired width of this
Watermark . |
void |
setX(double value)
Deprecated.
Sets the x-coordinate of this
Watermark . |
void |
setY(double value)
Deprecated.
Sets the y-coordinate of this
Watermark . |
public final double getOpacity()
Gets the opacity of this Watermark
.
Watermark
. The value should be between 0 and 1. Default value is 1.public final void setOpacity(double value)
Sets the opacity of this Watermark
.
value
- The opacity of this Watermark
. The value should be between 0 and 1. Default value is 1.public final double getY()
Gets the y-coordinate of this Watermark
.
Watermark
.public final void setY(double value)
Sets the y-coordinate of this Watermark
.
value
- The y-coordinate of this Watermark
.public final double getX()
Gets the x-coordinate of this Watermark
.
Watermark
.public final void setX(double value)
Sets the x-coordinate of this Watermark
.
value
- The x-coordinate of this Watermark
.public final int getVerticalAlignment()
Gets the vertical alignment of this Watermark
.
Watermark
. Default value is F:VerticalAlignment.None
.public final void setVerticalAlignment(int value)
Sets the vertical alignment of this Watermark
.
value
- The vertical alignment of this Watermark
. Default value is F:VerticalAlignment.None
.public final int getHorizontalAlignment()
Gets the horizontal alignment of this Watermark
.
Watermark
. Default value is F:HorizontalAlignment.None
.public final void setHorizontalAlignment(int value)
Sets the horizontal alignment of this Watermark
.
value
- The horizontal alignment of this Watermark
. Default value is F:HorizontalAlignment.None
.public final double getRotateAngle()
Gets the rotate angle of this Watermark
in degrees.
Watermark
in degrees.public final void setRotateAngle(double value)
Sets the rotate angle of this Watermark
in degrees.
value
- The rotate angle of this Watermark
in degrees.public final boolean isBackground()
Gets a value indicating whether the watermark should be placed at background.
public final void setBackground(boolean value)
Sets a value indicating whether the watermark should be placed at background.
value
- If the value is true, the watermark will be placed at the bottom.
By default, the value is false, the watermark will be placed at the top.public final Margins getMargins()
Gets the margin settings of this Watermark
.
Watermark
.public final void setMargins(Margins value)
Sets the margin settings of this Watermark
.
value
- The margin settings of this Watermark
.public final double getHeight()
Gets the desired height of this Watermark
.
Setting this property will also change the value of
SizingType
property to F:SizingType.Absolute
.
Watermark
.public final void setHeight(double value)
Sets the desired height of this Watermark
.
Setting this property will also change the value of
SizingType
property to F:SizingType.Absolute
.
value
- The desired height of this Watermark
.public final double getWidth()
Gets the desired width of this Watermark
.
Setting this property will also change the value of
SizingType
property to F:SizingType.Absolute
.
Watermark
.public final void setWidth(double value)
Sets the desired width of this Watermark
.
Setting this property will also change the value of
SizingType
property to F:SizingType.Absolute
.
value
- The desired width of this Watermark
.public final double getScaleFactor()
Gets a value that defines how watermark size depends on parent size.
public final void setScaleFactor(double value)
Sets a value that defines how watermark size depends on parent size.
value
- The value must be between 0.0 and 1.0.public final int getSizingType()
Gets a value specifying a way watermark should be sized.
public final void setSizingType(int value)
Sets a value specifying a way watermark should be sized.
value
- The sizing type.public final boolean getConsiderParentMargins()
Gets a value indicating whether the watermark size and coordinates are calculated considering parent margins.
public final void setConsiderParentMargins(boolean value)
Sets a value indicating whether the watermark size and coordinates are calculated considering parent margins.
value
- If the value is true, watermark size and coordinates are calculated considering parent margins.
By default, the value is false, parent margins are ignored.