public class Watermarker extends Processor
mResultDocument| Modifier and Type | Method and Description |
|---|---|
protected void |
checkArgumentsSet() |
static Watermarker |
create(WatermarkerContext context)
Creates new instance of the watermarker processor.
|
protected void |
executeCore() |
static void |
setImage(java.io.InputStream inputStream,
java.io.OutputStream outputStream,
int saveFormat,
java.awt.image.BufferedImage watermarkImage) |
static void |
setImage(java.io.InputStream inputStream,
java.io.OutputStream outputStream,
int saveFormat,
java.awt.image.BufferedImage watermarkImage,
ImageWatermarkOptions options) |
static void |
setImage(java.io.InputStream inputStream,
java.io.OutputStream outputStream,
int saveFormat,
java.io.InputStream watermarkImageStream) |
static void |
setImage(java.io.InputStream inputStream,
java.io.OutputStream outputStream,
int saveFormat,
java.io.InputStream watermarkImageStream,
ImageWatermarkOptions options) |
static void |
setImage(java.io.InputStream inputStream,
java.io.OutputStream outputStream,
SaveOptions saveOptions,
java.awt.image.BufferedImage watermarkImage) |
static void |
setImage(java.io.InputStream inputStream,
java.io.OutputStream outputStream,
SaveOptions saveOptions,
java.awt.image.BufferedImage watermarkImage,
ImageWatermarkOptions options) |
static void |
setImage(java.io.InputStream inputStream,
java.io.OutputStream outputStream,
SaveOptions saveOptions,
java.io.InputStream watermarkImageStream) |
static void |
setImage(java.io.InputStream inputStream,
java.io.OutputStream outputStream,
SaveOptions saveOptions,
java.io.InputStream watermarkImageStream,
ImageWatermarkOptions options) |
static void |
setImage(java.lang.String inputFileName,
java.lang.String outputFileName,
int saveFormat,
java.lang.String watermarkImageFileName) |
static void |
setImage(java.lang.String inputFileName,
java.lang.String outputFileName,
int saveFormat,
java.lang.String watermarkImageFileName,
ImageWatermarkOptions options) |
static void |
setImage(java.lang.String inputFileName,
java.lang.String outputFileName,
SaveOptions saveOptions,
java.lang.String watermarkImageFileName) |
static void |
setImage(java.lang.String inputFileName,
java.lang.String outputFileName,
SaveOptions saveOptions,
java.lang.String watermarkImageFileName,
ImageWatermarkOptions options)
Adds an image watermark into the document with options and specified save format.
|
static void |
setImage(java.lang.String inputFileName,
java.lang.String outputFileName,
java.lang.String watermarkImageFileName)
Adds an image watermark into the document.
|
static void |
setImage(java.lang.String inputFileName,
java.lang.String outputFileName,
java.lang.String watermarkImageFileName,
ImageWatermarkOptions options)
Adds an image watermark into the document with options.
|
static void |
setText(java.io.InputStream inputStream,
java.io.OutputStream outputStream,
int saveFormat,
java.lang.String watermarkText) |
static void |
setText(java.io.InputStream inputStream,
java.io.OutputStream outputStream,
int saveFormat,
java.lang.String watermarkText,
TextWatermarkOptions options) |
static void |
setText(java.io.InputStream inputStream,
java.io.OutputStream outputStream,
SaveOptions saveOptions,
java.lang.String watermarkText) |
static void |
setText(java.io.InputStream inputStream,
java.io.OutputStream outputStream,
SaveOptions saveOptions,
java.lang.String watermarkText,
TextWatermarkOptions options) |
static void |
setText(java.lang.String inputFileName,
java.lang.String outputFileName,
int saveFormat,
java.lang.String watermarkText) |
static void |
setText(java.lang.String inputFileName,
java.lang.String outputFileName,
int saveFormat,
java.lang.String watermarkText,
TextWatermarkOptions options) |
static void |
setText(java.lang.String inputFileName,
java.lang.String outputFileName,
SaveOptions saveOptions,
java.lang.String watermarkText) |
static void |
setText(java.lang.String inputFileName,
java.lang.String outputFileName,
SaveOptions saveOptions,
java.lang.String watermarkText,
TextWatermarkOptions options)
Adds a text watermark into the document with options and specified save format.
|
static void |
setText(java.lang.String inputFileName,
java.lang.String outputFileName,
java.lang.String watermarkText)
Adds a text watermark into the document.
|
static void |
setText(java.lang.String inputFileName,
java.lang.String outputFileName,
java.lang.String watermarkText,
TextWatermarkOptions options)
Adds a text watermark into the document with options.
|
static java.io.OutputStream[] |
setWatermarkToImages(java.io.InputStream inputStream,
ImageSaveOptions saveOptions,
java.io.InputStream watermarkImageStream) |
static java.io.OutputStream[] |
setWatermarkToImages(java.io.InputStream inputStream,
ImageSaveOptions saveOptions,
java.io.InputStream watermarkImageStream,
ImageWatermarkOptions options)
Adds an image watermark into the document with options.
|
static java.io.OutputStream[] |
setWatermarkToImages(java.io.InputStream inputStream,
ImageSaveOptions saveOptions,
java.lang.String watermarkText) |
static java.io.OutputStream[] |
setWatermarkToImages(java.io.InputStream inputStream,
ImageSaveOptions saveOptions,
java.lang.String watermarkText,
TextWatermarkOptions options)
Adds a text watermark into the document with options.
|
static java.io.OutputStream[] |
setWatermarkToImages(java.lang.String inputFileName,
ImageSaveOptions saveOptions,
byte[] watermarkImageBytes) |
static java.io.OutputStream[] |
setWatermarkToImages(java.lang.String inputFileName,
ImageSaveOptions saveOptions,
byte[] watermarkImageBytes,
ImageWatermarkOptions options)
Adds an image watermark into the document with options.
|
static java.io.OutputStream[] |
setWatermarkToImages(java.lang.String inputFileName,
ImageSaveOptions saveOptions,
java.lang.String watermarkText) |
static java.io.OutputStream[] |
setWatermarkToImages(java.lang.String inputFileName,
ImageSaveOptions saveOptions,
java.lang.String watermarkText,
TextWatermarkOptions options)
Adds a text watermark into the document with options.
|
public static Watermarker create(WatermarkerContext context)
Examples:
Shows how to insert watermark text to the document using context.
String doc = getMyDir() + "Big document.docx";
String watermarkText = "This is a watermark";
WatermarkerContext watermarkerContext = new WatermarkerContext();
watermarkerContext.setTextWatermark(watermarkText);
watermarkerContext.getTextWatermarkOptions().setColor(Color.RED);
Watermarker.create(watermarkerContext)
.from(doc)
.to(getArtifactsDir() + "LowCode.WatermarkContextText.docx")
.execute();
Shows how to insert watermark image to the document using context.
String doc = getMyDir() + "Document.docx";
String watermarkImage = getImageDir() + "Logo.jpg";
WatermarkerContext watermarkerContext = new WatermarkerContext();
watermarkerContext.setImageWatermark(Files.readAllBytes(Paths.get(watermarkImage)));
watermarkerContext.getImageWatermarkOptions().setScale(50.0);
Watermarker.create(watermarkerContext)
.from(doc)
.to(getArtifactsDir() + "LowCode.WatermarkContextImage.docx")
.execute();
Shows how to insert watermark text to the document from the stream using context.
String watermarkText = "This is a watermark";
try (FileInputStream streamIn = new FileInputStream(getMyDir() + "Document.docx")) {
WatermarkerContext watermarkerContext = new WatermarkerContext();
watermarkerContext.setTextWatermark(watermarkText);
watermarkerContext.getTextWatermarkOptions().setColor(Color.RED);
try (FileOutputStream streamOut = new FileOutputStream(getArtifactsDir() + "LowCode.WatermarkContextTextStream.docx")) {
Watermarker.create(watermarkerContext)
.from(streamIn)
.to(streamOut, SaveFormat.DOCX)
.execute();
}
}
Shows how to insert watermark image to the document from a stream using context.
String watermarkImage = getImageDir() + "Logo.jpg";
try (FileInputStream streamIn = new FileInputStream(getMyDir() + "Document.docx")) {
WatermarkerContext watermarkerContext = new WatermarkerContext();
watermarkerContext.setImageWatermark(Files.readAllBytes(Paths.get(watermarkImage)));
watermarkerContext.getImageWatermarkOptions().setScale(50.0);
try (FileOutputStream streamOut = new FileOutputStream(getArtifactsDir() + "LowCode.WatermarkContextImageStream.docx")) {
Watermarker.create(watermarkerContext)
.from(streamIn)
.to(streamOut, SaveFormat.DOCX)
.execute();
}
}
protected void executeCore()
throws java.lang.Exception
executeCore in class Processorjava.lang.Exceptionprotected void checkArgumentsSet()
checkArgumentsSet in class Processorpublic static void setText(java.lang.String inputFileName,
java.lang.String outputFileName,
java.lang.String watermarkText)
throws java.lang.Exception
Remarks:
If the output format is an image (BMP, EMF, EPS, GIF, JPEG, PNG, or WebP), each page of the output will be saved as a separate file. The specified output file name will be used to generate file names for each part following the rule: outputFile_partIndex.extension.
If the output format is TIFF, the output will be saved as a single multi-frame TIFF file.
inputFileName - The input file name.outputFileName - The output file name.watermarkText - Text that is displayed as a watermark.java.lang.Exceptionpublic static void setText(java.lang.String inputFileName,
java.lang.String outputFileName,
java.lang.String watermarkText,
TextWatermarkOptions options)
throws java.lang.Exception
Remarks:
If the output format is an image (BMP, EMF, EPS, GIF, JPEG, PNG, or WebP), each page of the output will be saved as a separate file. The specified output file name will be used to generate file names for each part following the rule: outputFile_partIndex.extension.
If the output format is TIFF, the output will be saved as a single multi-frame TIFF file.
Examples:
Shows how to insert watermark text to the document.
String doc = getMyDir() + "Big document.docx";
String watermarkText = "This is a watermark";
Watermarker.setText(doc, getArtifactsDir() + "LowCode.WatermarkText.1.docx", watermarkText);
Watermarker.setText(doc, getArtifactsDir() + "LowCode.WatermarkText.2.docx", SaveFormat.DOCX, watermarkText);
TextWatermarkOptions options = new TextWatermarkOptions();
options.setColor(Color.RED);
Watermarker.setText(doc, getArtifactsDir() + "LowCode.WatermarkText.3.docx", watermarkText, options);
Watermarker.setText(doc, getArtifactsDir() + "LowCode.WatermarkText.4.docx", SaveFormat.DOCX, watermarkText, options);
inputFileName - The input file name.outputFileName - The output file name.watermarkText - Text that is displayed as a watermark.options - Defines additional options for the text watermark.java.lang.Exceptionpublic static void setText(java.lang.String inputFileName,
java.lang.String outputFileName,
int saveFormat,
java.lang.String watermarkText)
throws java.lang.Exception
java.lang.Exceptionpublic static void setText(java.lang.String inputFileName,
java.lang.String outputFileName,
int saveFormat,
java.lang.String watermarkText,
TextWatermarkOptions options)
throws java.lang.Exception
java.lang.Exceptionpublic static void setText(java.lang.String inputFileName,
java.lang.String outputFileName,
SaveOptions saveOptions,
java.lang.String watermarkText)
throws java.lang.Exception
java.lang.Exceptionpublic static void setText(java.lang.String inputFileName,
java.lang.String outputFileName,
SaveOptions saveOptions,
java.lang.String watermarkText,
TextWatermarkOptions options)
throws java.lang.Exception
Remarks:
If the output format is an image (BMP, EMF, EPS, GIF, JPEG, PNG, or WebP), each page of the output will be saved as a separate file. The specified output file name will be used to generate file names for each part following the rule: outputFile_partIndex.extension.
If the output format is TIFF, the output will be saved as a single multi-frame TIFF file.
inputFileName - The input file name.outputFileName - The output file name.saveOptions - The save options.watermarkText - Text that is displayed as a watermark.options - Defines additional options for the text watermark.java.lang.Exceptionpublic static void setText(java.io.InputStream inputStream,
java.io.OutputStream outputStream,
int saveFormat,
java.lang.String watermarkText)
throws java.lang.Exception
java.lang.Exceptionpublic static void setText(java.io.InputStream inputStream,
java.io.OutputStream outputStream,
int saveFormat,
java.lang.String watermarkText,
TextWatermarkOptions options)
throws java.lang.Exception
java.lang.Exceptionpublic static void setText(java.io.InputStream inputStream,
java.io.OutputStream outputStream,
SaveOptions saveOptions,
java.lang.String watermarkText)
throws java.lang.Exception
java.lang.Exceptionpublic static void setText(java.io.InputStream inputStream,
java.io.OutputStream outputStream,
SaveOptions saveOptions,
java.lang.String watermarkText,
TextWatermarkOptions options)
throws java.lang.Exception
java.lang.Exceptionpublic static void setImage(java.lang.String inputFileName,
java.lang.String outputFileName,
java.lang.String watermarkImageFileName)
throws java.lang.Exception
Remarks:
If the output format is an image (BMP, EMF, EPS, GIF, JPEG, PNG, or WebP), each page of the output will be saved as a separate file. The specified output file name will be used to generate file names for each part following the rule: outputFile_partIndex.extension.
If the output format is TIFF, the output will be saved as a single multi-frame TIFF file.
inputFileName - The input file name.outputFileName - The output file name.watermarkImageFileName - Image that is displayed as a watermark.java.lang.Exceptionpublic static void setImage(java.lang.String inputFileName,
java.lang.String outputFileName,
java.lang.String watermarkImageFileName,
ImageWatermarkOptions options)
throws java.lang.Exception
Remarks:
If the output format is an image (BMP, EMF, EPS, GIF, JPEG, PNG, or WebP), each page of the output will be saved as a separate file. The specified output file name will be used to generate file names for each part following the rule: outputFile_partIndex.extension.
If the output format is TIFF, the output will be saved as a single multi-frame TIFF file.
Examples:
Shows how to insert watermark image to the document.
String doc = getMyDir() + "Document.docx";
String watermarkImage = getImageDir() + "Logo.jpg";
Watermarker.setImage(doc, getArtifactsDir() + "LowCode.SetWatermarkImage.1.docx", watermarkImage);
Watermarker.setImage(doc, getArtifactsDir() + "LowCode.SetWatermarkText.2.docx", SaveFormat.DOCX, watermarkImage);
ImageWatermarkOptions options = new ImageWatermarkOptions();
options.setScale(50.0);
Watermarker.setImage(doc, getArtifactsDir() + "LowCode.SetWatermarkText.3.docx", watermarkImage, options);
Watermarker.setImage(doc, getArtifactsDir() + "LowCode.SetWatermarkText.4.docx", SaveFormat.DOCX, watermarkImage, options);
inputFileName - The input file name.outputFileName - The output file name.watermarkImageFileName - Image that is displayed as a watermark.options - Defines additional options for the image watermark.java.lang.Exceptionpublic static void setImage(java.lang.String inputFileName,
java.lang.String outputFileName,
int saveFormat,
java.lang.String watermarkImageFileName)
throws java.lang.Exception
java.lang.Exceptionpublic static void setImage(java.lang.String inputFileName,
java.lang.String outputFileName,
int saveFormat,
java.lang.String watermarkImageFileName,
ImageWatermarkOptions options)
throws java.lang.Exception
java.lang.Exceptionpublic static void setImage(java.lang.String inputFileName,
java.lang.String outputFileName,
SaveOptions saveOptions,
java.lang.String watermarkImageFileName)
throws java.lang.Exception
java.lang.Exceptionpublic static void setImage(java.lang.String inputFileName,
java.lang.String outputFileName,
SaveOptions saveOptions,
java.lang.String watermarkImageFileName,
ImageWatermarkOptions options)
throws java.lang.Exception
Remarks:
If the output format is an image (BMP, EMF, EPS, GIF, JPEG, PNG, or WebP), each page of the output will be saved as a separate file. The specified output file name will be used to generate file names for each part following the rule: outputFile_partIndex.extension.
If the output format is TIFF, the output will be saved as a single multi-frame TIFF file.
inputFileName - The input file name.outputFileName - The output file name.saveOptions - The save options.watermarkImageFileName - Image that is displayed as a watermark.options - Defines additional options for the image watermark.java.lang.Exceptionpublic static void setImage(java.io.InputStream inputStream,
java.io.OutputStream outputStream,
int saveFormat,
java.awt.image.BufferedImage watermarkImage)
throws java.lang.Exception
java.lang.Exceptionpublic static void setImage(java.io.InputStream inputStream,
java.io.OutputStream outputStream,
int saveFormat,
java.awt.image.BufferedImage watermarkImage,
ImageWatermarkOptions options)
throws java.lang.Exception
java.lang.Exceptionpublic static void setImage(java.io.InputStream inputStream,
java.io.OutputStream outputStream,
SaveOptions saveOptions,
java.awt.image.BufferedImage watermarkImage)
throws java.lang.Exception
java.lang.Exceptionpublic static void setImage(java.io.InputStream inputStream,
java.io.OutputStream outputStream,
SaveOptions saveOptions,
java.awt.image.BufferedImage watermarkImage,
ImageWatermarkOptions options)
throws java.lang.Exception
java.lang.Exceptionpublic static void setImage(java.io.InputStream inputStream,
java.io.OutputStream outputStream,
int saveFormat,
java.io.InputStream watermarkImageStream)
throws java.lang.Exception
java.lang.Exceptionpublic static void setImage(java.io.InputStream inputStream,
java.io.OutputStream outputStream,
int saveFormat,
java.io.InputStream watermarkImageStream,
ImageWatermarkOptions options)
throws java.lang.Exception
java.lang.Exceptionpublic static void setImage(java.io.InputStream inputStream,
java.io.OutputStream outputStream,
SaveOptions saveOptions,
java.io.InputStream watermarkImageStream)
throws java.lang.Exception
java.lang.Exceptionpublic static void setImage(java.io.InputStream inputStream,
java.io.OutputStream outputStream,
SaveOptions saveOptions,
java.io.InputStream watermarkImageStream,
ImageWatermarkOptions options)
throws java.lang.Exception
java.lang.Exceptionpublic static java.io.OutputStream[] setWatermarkToImages(java.lang.String inputFileName,
ImageSaveOptions saveOptions,
java.lang.String watermarkText)
throws java.lang.Exception
java.lang.Exceptionpublic static java.io.OutputStream[] setWatermarkToImages(java.lang.String inputFileName,
ImageSaveOptions saveOptions,
java.lang.String watermarkText,
TextWatermarkOptions options)
throws java.lang.Exception
Examples:
Shows how to insert watermark text to the document and save result to images.
String doc = getMyDir() + "Big document.docx";
String watermarkText = "This is a watermark";
OutputStream[] images = Watermarker.setWatermarkToImages(doc, new ImageSaveOptions(SaveFormat.PNG), watermarkText);
TextWatermarkOptions watermarkOptions = new TextWatermarkOptions();
watermarkOptions.setColor(Color.RED);
images = Watermarker.setWatermarkToImages(doc, new ImageSaveOptions(SaveFormat.PNG), watermarkText, watermarkOptions);
inputFileName - The input file name.saveOptions - The save options.watermarkText - Text that is displayed as a watermark.options - Defines additional options for the text watermark.java.lang.Exceptionpublic static java.io.OutputStream[] setWatermarkToImages(java.io.InputStream inputStream,
ImageSaveOptions saveOptions,
java.lang.String watermarkText)
throws java.lang.Exception
java.lang.Exceptionpublic static java.io.OutputStream[] setWatermarkToImages(java.io.InputStream inputStream,
ImageSaveOptions saveOptions,
java.lang.String watermarkText,
TextWatermarkOptions options)
throws java.lang.Exception
Examples:
Shows how to insert watermark text to the document from the stream and save result to images.
String watermarkText = "This is a watermark";
try (FileInputStream streamIn = new FileInputStream(getMyDir() + "Document.docx")) {
OutputStream[] images = Watermarker.setWatermarkToImages(streamIn, new ImageSaveOptions(SaveFormat.PNG), watermarkText);
TextWatermarkOptions watermarkOptions = new TextWatermarkOptions();
watermarkOptions.setColor(Color.RED);
images = Watermarker.setWatermarkToImages(streamIn, new ImageSaveOptions(SaveFormat.PNG), watermarkText, watermarkOptions);
}
inputStream - The input file stream.saveOptions - The save options.watermarkText - Text that is displayed as a watermark.options - Defines additional options for the text watermark.java.lang.Exceptionpublic static java.io.OutputStream[] setWatermarkToImages(java.lang.String inputFileName,
ImageSaveOptions saveOptions,
byte[] watermarkImageBytes)
throws java.lang.Exception
java.lang.Exceptionpublic static java.io.OutputStream[] setWatermarkToImages(java.lang.String inputFileName,
ImageSaveOptions saveOptions,
byte[] watermarkImageBytes,
ImageWatermarkOptions options)
throws java.lang.Exception
Examples:
Shows how to insert watermark image to the document and save result to images.
String doc = getMyDir() + "Document.docx";
String watermarkImage = getImageDir() + "Logo.jpg";
Path watermarkImagePath = Paths.get(watermarkImage);
Watermarker.setWatermarkToImages(doc, new ImageSaveOptions(SaveFormat.PNG), Files.readAllBytes(watermarkImagePath));
ImageWatermarkOptions options = new ImageWatermarkOptions();
options.setScale(50.0);
Watermarker.setWatermarkToImages(doc, new ImageSaveOptions(SaveFormat.PNG), Files.readAllBytes(watermarkImagePath), options);
inputFileName - The input file name.saveOptions - The save options.watermarkImageBytes - Image bytes that is displayed as a watermark.options - Defines additional options for the image watermark.java.lang.Exceptionpublic static java.io.OutputStream[] setWatermarkToImages(java.io.InputStream inputStream,
ImageSaveOptions saveOptions,
java.io.InputStream watermarkImageStream)
throws java.lang.Exception
java.lang.Exceptionpublic static java.io.OutputStream[] setWatermarkToImages(java.io.InputStream inputStream,
ImageSaveOptions saveOptions,
java.io.InputStream watermarkImageStream,
ImageWatermarkOptions options)
throws java.lang.Exception
Examples:
Shows how to insert watermark image to the document from a stream and save result to images.
String watermarkImage = getImageDir() + "Logo.jpg";
try (FileInputStream streamIn = new FileInputStream(getMyDir() + "Document.docx")) {
try (FileInputStream imageStream = new FileInputStream(watermarkImage)) {
Watermarker.setWatermarkToImages(streamIn, new ImageSaveOptions(SaveFormat.PNG), imageStream);
ImageWatermarkOptions options = new ImageWatermarkOptions();
options.setScale(50.0);
Watermarker.setWatermarkToImages(streamIn, new ImageSaveOptions(SaveFormat.PNG), imageStream, options);
}
}
inputStream - The input stream.saveOptions - The save options.watermarkImageStream - Image stream that is displayed as a watermark.options - Defines additional options for the image watermark.java.lang.Exception