Foxit PDF SDK

Public 成员函数 | 静态 Public 属性 | 所有成员列表
com.foxit.sdk.pdf.WatermarkSettings类 参考

## Public 成员函数
| WatermarkSettings (int position, float offset_x, float offset_y, int flags, float scale_x, float scale_y, float rotation, int opacity)
| 带参数的构造函数。 更多...
| WatermarkSettings ()
| 构造函数。
| WatermarkSettings (WatermarkSettings settings)
| 带另一个水印设置对象的构造函数。 更多...
synchronized void | delete ()
| 直接清除C++相关资源。 更多...
int | getFlags ()
| Get 水印标志。 更多...
float | getOffset_x ()
| Get 水平偏移量，以点为单位。 更多...
float | getOffset_y ()
| Get 垂直偏移量，以点为单位。 更多...
int | getOpacity ()
| Get 不透明度，以百分比为单位。有效范围：从0到100。 0表示完全透明，100表示完全不透明。 更多...
int | getPosition ()
| Get 水印位置。 更多...
float | getRotation ()
| Get 旋转角度，以度为单位。 更多...
float | getScale_x ()
| Get 水平缩放系数。应大于0. 更多...
float | getScale_y ()
| Get 垂直缩放系数。应大于0. 更多...
void | set (int position, float offset_x, float offset_y, int flags, float scale_x, float scale_y, float rotation, int opacity)
| 设置值。 更多...
void | setFlags (int value)
| Set 水印标志。 更多...
void | setOffset_x (float value)
| Set 水平偏移量，以点为单位。 更多...
void | setOffset_y (float value)
| Set 垂直偏移量，以点为单位。 更多...
void | setOpacity (int value)
| Set 不透明度，以百分比为单位。有效范围：从0到100。 0表示完全透明，100表示完全不透明。 更多...
void | setPosition (int value)
| Set 水印位置。 更多...
void | setRotation (float value)
| Set 旋转角度，以度为单位。 更多...
void | setScale_x (float value)
| Set 水平缩放系数。应大于0. 更多...
void | setScale_y (float value)
| Set 垂直缩放系数。应大于0. 更多...

## 静态 Public 属性
static final int | e_FlagASAnnot = 0x0001
| 如果设置，水印将在插入PDF页面时成为注释。
static final int | e_FlagASPageContents = 0x0000
| 如果设置，水印将在插入PDF页面时成为页面内容的一部分。
static final int | e_FlagInvisible = 0x0008
| 如果设置，不显示水印。
static final int | e_FlagNoPrint = 0x0004
| 如果设置，不打印水印。
static final int | e_FlagOnTop = 0x0002
| 如果设置，在其他页面内容之上显示水印。
static final int | e_FlagShareImageStream = 0x0010
| 如果设置，如果这些水印使用相同的图像或位图，水印将共享一个图像流。
static final int | e_FlagSharePageStream = 0x0040
| 如果设置，如果这些水印使用相同的页面对象，水印将共享一个表单XObject。
static final int | e_FlagShareTextStream = 0x0020
| 如果设置，如果这些水印使用相同的文本和文本相关属性，水印将共享一个表单XObject。

## 详细描述

此类表示用于从任何支持的资源构造水印对象的水印设置。

## 构造及析构函数说明

## ◆ WatermarkSettings() [1/2]

com.foxit.sdk.pdf.WatermarkSettings.WatermarkSettings | ( | int | position,
|  | float | offset_x,
|  | float | offset_y,
|  | int | flags,
|  | float | scale_x,
|  | float | scale_y,
|  | float | rotation,
|  | int | opacity
| ) |  |

带参数的构造函数。

参数

  [in] | position | 水印位置。请参考从com.foxit.sdk.common.Constants.e_PosTopLeft 开始的值， 这应该是这些值中的一个。
  [in] | offset_x | 水平偏移量，以点为单位。
  [in] | offset_y | 垂直偏移量，以点为单位。
  [in] | flags | 水印标志。请参考从com.foxit.sdk.pdf.WatermarkSettings.e_FlagASPageContents 开始的值，这可以是这些值中的一个或它们的组合。
  [in] | scale_x | 水平缩放系数。应大于0.001f。
  [in] | scale_y | 垂直缩放系数。应大于0.001f。
  [in] | rotation | 旋转角度，以度为单位。
  [in] | opacity | 不透明度，以百分比为单位。有效范围：从0到100。 0表示完全透明，100表示完全不透明。

## ◆ WatermarkSettings() [2/2]

com.foxit.sdk.pdf.WatermarkSettings.WatermarkSettings | ( | WatermarkSettings | settings | ) |

带另一个水印设置对象的构造函数。

参数

  [in] | settings | 另一个水印设置对象。

## 成员函数说明

## ◆ delete()

synchronized void com.foxit.sdk.pdf.WatermarkSettings.delete | ( |  | ) |

直接清除C++相关资源。

返回
  无。

注解
  一旦这个接口被调用，这个对象将不能再被使用。

## ◆ getFlags()

com.foxit.sdk.pdf.WatermarkSettings.getFlags | ( |  | ) |

Get 水印标志。

请参考从com.foxit.sdk.pdf.WatermarkSettings.e_FlagASPageContents 开始的值， 这可以是这些值中的一个或它们的组合。

