Foxit PDF SDK

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

## Public 成员函数
| BorderInfo ()
| 默认构造函数。
| BorderInfo (BorderInfo border_info)
| 拷贝构造函数。 更多...
| BorderInfo (float width, int style, float intensity, float dash_phase, FloatArray dashes)
| 构造函数，带参数。 更多...
synchronized void | delete ()
| 直接清除C++相关资源。 更多...
float | getCloud_intensity ()
| Get 云状效果的强度。 更多...
float | getDash_phase ()
| Get 虚线相位。 更多...
FloatArray | getDashes ()
| Get 表示虚线模式的虚线数组。 更多...
int | getStyle ()
| Get 边框样式。请参考 com.foxit.sdk.pdf.annots.BorderInfo.e_Solid 及相关值，应为这些值中的一个。 更多...
float | getWidth ()
| Get 边框宽度，以点为单位。 更多...
void | set (float width, int style, float intensity, float dash_phase, FloatArray dashes)
| 设置边框信息。 更多...
void | setCloud_intensity (float value)
| Set 云状效果的强度。 更多...
void | setDash_phase (float value)
| Set 虚线相位。 更多...
void | setDashes (FloatArray value)
| Set 表示虚线模式的虚线数组。 更多...
void | setStyle (int value)
| Set 边框样式。请参考 com.foxit.sdk.pdf.annots.BorderInfo.e_Solid 及相关值，应为这些值中的一个。 更多...
void | setWidth (float value)
| Set 边框宽度，以点为单位。 更多...

## 静态 Public 属性
static final int | e_Beveled = 3
| 边框样式：斜面。 更多...
static final int | e_Cloudy = 5
| 边框样式：云朵。 更多...
static final int | e_Dashed = 1
| 边框样式：虚线。 更多...
static final int | e_Inset = 4
| 边框样式：内嵌。 更多...
static final int | e_Solid = 0
| 边框样式：实线
static final int | e_UnderLine = 2
| 边框样式：下划线。 更多...

## 详细描述

此类表示注释边框信息。

## 构造及析构函数说明

## ◆ BorderInfo() [1/2]

com.foxit.sdk.pdf.annots.BorderInfo.BorderInfo | ( | float | width,
|  | int | style,
|  | float | intensity,
|  | float | dash_phase,
|  | FloatArray | dashes
| ) |  |

构造函数，带参数。

参数

  [in] | width | 边框宽度，以点为单位。这应该是一个非负值。 如果此值为0，则不绘制边框。
  [in] | style | 边框样式。请参考从com.foxit.sdk.pdf.annots.BorderInfo.e_Solid 开始的值， 这应该是这些值中的一个。
  [in] | intensity | 云状效果的强度。仅当参数style为 com.foxit.sdk.pdf.annots.BorderInfo.e_Cloudy 时才有用。有效值范围：0到2。 0表示没有云状边框效果。 如果值小于0，将与值0具有相同效果。 如果值大于2，将与值2具有相同效果。
  [in] | dash_phase | 虚线相位。仅在参数style为 com.foxit.sdk.pdf.annots.BorderInfo.e_Dashed 时有用。
  [in] | dashes | 表示虚线模式的虚线数组。此数组中每个元素的值 不应为负数。仅在style为com.foxit.sdk.pdf.annots.BorderInfo.e_Dashed 时有用。

## ◆ BorderInfo() [2/2]

com.foxit.sdk.pdf.annots.BorderInfo.BorderInfo | ( | BorderInfo | border_info | ) |

拷贝构造函数。

参数

  [in] | border_info | 另一个边框信息对象。

## 成员函数说明

## ◆ delete()

synchronized void com.foxit.sdk.pdf.annots.BorderInfo.delete | ( |  | ) |

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

返回
  无。

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

## ◆ getCloud_intensity()

com.foxit.sdk.pdf.annots.BorderInfo.getCloud_intensity | ( |  | ) |

Get 云状效果的强度。

仅对自由文本、正方形、圆形和多边形注释有用，当前对象的 style 为 com.foxit.sdk.pdf.annots.BorderInfo.e_Cloudy 时。
建议值范围：0 到 2。0 表示无云状边框效果。
其他值的效果为：

- 如果值小于 0，将与值 0 具有相同效果。
- 如果值大于 2，将与值 2 具有相同效果。

返回
  云状效果的强度。

## ◆ getDash_phase()

com.foxit.sdk.pdf.annots.BorderInfo.getDash_phase | ( |  | ) |

Get 虚线相位。

仅在当前对象的 style 为 com.foxit.sdk.pdf.annots.BorderInfo.e_Dashed 时有用。

返回
  虚线相位。

## ◆ getDashes()

com.foxit.sdk.pdf.annots.BorderInfo.getDashes | ( |  | ) |

Get 表示虚线模式的虚线数组。

仅在当前对象的 style 为 com.foxit.sdk.pdf.annots.BorderInfo.e_Dashed 时有用。
此数组中元素的值不应为负数。

返回
  表示虚线模式的虚线数组。

## ◆ getStyle()

com.foxit.sdk.pdf.annots.BorderInfo.getStyle | ( |  | ) |

Get 边框样式。请参考 com.foxit.sdk.pdf.annots.BorderInfo.e_Solid 及相关值，应为这些值中的一个。

返回
  边框样式。请参考 com.foxit.sdk.pdf.annots.BorderInfo.e_Solid 及相关值，应为这些值中的一个。

## ◆ getWidth()

