com.compdfkit.core.watermark

Class CPDFWatermark

java.lang.Object

com.compdfkit.core.watermark.CPDFWatermark

Direct Known Subclasses:

CPDFImageWatermark, CPDFTextWatermark

public abstract class CPDFWatermark
extends java.lang.Object

This class is mainly used to construct a watermark with specified parameters, and then insert it to PDF page. The watermark object can be constructed from text, bitmap or image, and PDF page.

See Also:

CPDFImageWatermark, CPDFTextWatermark

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CPDFWatermark.Horizalign Horizontal alignment.
static class	CPDFWatermark.Type Watermark type.
static class	CPDFWatermark.Vertalign Vertical alignment.

Method Summary

Modifier and Type	Method and Description
boolean	clear() Removes watermark.
boolean	create() Not in use
java.lang.String	getFontName() Sets font of text watermark.
float	getFontSize() Gets font size of text watermark.
CPDFWatermark.Horizalign	getHorizalign() Gets watermark horizontal alignment.
float	getHorizOffset() Gets watermark horizontal deviation.
float	getHorizontalSpacing() Gets the horizontal spacing for the tiled watermark.
android.graphics.Bitmap	getImage() Gets watermark appearance.
float	getOpacity() Gets watermark opacity.
java.lang.String	getPages() Gets watermark page range.
float	getRotation() Gets watermark rotation angle.
float	getScale() Gets watermark zoom level.
java.lang.String	getText() Gets content of text watermark.
int	getTextRGBColor() Gets font color of text watermark.
CPDFWatermark.Type	getType()
CPDFWatermark.Vertalign	getVertalign() Gets watermark vertical alignment.
float	getVerticalSpacing() Gets vertical spacing for the tiled watermark.
float	getVertOffset() Gets watermark vertical deviation.
boolean	isFront() Whether watermark is in the front.
boolean	isFullScreen() Whether it is tiled watermark.
boolean	isValid() Whether object is valid, false means the object resource is released, you cannot use the object to call any method.
boolean	release() Releases Watermark object resource.
boolean	saveImage(java.lang.String filePath, java.lang.String smaskPath) Saves watermark appearance as image.
boolean	setFontName(java.lang.String fontName) Sets font of text watermark.
boolean	setFontSize(float fontSize) Sets font size of text watermark.
boolean	setFront(boolean isFront) Sets watermark layer.
boolean	setFullScreen(boolean isFullScreen) Sets tiled watermark.
boolean	setHorizalign(CPDFWatermark.Horizalign horizalign) Sets horizontal alignment.
boolean	setHorizOffset(float horizOffset) Sets horizontal deviation.
boolean	setHorizontalSpacing(float horizontalSpacing) Sets the horizontal spacing for the tiled watermark.
boolean	setImage(android.graphics.Bitmap bitmap, int width, int height) Sets image watermark with Bitmap by pixel.
boolean	setImage(java.lang.String imgPath, java.lang.String smaskPath, int width, int height) Sets image watermark with Bitmap.
boolean	setOpacity(float opacity) Sets opacity.
boolean	setPages(java.lang.String pages) Sets page range of watermark.
boolean	setRotation(float rotation) Sets rotation angle.
boolean	setScale(float scale) Sets zoom level.
boolean	setText(java.lang.String text) Sets content of text watermark.
boolean	setTextRGBColor(int color) Sets font color of text watermark.
boolean	setVertalign(CPDFWatermark.Vertalign vertalign) Sets vertical alignment.
boolean	setVerticalSpacing(float verticalSpacing) Sets vertical spacing for the tiled watermark.
boolean	setVertOffset(float vertOffset) Sets vertical deviation.
boolean	update() Updates watermark.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getType

public CPDFWatermark.Type getType()

setScale

public boolean setScale(float scale)

Sets zoom level.

Parameters:

scale - Zoom level.

Returns:

Returns whether to successfully set zoom level.

setRotation

public boolean setRotation(float rotation)

Sets rotation angle.

Parameters:

rotation - Rotation angle.

Returns:

Returns whether to successfully set rotation angle.

setOpacity

public boolean setOpacity(float opacity)

Sets opacity.

Parameters:

opacity - Opacity.

Returns:

Returns whether to successfully set opacity.

setVertalign

public boolean setVertalign(CPDFWatermark.Vertalign vertalign)

Sets vertical alignment.

Parameters:

vertalign - Vertical alignment.

Returns:

Returns whether to successfully set vertical alignment.

setHorizalign

public boolean setHorizalign(CPDFWatermark.Horizalign horizalign)

Sets horizontal alignment.

Parameters:

horizalign - Horizontal alignment.

Returns:

Returns whether to successfully set horizontal alignment.

setVertOffset

public boolean setVertOffset(float vertOffset)

Sets vertical deviation.

Parameters:

vertOffset - Vertical deviation.

Returns:

Returns whether to successfully set vertical deviation.

setHorizOffset

public boolean setHorizOffset(float horizOffset)

Sets horizontal deviation.

Parameters:

horizOffset - Horizontal deviation.

Returns:

Returns whether to successfully set horizontal deviation.

setPages

public boolean setPages(java.lang.String pages)

Sets page range of watermark. Page range, such as:1,2,3 or 1-3

Parameters:

pages - Page range,such as:1,2,3 or 1-3

Returns:

Returns whether to successfully set page range of watermark.

setFront

public boolean setFront(boolean isFront)

