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

A boolean specifying whether this watermark is a FixedPrint watermark. FixedPrint watermarks maintain their size and position regardless of the dimensions of the target media.

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

The horizontal offset value to be used when adding the watermark on a page. If percentageVals is true, this value is a percentage of the page width, with 1.0 meaning 100%. Otherwise this value is in user units.

getOpacity

float getOpacity()

Returns:

float

The opacity to be used when adding the watermark, with 0.0 meaning fully transparent and 1.0 meaning fully opaque.

getPercentageVals

boolean getPercentageVals()

Returns:

boolean

A boolean specifying the units of horizValue and vertValue. If it is true, horizValue and vertValue represent percentages of the page dimensions. Otherwise horizValue and vertValue are in user units.

getRotation

float getRotation()

Returns:

float

The counter-clockwise rotation, in degrees, to be used when adding the watermark.

getScale

float getScale()

Returns:

float

The scale factor to be used when adding the watermark, with 1.0 meaning 100%.

getShowOnPrint

boolean getShowOnPrint()

Returns:

boolean

A boolean specifying whether the watermark should be printed.

getShowOnScreen

boolean getShowOnScreen()

Returns:

boolean

A boolean specifying whether the watermark should be visible when viewing on screen.

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

The vertical offset value to be used when adding the watermark on a page. If percentageVals is true, this value is a percentage of the page height, with 1.0 meaning 100%. Otherwise this value is in user units.

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

A boolean specifying where in the page z-order the watermark should be added. If it is true, the watermark is added to the front of the page; otherwise, it is added as a background.

This parameter is ignored if fixedPrint is true, as all FixedPrint watermarks are added to the front of the page.

setFixedPrint

void setFixedPrint(boolean value)

Parameters

value: boolean

Returns:

void

A boolean specifying whether this watermark is a FixedPrint watermark. FixedPrint watermarks maintain their size and position regardless of the dimensions of the target media.

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

The horizontal offset value to be used when adding the watermark on a page. If percentageVals is true, this value is a percentage of the page width, with 1.0 meaning 100%. Otherwise this value is in user units.

setOpacity

void setOpacity(float value)

Parameters

value: float

Returns:

void

The opacity to be used when adding the watermark, with 0.0 meaning fully transparent and 1.0 meaning fully opaque.

setPercentageVals

void setPercentageVals(boolean value)

Parameters

value: boolean

Returns:

void

A boolean specifying the units of horizValue and vertValue. If it is true, horizValue and vertValue represent percentages of the page dimensions. Otherwise horizValue and vertValue are in user units.

setRotation

void setRotation(float value)

Parameters

value: float

Returns:

void

The counter-clockwise rotation, in degrees, to be used when adding the watermark.

setScale

void setScale(float value)

Parameters

value: float

Returns:

void

The scale factor to be used when adding the watermark, with 1.0 meaning 100%.

setShowOnPrint

void setShowOnPrint(boolean value)

Parameters

value: boolean

Returns:

void

A boolean specifying whether the watermark should be printed.

setShowOnScreen

void setShowOnScreen(boolean value)

Parameters

value: boolean

Returns:

void

A boolean specifying whether the watermark should be visible when viewing on screen.

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

The vertical offset value to be used when adding the watermark on a page. If percentageVals is true, this value is a percentage of the page height, with 1.0 meaning 100%. Otherwise this value is in user units.

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

A boolean specifying where in the page z-order the watermark should be added. If it is true, the watermark is added to the front of the page; otherwise, it is added as a background.

This parameter is ignored if fixedPrint is true, as all FixedPrint watermarks are added to the front of the page.