WatermarkParams Class Documentation

class WatermarkParams

Namespace:com::datalogics::PDFL

Detailed Description

Watermark settings control the appearance of a watermark in a PDF.

Referenced by

Document

Uses types

PageRange

Constructor & Destructor Documentation

WatermarkParams

WatermarkParams()

Construct default WatermarkParams. Initializes with rotation 0, full page range, opacity 1.0, scale 0.5, zOrderTop true, showOnPrint true, showOnScreen true, centered alignment, and the TryAnnotation draw option.

Member Function Documentation

delete

synchronized void delete(Boolean disposing)

Parameters

disposing: Boolean

Returns:

synchronized void

delete

synchronized void delete()

Returns:

synchronized void

finalize

void finalize()

Returns:

void

getFixedPrint

boolean getFixedPrint()

Returns:

boolean

getHorizAlign

HorizontalAlignment getHorizAlign()

Returns:

HorizontalAlignment

Get the horizontal alignment to be used when adding the watermark to a page. Defaults to center alignment.

getHorizValue

float getHorizValue()

Returns:

float

getOpacity

float getOpacity()

Returns:

float

getPercentageVals

boolean getPercentageVals()

Returns:

boolean

getRotation

float getRotation()

Returns:

float

getScale

float getScale()

Returns:

float

getShowOnPrint

boolean getShowOnPrint()

Returns:

boolean

getShowOnScreen

boolean getShowOnScreen()

Returns:

boolean

getTargetRange

PageRange getTargetRange()

Returns:

PageRange

The page range of the document to which the watermark should be added. Defaults to all pages.

getVertAlign

VerticalAlignment getVertAlign()

Returns:

VerticalAlignment

Get the vertical alignment to be used when adding the watermark to a page. Defaults to center alignment.

getVertValue

float getVertValue()

Returns:

float

getWatermarkDrawOption

WatermarkDrawOption getWatermarkDrawOption()

Returns:

WatermarkDrawOption

Get the draw option to be used when adding the watermark to a page. Controls whether the watermark is drawn as an annotation or form XObject.

getZOrderTop

boolean getZOrderTop()

Returns:

boolean

setFixedPrint

void setFixedPrint(boolean value)

Parameters

value: boolean

Returns:

void

setHorizAlign

void setHorizAlign(HorizontalAlignment h)

Parameters

h: HorizontalAlignment

The horizontal alignment value.

Returns:

void

Set the horizontal alignment to be used when adding the watermark to a page.

setHorizValue

void setHorizValue(float value)

Parameters

value: float

Returns:

void

setOpacity

void setOpacity(float value)

Parameters

value: float

Returns:

void

setPercentageVals

void setPercentageVals(boolean value)

Parameters

value: boolean

Returns:

void

setRotation

void setRotation(float value)

Parameters

value: float

Returns:

void

setScale

void setScale(float value)

Parameters

value: float

Returns:

void

setShowOnPrint

void setShowOnPrint(boolean value)

Parameters

value: boolean

Returns:

void

setShowOnScreen

void setShowOnScreen(boolean value)

Parameters

value: boolean

Returns:

void

setVertAlign

void setVertAlign(VerticalAlignment v)

Parameters

v: VerticalAlignment

The vertical alignment value.

Returns:

void

Set the vertical alignment to be used when adding the watermark to a page.

setVertValue

void setVertValue(float value)

Parameters

value: float

Returns:

void

setWatermarkDrawOption

void setWatermarkDrawOption(WatermarkDrawOption drawoption)

Parameters

drawoption: WatermarkDrawOption

The watermark draw option.

Returns:

void

Set the draw option to be used when adding the watermark to a page. Controls whether the watermark is drawn as an annotation or form XObject.

setZOrderTop

void setZOrderTop(boolean value)

Parameters

value: boolean

Returns:

void