WatermarkParams Class Documentation
classWatermarkParamsNamespace:com::datalogics::PDFL
Detailed Description
Watermark settings control the appearance of a watermark in a PDF.
Referenced by
Uses types
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
DisposeChildren
voidDisposeChildren()Returns:
void[static initializer]
static void[static initializer]()delete
synchronized voiddelete(Booleandisposing)Parameters
disposing: Boolean
Returns:
synchronized voiddelete
synchronized voiddelete()Returns:
synchronized voidfinalize
voidfinalize()Returns:
voidgetFixedPrint
booleangetFixedPrint()Returns:
booleangetHorizAlign
HorizontalAlignmentgetHorizAlign()Returns:
HorizontalAlignmentGet the horizontal alignment to be used when adding the watermark to a page. Defaults to center alignment.
getHorizValue
floatgetHorizValue()Returns:
floatgetOpacity
floatgetOpacity()Returns:
floatgetPercentageVals
booleangetPercentageVals()Returns:
booleangetRotation
floatgetRotation()Returns:
floatgetScale
floatgetScale()Returns:
floatgetShowOnPrint
booleangetShowOnPrint()Returns:
booleangetShowOnScreen
booleangetShowOnScreen()Returns:
booleangetTargetRange
PageRangegetTargetRange()Returns:
PageRangeThe page range of the document to which the watermark should be added. Defaults to all pages.
getVertAlign
VerticalAlignmentgetVertAlign()Returns:
VerticalAlignmentGet the vertical alignment to be used when adding the watermark to a page. Defaults to center alignment.
getVertValue
floatgetVertValue()Returns:
floatgetWatermarkDrawOption
WatermarkDrawOptiongetWatermarkDrawOption()Returns:
WatermarkDrawOptionGet 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
booleangetZOrderTop()Returns:
booleansetFixedPrint
voidsetFixedPrint(booleanvalue)Parameters
value: boolean
Returns:
voidsetHorizAlign
voidsetHorizAlign(HorizontalAlignmenth)Parameters
h: HorizontalAlignmentThe horizontal alignment value.
Returns:
voidSet the horizontal alignment to be used when adding the watermark to a page.
setHorizValue
voidsetHorizValue(floatvalue)Parameters
value: float
Returns:
voidsetOpacity
voidsetOpacity(floatvalue)Parameters
value: float
Returns:
voidsetPercentageVals
voidsetPercentageVals(booleanvalue)Parameters
value: boolean
Returns:
voidsetRotation
voidsetRotation(floatvalue)Parameters
value: float
Returns:
voidsetScale
voidsetScale(floatvalue)Parameters
value: float
Returns:
voidsetShowOnPrint
voidsetShowOnPrint(booleanvalue)Parameters
value: boolean
Returns:
voidsetShowOnScreen
voidsetShowOnScreen(booleanvalue)Parameters
value: boolean
Returns:
voidsetVertAlign
voidsetVertAlign(VerticalAlignmentv)Parameters
v: VerticalAlignmentThe vertical alignment value.
Returns:
voidSet the vertical alignment to be used when adding the watermark to a page.
setVertValue
voidsetVertValue(floatvalue)Parameters
value: float
Returns:
voidsetWatermarkDrawOption
voidsetWatermarkDrawOption(WatermarkDrawOptiondrawoption)Parameters
drawoption: WatermarkDrawOptionThe watermark draw option.
Returns:
voidSet 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
voidsetZOrderTop(booleanvalue)Parameters
value: boolean
Returns:
void