public.javadoc.org.spincast.plugins.watermarker.SpincastImageWatermarker.html Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of spincast-website Show documentation

Source code for the https://www.spincast.org website.

There is a newer version: 2.2.0







SpincastImageWatermarker (org.spincast:spincast-framework 1.0.0 API)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help

 Spincast Framework Javadoc



Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








org.spincast.plugins.watermarker
Interface SpincastImageWatermarker






All Known Implementing Classes:
SpincastImageWatermarkerDefault




public interface SpincastImageWatermarker











Method Summary

All Methods Instance Methods Abstract Methods 

Modifier and Type
Method and Description


void
watermark(String originalImagePath,
         boolean onClasspath,
         File targetFile)
Watermark an image.



void
watermark(String originalImagePath,
         File targetFile)
Watermark an image.
















Method Detail





watermark
void watermark(String originalImagePath,
               File targetFile)
Watermark an image.
 
 The format of the watermaked image is determined by
 the extension of the targetFile (case-insensitive):
 

 

   
     .jpg or .jpeg => JPEG
   
   
     .gif => GIF
   
   
     .png => PNG
   
 
 
 If the target file doesn't have any extension, PNG is used.

Parameters:
originalImage - The image to watermark, on the file system.
targetFile - The file where the watermarked version will
 be saved. If this file already exists, it is overwritten.








watermark
void watermark(String originalImagePath,
               boolean onClasspath,
               File targetFile)
Watermark an image.
 
 The format of the watermaked image is determined by
 the extension of the targetFile (case-insensitive):
 

 

   
     .jpg or .jpeg => JPEG
   
   
     .gif => GIF
   
   
     .png => PNG
   
 
 
 If the target file doesn't have any extension, PNG is used.

Parameters:
originalImage - The image to watermark.
onClasspath - If true, the original image
 will be taken from the classpath. Otherwise its path must
 be a path on the file system.
targetFile - The file where the watermarked version will
 be saved. If this file already exists, it is overwritten.














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help

 Spincast Framework Javadoc



Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2019. All rights reserved.

Modifier and Type	Method and Description
`void`	`watermark(String originalImagePath, boolean onClasspath, File targetFile)` Watermark an image.
`void`	`watermark(String originalImagePath, File targetFile)` Watermark an image.