org.sejda.model.parameter

Class WatermarkParameters

java.lang.Object

org.sejda.model.parameter.base.AbstractParameters

org.sejda.model.parameter.base.AbstractPdfOutputParameters

org.sejda.model.parameter.base.MultiplePdfSourceParameters

org.sejda.model.parameter.base.MultiplePdfSourceMultipleOutputParameters

org.sejda.model.parameter.WatermarkParameters

All Implemented Interfaces:

MultiplePdfSourceTaskParameters, PrefixableTaskParameters, SingleOrMultipleOutputTaskParameters, TaskParameters, PageRangeSelection, PagesSelection

public class WatermarkParameters
extends MultiplePdfSourceMultipleOutputParameters
implements PageRangeSelection, PagesSelection

Parameters to set a watermark image on multiple PDF documents

Author:

Andrea Vacondio

Constructor Summary

Constructors

Constructor and Description
WatermarkParameters(Source<?> watermark)

Method Summary

Modifier and Type	Method and Description
void	addAllPageRanges(Collection<PageRange> ranges)
void	addPageRange(PageRange range)
boolean	equals(Object other)
Dimension	getDimension()
Location	getLocation()
int	getOpacity()
Set<Integer>	getPages(int totalNumberOfPage)
Set<PageRange>	getPageSelection()
Point2D	getPosition()
int	getRotationDegrees()
Source<?>	getWatermark()
int	hashCode()
void	setDimension(Dimension dimenstion)
void	setLocation(Location location) Where the watermark image should appear relative to the page content
void	setOpacity(int opacity) The watermark opacity where 0 is invisible and 100 is fully opaque
void	setPosition(Point2D position)
void	setRotationDegrees(int rotationDegrees)

Methods inherited from class org.sejda.model.parameter.base.MultiplePdfSourceMultipleOutputParameters

getOutput, getOutputPrefix, setOutput, setOutputPrefix

Methods inherited from class org.sejda.model.parameter.base.MultiplePdfSourceParameters

addSource, addSources, getSourceList, removeAllSources

Methods inherited from class org.sejda.model.parameter.base.AbstractPdfOutputParameters

getMinRequiredPdfVersion, getVersion, isCompress, setCompress, setVersion

Methods inherited from class org.sejda.model.parameter.base.AbstractParameters

getExistingOutputPolicy, isLenient, setExistingOutputPolicy, setLenient, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.sejda.model.parameter.base.TaskParameters

getExistingOutputPolicy, isLenient, setExistingOutputPolicy, setLenient

Constructor Detail

WatermarkParameters

public WatermarkParameters(Source<?> watermark)

Method Detail

getPageSelection

public Set<PageRange> getPageSelection()

Specified by:

getPageSelection in interface PageRangeSelection

Returns:

an unmodifiable view of the pageSelection

addPageRange

public void addPageRange(PageRange range)

addAllPageRanges

public void addAllPageRanges(Collection<PageRange> ranges)

getPages

public Set<Integer> getPages(int totalNumberOfPage)

Specified by:

getPages in interface PagesSelection

Parameters:

totalNumberOfPage - the number of pages of the document (upper limit).

Returns:

the selected set of pages. Iteration ordering is predictable, it is the order in which elements were inserted into the PageRange set.

See Also:

PagesSelection.getPages(int)

getWatermark

public Source<?> getWatermark()

getOpacity

public int getOpacity()

setOpacity

public void setOpacity(int opacity)

The watermark opacity where 0 is invisible and 100 is fully opaque

Parameters:

opacity -

getLocation

public Location getLocation()

setLocation

public void setLocation(Location location)

Where the watermark image should appear relative to the page content

Parameters:

location -

getPosition

public Point2D getPosition()

setPosition

public void setPosition(Point2D position)

getDimension

public Dimension getDimension()

setDimension

public void setDimension(Dimension dimenstion)

getRotationDegrees

public int getRotationDegrees()

setRotationDegrees

public void setRotationDegrees(int rotationDegrees)

hashCode

public int hashCode()

Overrides:

hashCode in class MultiplePdfSourceMultipleOutputParameters

equals

public boolean equals(Object other)

Overrides:

equals in class MultiplePdfSourceMultipleOutputParameters