com.foxit.sdk.pdf.annots.BorderInfo.getWidth | ( |  | ) |

Get 边框宽度，以点为单位。

此值不应为负数。如果此值为 0，则不会绘制边框。

返回
  边框宽度，以点为单位。

## ◆ set()

void com.foxit.sdk.pdf.annots.BorderInfo.set | ( | float | width,
|  | int | style,
|  | float | intensity,
|  | float | dash_phase,
|  | FloatArray | dashes
| ) |  |

设置边框信息。

参数

  [in] | width | 边框宽度（单位：点）。应为非负值。为0时不绘制边框。
  [in] | style | 边框样式。请参考从com.foxit.sdk.pdf.annots.BorderInfo.e_Solid 开始的值，这应该是这些值中的一个。
  [in] | intensity | 云状效果强度，仅当style为com.foxit.sdk.pdf.annots.BorderInfo.e_Cloudy 时有效。有效范围0~2。 0表示无云状效果。小于0等同于0，大于2等同于2。
  [in] | dash_phase | 虚线起始相位，仅当style为com.foxit.sdk.pdf.annots.BorderInfo.e_Dashed 时有效。
  [in] | dashes | 虚线数组，表示虚线模式。数组中每个元素都应为非负值，仅当style为com.foxit.sdk.pdf.annots.BorderInfo.e_Dashed 时有效。

返回
  无。

## ◆ setCloud_intensity()

com.foxit.sdk.pdf.annots.BorderInfo.setCloud_intensity | ( | float | value | ) |

Set 云状效果的强度。

仅对自由文本、正方形、圆形和多边形注释有用，当前对象的 style 为 com.foxit.sdk.pdf.annots.BorderInfo.e_Cloudy 时。
建议值范围：0 到 2。0 表示无云状边框效果。
其他值的效果为：

- 如果值小于 0，将与值 0 具有相同效果。
- 如果值大于 2，将与值 2 具有相同效果。

参数

  [in] | value | 云状效果的强度。

返回
  None.

## ◆ setDash_phase()

com.foxit.sdk.pdf.annots.BorderInfo.setDash_phase | ( | float | value | ) |

Set 虚线相位。

仅在当前对象的 style 为 com.foxit.sdk.pdf.annots.BorderInfo.e_Dashed 时有用。

参数

  [in] | value | 虚线相位。

返回
  None.

## ◆ setDashes()

com.foxit.sdk.pdf.annots.BorderInfo.setDashes | ( | FloatArray | value | ) |

Set 表示虚线模式的虚线数组。

仅在当前对象的 style 为 com.foxit.sdk.pdf.annots.BorderInfo.e_Dashed 时有用。
此数组中元素的值不应为负数。

参数

  [in] | value | 表示虚线模式的虚线数组。

返回
  None.

## ◆ setStyle()

com.foxit.sdk.pdf.annots.BorderInfo.setStyle | ( | int | value | ) |

Set 边框样式。请参考 com.foxit.sdk.pdf.annots.BorderInfo.e_Solid 及相关值，应为这些值中的一个。

参数

  [in] | value | 边框样式。请参考 com.foxit.sdk.pdf.annots.BorderInfo.e_Solid 及相关值，应为这些值中的一个。

返回
  None.

## ◆ setWidth()

com.foxit.sdk.pdf.annots.BorderInfo.setWidth | ( | float | value | ) |

Set 边框宽度，以点为单位。

此值不应为负数。如果此值为 0，则不会绘制边框。

参数

  [in] | value | 边框宽度，以点为单位。

返回
  None.

## 类成员变量说明

## ◆ e_Beveled

final int com.foxit.sdk.pdf.annots.BorderInfo.e_Beveled = 3
| static

边框样式：斜面。

目前，福昕PDF SDK不支持此边框样式的注释外观。 如果将此设置为任何注释，福昕PDF SDK内部会默认将边框样式更改为 com.foxit.sdk.pdf.annots.BorderInfo.e_Solid 。

## ◆ e_Cloudy

final int com.foxit.sdk.pdf.annots.BorderInfo.e_Cloudy = 5
| static

边框样式：云朵。

这仅对自由文本、正方形、圆形和多边形注释有用。 如果将此设置为其他类型的注释，福昕PDF SDK内部会默认将边框样式更改为 com.foxit.sdk.pdf.annots.BorderInfo.e_Solid 。

## ◆ e_Dashed

final int com.foxit.sdk.pdf.annots.BorderInfo.e_Dashed = 1
| static

边框样式：虚线。

这仅对链接、自由文本、线条、正方形、圆形、多边形、折线和屏幕注释有用。 如果将此设置为其他类型的注释，福昕PDF SDK内部会默认将边框样式更改为 com.foxit.sdk.pdf.annots.BorderInfo.e_Solid 。

## ◆ e_Inset

final int com.foxit.sdk.pdf.annots.BorderInfo.e_Inset = 4
| static

边框样式：内嵌。

目前，福昕PDF SDK不支持此边框样式的注释外观。 如果将此设置为任何注释，福昕PDF SDK内部会默认将边框样式更改为 com.foxit.sdk.pdf.annots.BorderInfo.e_Solid 。

## ◆ e_UnderLine

final int com.foxit.sdk.pdf.annots.BorderInfo.e_UnderLine = 2
| static

边框样式：下划线。

这仅对链接注释有用。如果将此设置为其他类型的注释，福昕PDF SDK内部会 默认将边框样式更改为com.foxit.sdk.pdf.annots.BorderInfo.e_Solid 。