com.groupdocs.watermark.watermarks

Class TextWatermark

java.lang.Object

com.groupdocs.watermark.Watermark

com.groupdocs.watermark.watermarks.TextWatermark

Direct Known Subclasses:

EvaluationWarningWatermark

public class TextWatermark
extends Watermark

Represents a text watermark.

Learn more:

• Adding text watermarks

The following example demonstrates how to scale the text watermark depending on the parent size.

   Watermarker watermarker = new Watermarker("C:\\test.some_ext");
   TextWatermark watermark = new TextWatermark("test watermark", new Font("Arial", 36));

   watermark.setHorizontalAlignment(HorizontalAlignment.Center);
   watermark.setVerticalAlignment(VerticalAlignment.Center);
   watermark.setSizingType(SizingType.ScaleToParentDimensions);
   watermark.setRotateAngle(45);
   watermark.setScaleFactor(0.4);

   watermarker.add(watermark);

   watermarker.save("C:\\modified_test.some_ext");
   watermarker.close();
 

Constructor Summary

Constructors

Constructor and Description
TextWatermark(String text, Font font) Initializes a new instance of the TextWatermark class with a specified text and a font.

Method Summary

Modifier and Type	Method and Description
WatermarkGeometry	createGeometry(ContentPartGeometry parent)
Watermark	deepClone()
Color	getBackgroundColor() Gets the background color of the text.
Color	getBackgroundColorConsideringOpacity()
Font	getFont() Gets the font of the text.
Color	getForegroundColor() Gets the foreground color of the text.
Color	getForegroundColorConsideringOpacity()
Thickness	getPadding() Gets the padding settings of this TextWatermark.
SizeD	getSize()
String	getText() Gets the text to be used as watermark.
int	getTextAlignment() Gets the watermark TextAlignment.
boolean	hasSameValues(Watermark watermark)
boolean	isImageWatermark()
boolean	isTextWatermark()
void	setBackgroundColor(Color value) Sets the background color of the text.
void	setFont(Font value) Sets the font of the text.
void	setForegroundColor(Color value) Sets the foreground color of the text.
void	setPadding(Thickness value) Sets the padding settings of this TextWatermark.
void	setText(String value) Sets the text to be used as watermark.
void	setTextAlignment(int value) Sets the watermark TextAlignment.

Methods inherited from class com.groupdocs.watermark.Watermark

copyPropertiesValues, getConsiderParentMargins, getHeight, getHorizontalAlignment, getMargins, getOpacity, getPagesSetup, getRotateAngle, getScaleFactor, getSizingType, getTileOptions, getTransparency, getVerticalAlignment, getWidth, getX, getY, isBackground, setBackground, setConsiderParentMargins, setHeight, setHorizontalAlignment, setMargins, setOpacity, setPagesSetup, setRotateAngle, setScaleFactor, setSizingType, setTileOptions, setVerticalAlignment, setWidth, setX, setY

Methods inherited from class java.lang.Object

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

Constructor Detail

TextWatermark

public TextWatermark(String text,
                     Font font)

Initializes a new instance of the TextWatermark class with a specified text and a font.

Parameters:

text - The text to be used as watermark.

font - The font of the text.

Method Detail

createGeometry

public WatermarkGeometry createGeometry(ContentPartGeometry parent)

Specified by:

createGeometry in class Watermark

deepClone

public Watermark deepClone()

Specified by:

deepClone in class Watermark

getBackgroundColor

public final Color getBackgroundColor()

Gets the background color of the text.

Returns:

The background color of the text.

getBackgroundColorConsideringOpacity

public final Color getBackgroundColorConsideringOpacity()

getFont

public final Font getFont()

Gets the font of the text.

Returns:

The font of the text.

getForegroundColor

public final Color getForegroundColor()

Gets the foreground color of the text.

Returns:

The foreground color of the text.

getForegroundColorConsideringOpacity

public final Color getForegroundColorConsideringOpacity()

getPadding

public final Thickness getPadding()

Gets the padding settings of this TextWatermark. This property is applicable only to image files.

Returns:

The padding settings of this TextWatermark.

getSize

public SizeD getSize()

Specified by:

getSize in class Watermark

getText

public final String getText()

Gets the text to be used as watermark.

Returns:

The string representing watermark text.

getTextAlignment

public final int getTextAlignment()

Gets the watermark TextAlignment.

Default value is TextAlignment.Left.

Returns:

The watermark TextAlignment.

hasSameValues

public boolean hasSameValues(Watermark watermark)

Overrides:

hasSameValues in class Watermark

isImageWatermark

public boolean isImageWatermark()

Specified by:

isImageWatermark in class Watermark

isTextWatermark

public boolean isTextWatermark()

Specified by:

isTextWatermark in class Watermark

setBackgroundColor

public final void setBackgroundColor(Color value)

Sets the background color of the text.

Parameters:

value - The background color of the text.

setFont

public final void setFont(Font value)

Sets the font of the text.

Parameters:

value - The font of the text.

setForegroundColor

public final void setForegroundColor(Color value)

Sets the foreground color of the text.

Parameters:

value - The foreground color of the text.

setPadding

public final void setPadding(Thickness value)

Sets the padding settings of this TextWatermark. This property is applicable only to image files.

Parameters:

value - The padding settings of this TextWatermark.

setText

public final void setText(String value)

Sets the text to be used as watermark.

Parameters:

value - The string representing watermark text.

setTextAlignment

public final void setTextAlignment(int value)

Sets the watermark TextAlignment.

Default value is TextAlignment.Left.

Parameters:

value - The watermark TextAlignment.