DynamicPDF by ceTe Software

com.cete.dynamicpdf.pageelements
Class Watermark

java.lang.Object
  extended by com.cete.dynamicpdf.PageElement
      extended by com.cete.dynamicpdf.pageelements.TaggablePageElement
          extended by com.cete.dynamicpdf.pageelements.Watermark
All Implemented Interfaces:
IAnnotation
Direct Known Subclasses:
ImageWatermark, TextWatermark

public abstract class Watermark
extends TaggablePageElement
implements IAnnotation

Base class from which TextWatermark and ImageWatermark are derived.


Constructor Summary
Watermark()
           
 
Method Summary
 void draw(PageWriter writer)
          Draws the link to the given PageWriter object.
 void drawAnnotation(DocumentWriter writer)
          Draws the watermark to the given DocumentWriter object.
 java.lang.String getAlternateName()
          Gets the Alternate name of the watermark.
 float getAngle()
          Gets the Angle of the watermark.
 java.lang.String getName()
          Gets the name of the watermark.
 float getOpacity()
          Gets the Opacity of the watermark.
 WatermarkPosition getPosition()
          Gets the Position of the watermark.
 float getXOffset()
          Gets the Horizontal Distance of the watermark.
 float getYOffset()
          Gets the Vertical Distance of the watermark.
 void setAlternateName(java.lang.String value)
          Sets the Alternate name of the watermark.
 void setAngle(float value)
          Sets the Angle of the watermark.
 void setName(java.lang.String value)
          Sets the name of the watermark.
 void setOpacity(float value)
          Sets the Opacity of the watermark.
 void setPosition(WatermarkPosition value)
          Sets the Position of the watermark.
 void setXOffset(float value)
          Sets the Horizontal Distance of the watermark.
 void setYOffset(float value)
          Sets the Vertical Distance of the watermark.
 
Methods inherited from class com.cete.dynamicpdf.pageelements.TaggablePageElement
getTag, getTagOrder, setTag, setTagOrder
 
Methods inherited from class com.cete.dynamicpdf.PageElement
getRequiredLicenseLevel, getStrID, setRequiredLicenseLevel, setStrID
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Watermark

public Watermark()
Method Detail

getName

public java.lang.String getName()
Gets the name of the watermark.

Returns:
the name of the watermark.

setName

public void setName(java.lang.String value)
Sets the name of the watermark.

Parameters:
value - the name of the watermark.

getAlternateName

public java.lang.String getAlternateName()
Gets the Alternate name of the watermark.

Returns:
the Alternate name of the watermark.

setAlternateName

public void setAlternateName(java.lang.String value)
Sets the Alternate name of the watermark.

Parameters:
value - the Alternate name of the watermark.

getXOffset

public float getXOffset()
Gets the Horizontal Distance of the watermark.

Returns:
the Horizontal Distance of the watermark.

setXOffset

public void setXOffset(float value)
Sets the Horizontal Distance of the watermark.

Parameters:
value - the Horizontal Distance of the watermark.

getYOffset

public float getYOffset()
Gets the Vertical Distance of the watermark.

Returns:
the Vertical Distance of the watermark.

setYOffset

public void setYOffset(float value)
Sets the Vertical Distance of the watermark.

Parameters:
value - the Vertical Distance of the watermark.

getPosition

public WatermarkPosition getPosition()
Gets the Position of the watermark.

Returns:
the Position of the watermark.

setPosition

public void setPosition(WatermarkPosition value)
Sets the Position of the watermark.

Parameters:
value - the Position of the watermark.

getAngle

public float getAngle()
Gets the Angle of the watermark.

Returns:
the Angle of the watermark.

setAngle

public void setAngle(float value)
Sets the Angle of the watermark.

Parameters:
value - the Angle of the watermark.

getOpacity

public float getOpacity()
Gets the Opacity of the watermark.

Returns:
the Opacity of the watermark.

setOpacity

public void setOpacity(float value)
Sets the Opacity of the watermark.

Parameters:
value - the Opacity of the watermark.

draw

public void draw(PageWriter writer)
Draws the link to the given PageWriter object.

Overrides:
draw in class TaggablePageElement
Parameters:
writer - PageWriter object to receive the watermark's output.
See Also:
PageWriter

drawAnnotation

public void drawAnnotation(DocumentWriter writer)
Draws the watermark to the given DocumentWriter object.

Specified by:
drawAnnotation in interface IAnnotation
Parameters:
writer - DocumentWriter object to receive the watermark's output.
See Also:
DocumentWriter

DynamicPDF by ceTe Software

API Reference for DynamicPDF v10.07 for Java generated on Aug 12, 2020
© Copyright 2020, ceTe Software