SpincastImageWatermarkerBuilderDefault (org.spincast:spincast-framework 1.2.0 API)

java.lang.Object
- org.spincast.plugins.watermarker.SpincastImageWatermarkerBuilderDefault

All Implemented Interfaces:: SpincastImageWatermarkerBuilder

public class SpincastImageWatermarkerBuilderDefault
extends Object
implements SpincastImageWatermarkerBuilder

Constructor Summary

Constructors
Constructor and Description

SpincastImageWatermarkerBuilderDefault(SpincastWatermarkerFactory spincastWatermarkerFactory)

Constructors
Constructor and Description
`SpincastImageWatermarkerBuilderDefault(SpincastWatermarkerFactory spincastWatermarkerFactory)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SpincastImageWatermarkerBuilder`	`backgroundColor(Color color)` The background color to use for the watermark.
`SpincastImageWatermarkerBuilder`	`border(int width, Color color)` The border to add around the watermark.
`SpincastImageWatermarker`	`build()` Creates the actual `SpincastImageWatermarker`.
`Color`	`getBackgroundColor()`
`Color`	`getBorderColor()`
`int`	`getBorderWidth()`
`String`	`getImageFilePath()`
`int`	`getMargin()`
`float`	`getOpacity()`
`int`	`getPercentageWidth()`
`SpincastWatermarkPosition`	`getPosition()`
`protected SpincastWatermarkerFactory`	`getSpincastWatermarkerFactory()`
`String`	`getText()`
`Color`	`getTextColor()`
`Font`	`getTextFont()`
`SpincastImageWatermarkerBuilder`	`image(String imageFilePath)` The image on the file system to use as the watermark.
`SpincastImageWatermarkerBuilder`	`image(String imageFilePath, boolean onClasspath)` The image to use as the watermark.
`boolean`	`isImageFileOnClasspath()`
`SpincastImageWatermarkerBuilder`	`opacity(float opacity)` The opacity of the watermark.
`SpincastImageWatermarkerBuilder`	`position(SpincastWatermarkPosition position)` The position where the watermark will be created on the image.
`SpincastImageWatermarkerBuilder`	`position(SpincastWatermarkPosition position, int margin)` The position where the watermark will be created on the image.
`SpincastImageWatermarkerBuilder`	`text(Color color)`
`SpincastImageWatermarkerBuilder`	`text(Color color, Font font)`
`SpincastImageWatermarkerBuilder`	`text(Font font)`
`SpincastImageWatermarkerBuilder`	`text(String text)` The text to use as the watermark.
`SpincastImageWatermarkerBuilder`	`text(String text, Color color)`
`SpincastImageWatermarkerBuilder`	`text(String text, Color color, Font font)`
`SpincastImageWatermarkerBuilder`	`text(String text, Font font)`
`SpincastImageWatermarkerBuilder`	`widthPercent(int percentageWidth)` The width of the watermark.

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

- Constructor Detail
  - SpincastImageWatermarkerBuilderDefault
```
@Inject
public SpincastImageWatermarkerBuilderDefault(SpincastWatermarkerFactory spincastWatermarkerFactory)
```
- Method Detail
  - getSpincastWatermarkerFactory
```
protected SpincastWatermarkerFactory getSpincastWatermarkerFactory()
```
  - 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 SpincastWatermarkPosition getPosition()
```
  - getMargin
```
public int getMargin()
```
  - getOpacity
```
public float getOpacity()
```
  - getPercentageWidth
```
public int getPercentageWidth()
```
  - getBorderWidth
```
public int getBorderWidth()
```
  - getBorderColor
```
public Color getBorderColor()
```
  - text
```
public SpincastImageWatermarkerBuilder text(String text)
```
    Description copied from interface: SpincastImageWatermarkerBuilder
    
    The text to use as the watermark. Calling this will remove any image set using #image(File).
    By default, this text is the root URL of the application (for example: "https://www.example.com").
    
    Specified by:
    
    text in interface SpincastImageWatermarkerBuilder
  - text
```
public SpincastImageWatermarkerBuilder text(String text,
                                            Font font)
```
    Specified by:
    
    text in interface SpincastImageWatermarkerBuilder
  - text
```
public SpincastImageWatermarkerBuilder text(String text,
                                            Color color)
```
    Specified by:
    
    text in interface SpincastImageWatermarkerBuilder
  - text
```
public SpincastImageWatermarkerBuilder text(String text,
                                            Color color,
                                            Font font)
