Foxit PDF SDK
com.foxit.sdk.pdf.TiledWatermarkSettings Class Reference

Public Member Functions

 TiledWatermarkSettings ()
 Constructor and set the default value.
More...
 
 TiledWatermarkSettings (float row_space, float col_space, float rotation, int opacity, int scale)
 Constructor, with parameters.
More...
 
 TiledWatermarkSettings (TiledWatermarkSettings settings)
 Constructor, with another tiled watermark settings object.
More...
 
synchronized void delete ()
 Clean up related resources immediately. More...
 
float getCol_space ()
 Get the column spacing for multiple lines of tiled watermark. More...
 
int getOpacity ()
 Get opacity in percents. More...
 
float getRotation ()
 Get rotation angle in degrees. More...
 
float getRow_space ()
 Get the row spacing for multiple lines of tiled watermark. More...
 
int getScale ()
 Get the image or page scale in percents. More...
 
void set (float row_space, float col_space, float rotation, int opacity, int scale)
 Set value.
More...
 
void setCol_space (float value)
 Set the column spacing for multiple lines of tiled watermark. More...
 
void setOpacity (int value)
 Set opacity in percents. More...
 
void setRotation (float value)
 Set rotation angle in degrees. More...
 
void setRow_space (float value)
 Set the row spacing for multiple lines of tiled watermark. More...
 
void setScale (int value)
 Set the image or page scale in percents. More...
 

Detailed Description

This class represents the watermark settings used to construct a tiled watermark from any supported resource.

Constructor & Destructor Documentation

◆ TiledWatermarkSettings() [1/3]

com.foxit.sdk.pdf.TiledWatermarkSettings.TiledWatermarkSettings ( float  row_space,
float  col_space,
float  rotation,
int  opacity,
int  scale 
)

Constructor, with parameters.

The parameter scale doesn't support text tiled watermark, and will have no effect after setting.

Parameters
[in]row_spaceThe row spacing for multiple lines of tiled watermark. Its unit is inch and it can't be a negative number.
[in]col_spaceThe column spacing for multiple lines of tiled watermark. Its unit is inch and it can't be a negative number.
[in]rotationRotation angle in degrees.
[in]opacityOpacity in percents. Valid range: from 0 to 100. 0 for fully transparent and 100 for fully opaque.
[in]scaleThe image or page scale in percents. Valid range: from 0 to 100. 0 means not displayed, 100 means the image or page is displayed at its original scale size.

◆ TiledWatermarkSettings() [2/3]

com.foxit.sdk.pdf.TiledWatermarkSettings.TiledWatermarkSettings ( )

Constructor and set the default value.

By default, the watermark is not rotated and opacity is completely opaque, the row spacing and column spacing defaults to 2.0 inches. If it's an image or page watermark, display the original scale size.

◆ TiledWatermarkSettings() [3/3]

com.foxit.sdk.pdf.TiledWatermarkSettings.TiledWatermarkSettings ( TiledWatermarkSettings  settings)

Constructor, with another tiled watermark settings object.

Parameters
[in]settingsAnother tiled watermark settings object.

Member Function Documentation

◆ delete()

synchronized void com.foxit.sdk.pdf.TiledWatermarkSettings.delete ( )

Clean up related resources immediately.

Returns
None.
Note
Once this function is called, current object cannot be used anymore.

◆ getCol_space()

com.foxit.sdk.pdf.TiledWatermarkSettings.getCol_space ( )

Get the column spacing for multiple lines of tiled watermark.

Returns
The column spacing for multiple lines of tiled watermark. Its unit is inch and it can't be a negative number.

◆ getOpacity()

com.foxit.sdk.pdf.TiledWatermarkSettings.getOpacity ( )

Get opacity in percents.

Returns
Opacity in percents. Valid range: from 0 to 100. 0 for fully transparent and 100 for fully opaque.

◆ getRotation()

com.foxit.sdk.pdf.TiledWatermarkSettings.getRotation ( )

Get rotation angle in degrees.

Returns
Rotation angle in degrees.

◆ getRow_space()

com.foxit.sdk.pdf.TiledWatermarkSettings.getRow_space ( )

Get the row spacing for multiple lines of tiled watermark.

Returns
The row spacing for multiple lines of tiled watermark. Its unit is inch and it can't be a negative number.

◆ getScale()

com.foxit.sdk.pdf.TiledWatermarkSettings.getScale ( )

Get the image or page scale in percents.

Returns
The image or page scale in percents. Valid range: from 0 to 100. 0 means not displayed, 100 means the image or page is displayed at its original size. The default value is 100.

◆ set()

void com.foxit.sdk.pdf.TiledWatermarkSettings.set ( float  row_space,
float  col_space,
float  rotation,
int  opacity,
int  scale 
)

Set value.

The parameter scale doesn't support text tiled watermark, and will have no effect after setting.

Parameters
[in]row_spaceThe row spacing for multiple lines of tiled watermark. Its unit is inch and it can't be a negative number.
[in]col_spaceThe column spacing for multiple lines of tiled watermark. Its unit is inch and it can't be a negative number.
[in]rotationRotation angle in degrees.
[in]opacityOpacity in percents. Valid range: from 0 to 100. 0 for fully transparent and 100 for fully opaque.
[in]scaleThe image or page scale in percents. Valid range: from 0 to 100. 0 means not displayed, 100 means the image or page is displayed at its original scale size.
Returns
None.

◆ setCol_space()

com.foxit.sdk.pdf.TiledWatermarkSettings.setCol_space ( float  value)

Set the column spacing for multiple lines of tiled watermark.

Parameters
[in]valueThe column spacing for multiple lines of tiled watermark. Its unit is inch and it can't be a negative number.
Returns
None.

◆ setOpacity()

com.foxit.sdk.pdf.TiledWatermarkSettings.setOpacity ( int  value)

Set opacity in percents.

Parameters
[in]valueOpacity in percents. Valid range: from 0 to 100. 0 for fully transparent and 100 for fully opaque.
Returns
None.

◆ setRotation()

com.foxit.sdk.pdf.TiledWatermarkSettings.setRotation ( float  value)

Set rotation angle in degrees.

Parameters
[in]valueRotation angle in degrees.
Returns
None.

◆ setRow_space()

com.foxit.sdk.pdf.TiledWatermarkSettings.setRow_space ( float  value)

Set the row spacing for multiple lines of tiled watermark.

Parameters
[in]valueThe row spacing for multiple lines of tiled watermark. Its unit is inch and it can't be a negative number.
Returns
None.

◆ setScale()

com.foxit.sdk.pdf.TiledWatermarkSettings.setScale ( int  value)

Set the image or page scale in percents.

Parameters
[in]valueThe image or page scale in percents. Valid range: from 0 to 100. 0 means not displayed, 100 means the image or page is displayed at its original size. The default value is 100.
Returns
None.