public.javadoc.org.spincast.plugins.watermarker.SpincastImageWatermarkerDefault.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







SpincastImageWatermarkerDefault (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
Class SpincastImageWatermarkerDefault



java.lang.Object


org.spincast.plugins.watermarker.SpincastImageWatermarkerDefault







All Implemented Interfaces:
SpincastImageWatermarker




public class SpincastImageWatermarkerDefault
extends Object
implements SpincastImageWatermarker











Constructor Summary

Constructors 

Constructor and Description


SpincastImageWatermarkerDefault(String text,
                               Color textColor,
                               Color backgroundColor,
                               Font textFont,
                               String imageFilePath,
                               boolean imageFileOnClasspath,
                               SpincastWatermarkPosition position,
                               Integer margin,
                               Float opacity,
                               Integer percentageWidth,
                               Integer borderWidth,
                               Color borderColor,
                               SpincastUtils spincastUtils,
                               SpincastConfig spincastConfig) 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


protected BufferedImage
addBorder(BufferedImage watermarkImg) 


protected BufferedImage
createTextWatermarkBaseImage() 


Color
getBackgroundColor() 


Color
getBorderColor() 


Integer
getBorderWidth() 


protected Font
getDefaultFont() 


protected float
getFontSizeToCreateTextWatermarkBaseImage() 


String
getImageFilePath() 


protected File
getMainTempDir() 


Integer
getMargin() 


float
getOpacity() 


protected String
getOutputType(File targetFile) 


int
getPercentageWidth() 


net.coobird.thumbnailator.geometry.Position
getPosition() 


protected SpincastConfig
getSpincastConfig() 


protected SpincastUtils
getSpincastUtils() 


protected int
getTargetWatermarkImageWidth(BufferedImage originalImage) 


String
getText() 


Color
getTextColor() 


Font
getTextFont() 


protected String
getWatermarkerId() 


protected BufferedImage
getWatermarkImageForWidth(int width) 


protected File
getWatermarkImagesTempDir() 


protected BufferedImage
getWatermarkOriginalImage() 


boolean
isImageFileOnClasspath() 


protected boolean
isImageWatermark() 


protected net.coobird.thumbnailator.geometry.Position
toThumbnailatorPosition(SpincastWatermarkPosition position,
                       Integer margin) 


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



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







Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait














Constructor Detail





SpincastImageWatermarkerDefault
public SpincastImageWatermarkerDefault(@Nullable
                                       String text,
                                       @Nullable
                                       Color textColor,
                                       @Nullable
                                       Color backgroundColor,
                                       @Nullable
                                       Font textFont,
                                       @Nullable
                                       String imageFilePath,
                                       boolean imageFileOnClasspath,
                                       @Nullable
                                       SpincastWatermarkPosition position,
                                       @Nullable
                                       Integer margin,
                                       @Nullable
                                       Float opacity,
                                       @Nullable
                                       Integer percentageWidth,
                                       @Nullable
                                       Integer borderWidth,
                                       @Nullable
                                       Color borderColor,
                                       SpincastUtils spincastUtils,
                                       SpincastConfig spincastConfig)









Method Detail





getWatermarkerId
protected String getWatermarkerId()







getText
public String getText()







getTextColor
public Color getTextColor()







getBackgroundColor
public Color getBackgroundColor()







getTextFont
public Font getTextFont()







getImageFilePath
public String getImageFilePath()







isImageFileOnClasspath
public boolean isImageFileOnClasspath()







getPosition
public net.coobird.thumbnailator.geometry.Position getPosition()







getMargin
public Integer getMargin()







getOpacity
public float getOpacity()







getPercentageWidth
public int getPercentageWidth()







getBorderWidth
public Integer getBorderWidth()







getBorderColor
public Color getBorderColor()







getSpincastUtils
protected SpincastUtils getSpincastUtils()







getSpincastConfig
protected SpincastConfig getSpincastConfig()







toThumbnailatorPosition
protected net.coobird.thumbnailator.geometry.Position toThumbnailatorPosition(SpincastWatermarkPosition position,
                                                                              Integer margin)







getMainTempDir
protected File getMainTempDir()







getWatermarkImagesTempDir
protected File getWatermarkImagesTempDir()







isImageWatermark
protected boolean isImageWatermark()







getDefaultFont
protected Font getDefaultFont()







createTextWatermarkBaseImage
protected BufferedImage createTextWatermarkBaseImage()







getFontSizeToCreateTextWatermarkBaseImage
protected float getFontSizeToCreateTextWatermarkBaseImage()







getWatermarkOriginalImage
protected BufferedImage getWatermarkOriginalImage()







getWatermarkImageForWidth
protected BufferedImage getWatermarkImageForWidth(int width)







addBorder
protected BufferedImage addBorder(BufferedImage watermarkImg)







getTargetWatermarkImageWidth
protected int getTargetWatermarkImageWidth(BufferedImage originalImage)







watermark
public void watermark(String originalImagePath,
                      File targetFile)
Description copied from interface: SpincastImageWatermarker
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.

Specified by:
watermark in interface SpincastImageWatermarker
targetFile - The file where the watermarked version will
 be saved. If this file already exists, it is overwritten.








watermark
public void watermark(String originalImagePath,
                      boolean onClasspath,
                      File targetFile)
Description copied from interface: SpincastImageWatermarker
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.

Specified by:
watermark in interface SpincastImageWatermarker
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.








getOutputType
protected String getOutputType(File targetFile)













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
`protected BufferedImage`	`addBorder(BufferedImage watermarkImg)`
`protected BufferedImage`	`createTextWatermarkBaseImage()`
`Color`	`getBackgroundColor()`
`Color`	`getBorderColor()`
`Integer`	`getBorderWidth()`
`protected Font`	`getDefaultFont()`
`protected float`	`getFontSizeToCreateTextWatermarkBaseImage()`
`String`	`getImageFilePath()`
`protected File`	`getMainTempDir()`
`Integer`	`getMargin()`
`float`	`getOpacity()`
`protected String`	`getOutputType(File targetFile)`
`int`	`getPercentageWidth()`
`net.coobird.thumbnailator.geometry.Position`	`getPosition()`
`protected SpincastConfig`	`getSpincastConfig()`
`protected SpincastUtils`	`getSpincastUtils()`
`protected int`	`getTargetWatermarkImageWidth(BufferedImage originalImage)`
`String`	`getText()`
`Color`	`getTextColor()`
`Font`	`getTextFont()`
`protected String`	`getWatermarkerId()`
`protected BufferedImage`	`getWatermarkImageForWidth(int width)`
`protected File`	`getWatermarkImagesTempDir()`
`protected BufferedImage`	`getWatermarkOriginalImage()`
`boolean`	`isImageFileOnClasspath()`
`protected boolean`	`isImageWatermark()`
`protected net.coobird.thumbnailator.geometry.Position`	`toThumbnailatorPosition(SpincastWatermarkPosition position, Integer margin)`
`void`	`watermark(String originalImagePath, boolean onClasspath, File targetFile)` Watermark an image.
`void`	`watermark(String originalImagePath, File targetFile)` Watermark an image.