```
    Specified by:
    
    text in interface SpincastImageWatermarkerBuilder
  - text
```
public SpincastImageWatermarkerBuilder text(Color color)
```
    Specified by:
    
    text in interface SpincastImageWatermarkerBuilder
  - text
```
public SpincastImageWatermarkerBuilder text(Color color,
                                            Font font)
```
    Specified by:
    
    text in interface SpincastImageWatermarkerBuilder
  - text
```
public SpincastImageWatermarkerBuilder text(Font font)
```
    Specified by:
    
    text in interface SpincastImageWatermarkerBuilder
  - backgroundColor
```
public SpincastImageWatermarkerBuilder backgroundColor(Color color)
```
    Description copied from interface: SpincastImageWatermarkerBuilder
    
    The background color to use for the watermark. This is only useful when using a text watermark.
    Default to white.
    You can set this to null to get a transparent background!
    
    Specified by:
    
    backgroundColor in interface SpincastImageWatermarkerBuilder
  - image
```
public SpincastImageWatermarkerBuilder image(String imageFilePath)
```
    Description copied from interface: SpincastImageWatermarkerBuilder
    
    The image on the file system to use as the watermark.
    Calling this will remove any text set using {@link #text(String).
    Empty by default.
    
    Specified by:
    
    image in interface SpincastImageWatermarkerBuilder
  - image
```
public SpincastImageWatermarkerBuilder image(String imageFilePath,
                                             boolean onClasspath)
```
    Description copied from interface: SpincastImageWatermarkerBuilder
    
    The image to use as the watermark.
    Calling this will remove any text set using {@link #text(String).
    Empty by default.
    
    Specified by:
    
    image in interface SpincastImageWatermarkerBuilder
    
    onClasspath - if true, the imageFilePath will be considered as a classpath path. Otherwise, the image will be taken from the file system.
  - position
```
public SpincastImageWatermarkerBuilder position(SpincastWatermarkPosition position)
```
    Description copied from interface: SpincastImageWatermarkerBuilder
    
    The position where the watermark will be created on the image. No margin.
    Defaults to .
    
    Specified by:
    
    position in interface SpincastImageWatermarkerBuilder
  - position
```
public SpincastImageWatermarkerBuilder position(SpincastWatermarkPosition position,
                                                int margin)
```
    Description copied from interface: SpincastImageWatermarkerBuilder
    
    The position where the watermark will be created on the image.
    Defaults to .
    
    Specified by:
    
    position in interface SpincastImageWatermarkerBuilder
  - opacity
```
public SpincastImageWatermarkerBuilder opacity(float opacity)
```
    Description copied from interface: SpincastImageWatermarkerBuilder
    
    The opacity of the watermark.
    Between 0.0 and 1.0.
    Defaults to 1.0, no transparency.
    
    Specified by:
    
    opacity in interface SpincastImageWatermarkerBuilder
  - widthPercent
```
public SpincastImageWatermarkerBuilder widthPercent(int percentageWidth)
```
    Description copied from interface: SpincastImageWatermarkerBuilder
    
    The width of the watermark. Must be an integer between 1 and 100.
    Defaults to 50.
    
    Specified by:
    
    widthPercent in interface SpincastImageWatermarkerBuilder
  - border
```
public SpincastImageWatermarkerBuilder border(int width,
                                              Color color)
```
    Description copied from interface: SpincastImageWatermarkerBuilder
    
    The border to add around the watermark.
    Set the widthInPixels to 0 to prevent any border to be added.
    Default to a 5 pixels black border.
    
    Specified by:
    
    border in interface SpincastImageWatermarkerBuilder
    
    color - Can be null: will be black then.
  - build
```
public SpincastImageWatermarker build()
```
    Description copied from interface: SpincastImageWatermarkerBuilder
    
    Creates the actual SpincastImageWatermarker.
    
    Specified by:
    
    build in interface SpincastImageWatermarkerBuilder

Class SpincastImageWatermarkerBuilderDefault

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SpincastImageWatermarkerBuilderDefault

Method Detail

getSpincastWatermarkerFactory

getText

getTextColor

getBackgroundColor

getTextFont

getImageFilePath

isImageFileOnClasspath

getPosition

getMargin

getOpacity

getPercentageWidth

getBorderWidth

getBorderColor

text

text

text

text

text

text

text

backgroundColor

image

image

position

position

opacity

widthPercent

border

build