Sets watermark layer. True means watermark is in front of text, false means behind text.

Parameters:

isFront - Whether it is in front of text.

Returns:

Returns whether to successfully set watermark layer.

setFullScreen

public boolean setFullScreen(boolean isFullScreen)

Sets tiled watermark.

Parameters:

isFullScreen - Whether it is tiled watermark.

Returns:

Returns whether to successfully set tiled watermark.

setHorizontalSpacing

public boolean setHorizontalSpacing(float horizontalSpacing)

Sets the horizontal spacing for the tiled watermark.

Parameters:

horizontalSpacing - Horizontal spacing for the tiled watermark.

Returns:

Returns whether to successfully set the horizontal spacing for the tiled watermark.

setVerticalSpacing

public boolean setVerticalSpacing(float verticalSpacing)

Sets vertical spacing for the tiled watermark.

Parameters:

verticalSpacing - Vertical spacing for the tiled watermark.

Returns:

Returns whether to successfully set vertical spacing for the tiled watermark.

getScale

public float getScale()

Gets watermark zoom level.

Returns:

Returns watermark zoom level.

getRotation

public float getRotation()

Gets watermark rotation angle.

Returns:

Returns watermark rotation angle.

getOpacity

public float getOpacity()

Gets watermark opacity.

Returns:

Returns watermark opacity.

getVertalign

public CPDFWatermark.Vertalign getVertalign()

Gets watermark vertical alignment.

Returns:

Return watermark vertical alignment.

getHorizalign

public CPDFWatermark.Horizalign getHorizalign()

Gets watermark horizontal alignment.

Returns:

Returns watermark horizontal alignment.

getVertOffset

public float getVertOffset()

Gets watermark vertical deviation.

Returns:

Returns watermark vertical deviation.

getHorizOffset

public float getHorizOffset()

Gets watermark horizontal deviation.

Returns:

Return watermark horizontal deviation.

getPages

public java.lang.String getPages()

Gets watermark page range. Page range, such as:1,2,3 or 1-3

Returns:

Returns watermark page range.

isFront

public boolean isFront()

Whether watermark is in the front.

Returns:

Returns whether watermark is in the front.

isFullScreen

public boolean isFullScreen()

Whether it is tiled watermark.

Returns:

Returns whether it is tiled watermark.

getHorizontalSpacing

public float getHorizontalSpacing()

Gets the horizontal spacing for the tiled watermark.

Returns:

Returns the horizontal spacing for the tiled watermark.

getVerticalSpacing

public float getVerticalSpacing()

Gets vertical spacing for the tiled watermark.

Returns:

Returns vertical spacing for the tiled watermark.

setText

public boolean setText(java.lang.String text)

Sets content of text watermark.

Parameters:

text - Content of text watermark.

Returns:

Returns whether to successfully se content of text watermark.

setFontName

public boolean setFontName(java.lang.String fontName)

Sets font of text watermark.

Parameters:

fontName - Font of text watermark.

Returns:

Returns whether to successfully set font of text watermark.

setFontSize

public boolean setFontSize(float fontSize)

Sets font size of text watermark.

Parameters:

fontSize - Font size of text watermark

Returns:

Returns whether to successfully set font size of text watermark.

setTextRGBColor

public boolean setTextRGBColor(int color)

Sets font color of text watermark.

Parameters:

color - Font color of text watermark.

Returns:

Returns whether to successfully set font color of text watermark.

getText

public java.lang.String getText()

Gets content of text watermark.

Returns:

Returns content of text watermark.

getFontName

public java.lang.String getFontName()

Sets font of text watermark.

Returns:

Returns font of text watermark.

getFontSize

public float getFontSize()

Gets font size of text watermark.

Returns:

Returns font size of text watermark.

getTextRGBColor

public int getTextRGBColor()

Gets font color of text watermark.

Returns:

Returns font color of text watermark.

setImage

public boolean setImage(java.lang.String imgPath,
                        java.lang.String smaskPath,
                        int width,
                        int height)

Sets image watermark with Bitmap.

Parameters:

imgPath - Original image path

smaskPath - Mask image path

width - Image width

height - Image height

Returns:

Whether to successfully set image watermark with Bitmap.

setImage

public boolean setImage(android.graphics.Bitmap bitmap,
                        int width,
                        int height)

Sets image watermark with Bitmap by pixel.

Parameters:

bitmap - Image resource.

width - Image width.

height - Image height.

Returns:

Whether to successfully set image watermark with Bitmap by pixel.

getImage

public android.graphics.Bitmap getImage()

Gets watermark appearance.

Returns:

Returns watermark appearance.

saveImage

public boolean saveImage(java.lang.String filePath,
                         java.lang.String smaskPath)

Saves watermark appearance as image.

Parameters:

filePath - Save path.

smaskPath - Save mask path.

Returns:

Whether to successfully save watermark appearance as image.

create

public boolean create()

Not in use

clear

public boolean clear()

Removes watermark.

Returns:

Whether to successfully remove watermark.

update

public boolean update()

Updates watermark.

Returns:

Whether to successfully update watermark.

release

public boolean release()

Releases Watermark object resource.

Returns:

Whether to successfully release Watermark object resource.

isValid

public boolean isValid()

Whether object is valid, false means the object resource is released, you cannot use the object to call any method.

Returns:

Whether object is valid, false means the object resource is released, you cannot use the object to call any method.