com.groupdocs.viewer.options

Class Watermark

java.lang.Object

com.groupdocs.viewer.options.Watermark

public class Watermark
extends Object

Represents a text watermark. For details, see the documentation.

The Watermark class represents a text watermark in the GroupDocs.Viewer component. It is used to define and apply a watermark to the rendered output of documents.

Example usage:

 Watermark watermark = new Watermark("Watermark");
 watermark.setPosition(Position.DIAGONAL);
 watermark.setColor(java.awt.Color.GREEN);
 watermark.setSize(Size.HALF_SIZE);

 PdfViewOptions pdfViewOptions = new PdfViewOptions();
 pdfViewOptions.setWatermark(watermark);

 try (Viewer viewer = new Viewer("document.docx")) {
     viewer.view(pdfViewOptions);
     // Use the viewer object for further operations
 }
 

See Also:

Viewer, PdfViewOptions, Position

Constructor Summary

Constructors

Constructor and Description
Watermark(String text) Initializes a new instance of the Watermark class.

Method Summary

Modifier and Type	Method and Description
Color	getColor() Returns the watermark color.
String	getColorAsHex() Returns the watermark color in hex format.
String	getFontName() Returns the font name used for the watermark.
Position	getPosition() Returns the watermark position.
Size	getSize() Returns the watermark size.
String	getText() Returns the watermark text.
void	setColor(Color value) Sets the watermark color.
void	setColor(String colorName) Sets the watermark color.
void	setFontName(String value) Sets the font name used for the watermark.
void	setPosition(Position value) Sets the watermark position.
void	setSize(Size value) Sets the watermark size.

Methods inherited from class java.lang.Object

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

Constructor Detail

Watermark

public Watermark(String text)

Initializes a new instance of the Watermark class.

Parameters:

text - The watermark text.

Throws:

IllegalArgumentException - Thrown when the text parameter is null or empty.

Method Detail

getColor

public final Color getColor()

Returns the watermark color. This method retrieves the color of the watermark applied to the document.

Note: The default value is the red color obtained from Color.getRed().

Returns:

the watermark color.

getColorAsHex

public final String getColorAsHex()

Returns the watermark color in hex format. This method retrieves the color of the watermark applied to the document.

Note: The default value is the red color obtained from Color.getRed().

Returns:

the watermark color in hex format.

getFontName

public final String getFontName()

Returns the font name used for the watermark.

Returns:

the font name used for the watermark.

getPosition

public final Position getPosition()

Returns the watermark position. This method returns the position of the watermark applied to the document.

Note: The default value is Position.DIAGONAL.

Returns:

the watermark position.

getSize

public final Size getSize()

Returns the watermark size. This method retrieves the size of the watermark applied to the document.

Note: The default value is Size.FULL_SIZE.

Returns:

the watermark size.

getText

public final String getText()

Returns the watermark text. This method retrieves the text of the watermark applied to the document.

Returns:

the watermark text.

setColor

public final void setColor(Color value)

Sets the watermark color. This method sets the color of the watermark applied to the document.

Note: The default value is obtained from Color.getRed().

Parameters:

value - The watermark color to set.

setColor

public final void setColor(String colorName)

Sets the watermark color. This method sets the color of the watermark applied to the document.

Note: The default value is obtained from Color.getRed().

Parameters:

colorName - The watermark color to set.

setFontName

public final void setFontName(String value)

Sets the font name used for the watermark.

Parameters:

value - The font name used for the watermark.

setPosition

public final void setPosition(Position value)

Sets the watermark position. This method sets the position of the watermark applied to the document.

Note: The default value is Position.DIAGONAL.

Parameters:

value - The watermark position.

setSize

public final void setSize(Size value)

Sets the watermark size. This method sets the size of the watermark to be applied to the document.

Note: The default value is Size.FULL_SIZE.

Parameters:

value - The watermark size.