返回
  水印标志。

## ◆ getOffset_x()

com.foxit.sdk.pdf.WatermarkSettings.getOffset_x | ( |  | ) |

Get 水平偏移量，以点为单位。

返回
  水平偏移量，以点为单位。

## ◆ getOffset_y()

com.foxit.sdk.pdf.WatermarkSettings.getOffset_y | ( |  | ) |

Get 垂直偏移量，以点为单位。

返回
  垂直偏移量，以点为单位。

## ◆ getOpacity()

com.foxit.sdk.pdf.WatermarkSettings.getOpacity | ( |  | ) |

Get 不透明度，以百分比为单位。有效范围：从0到100。 0表示完全透明，100表示完全不透明。

返回
  不透明度，以百分比为单位。有效范围：从0到100。 0表示完全透明，100表示完全不透明。

## ◆ getPosition()

com.foxit.sdk.pdf.WatermarkSettings.getPosition | ( |  | ) |

Get 水印位置。

请参考从com.foxit.sdk.common.Constants.e_PosTopLeft 开始的值，这应该是这些值中的一个。

返回
  水印位置。

## ◆ getRotation()

com.foxit.sdk.pdf.WatermarkSettings.getRotation | ( |  | ) |

Get 旋转角度，以度为单位。

返回
  旋转角度，以度为单位。

## ◆ getScale_x()

com.foxit.sdk.pdf.WatermarkSettings.getScale_x | ( |  | ) |

Get 水平缩放系数。应大于0.

返回
  水平缩放系数。应大于0.001f。

## ◆ getScale_y()

com.foxit.sdk.pdf.WatermarkSettings.getScale_y | ( |  | ) |

Get 垂直缩放系数。应大于0.

返回
  垂直缩放系数。应大于0.001f。

## ◆ set()

void com.foxit.sdk.pdf.WatermarkSettings.set | ( | int | position,
|  | float | offset_x,
|  | float | offset_y,
|  | int | flags,
|  | float | scale_x,
|  | float | scale_y,
|  | float | rotation,
|  | int | opacity
| ) |  |

设置值。

参数

  [in] | position | 水印位置。请参考从com.foxit.sdk.common.Constants.e_PosTopLeft 开始的值， 这应该是这些值中的一个。
  [in] | offset_x | 水平偏移量，以点为单位。
  [in] | offset_y | 垂直偏移量，以点为单位。
  [in] | flags | 水印标志。请参考从com.foxit.sdk.pdf.WatermarkSettings.e_FlagASPageContents 开始的值，这可以是这些值中的一个或它们的组合。
  [in] | scale_x | 水平缩放系数。应大于0.001f。
  [in] | scale_y | 垂直缩放系数。应大于0.001f。
  [in] | rotation | 旋转角度，以度为单位。
  [in] | opacity | 不透明度，以百分比为单位。有效范围：从0到100。 0表示完全透明，100表示完全不透明。

返回
  无。

## ◆ setFlags()

com.foxit.sdk.pdf.WatermarkSettings.setFlags | ( | int | value | ) |

Set 水印标志。

请参考从com.foxit.sdk.pdf.WatermarkSettings.e_FlagASPageContents 开始的值， 这可以是这些值中的一个或它们的组合。

参数

  [in] | value | 水印标志。

返回
  None.

## ◆ setOffset_x()

com.foxit.sdk.pdf.WatermarkSettings.setOffset_x | ( | float | value | ) |

Set 水平偏移量，以点为单位。

参数

  [in] | value | 水平偏移量，以点为单位。

返回
  None.

## ◆ setOffset_y()

com.foxit.sdk.pdf.WatermarkSettings.setOffset_y | ( | float | value | ) |

Set 垂直偏移量，以点为单位。

参数

  [in] | value | 垂直偏移量，以点为单位。

返回
  None.

## ◆ setOpacity()

com.foxit.sdk.pdf.WatermarkSettings.setOpacity | ( | int | value | ) |

Set 不透明度，以百分比为单位。有效范围：从0到100。 0表示完全透明，100表示完全不透明。

参数

  [in] | value | 不透明度，以百分比为单位。有效范围：从0到100。 0表示完全透明，100表示完全不透明。

返回
  None.

## ◆ setPosition()

com.foxit.sdk.pdf.WatermarkSettings.setPosition | ( | int | value | ) |

Set 水印位置。

请参考从com.foxit.sdk.common.Constants.e_PosTopLeft 开始的值，这应该是这些值中的一个。

参数

  [in] | value | 水印位置。

返回
  None.

## ◆ setRotation()

com.foxit.sdk.pdf.WatermarkSettings.setRotation | ( | float | value | ) |

Set 旋转角度，以度为单位。

参数

  [in] | value | 旋转角度，以度为单位。

返回
  None.

## ◆ setScale_x()

com.foxit.sdk.pdf.WatermarkSettings.setScale_x | ( | float | value | ) |

Set 水平缩放系数。应大于0.

参数

  [in] | value | 水平缩放系数。应大于0.001f。

返回
  None.

## ◆ setScale_y()

com.foxit.sdk.pdf.WatermarkSettings.setScale_y | ( | float | value | ) |

Set 垂直缩放系数。应大于0.

参数

  [in] | value | 垂直缩放系数。应大于0.001f。

返回
  None.