Foxit PDF SDK

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

## Public 成员函数
| PDF3DLaunchSetting ()
| 构造函数。
| PDF3DLaunchSetting (PDF3DLaunchSetting launch_setting)
| 带另一个3D启动设置对象的构造函数。 更多...
| PDF3DLaunchSetting (int activation_enable, int activation_disable, int activation_playback, int window_width, int window_height, int border_width, boolean is_transparent_background, int poster_image, String poster_file_path)
| 带参数构造函数。 更多...
synchronized void | delete ()
| 直接清除C++相关资源。 更多...
int | getActivation_disable ()
| Get 3D停用条件设置，请参考值从 com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.e_3DActivationDisableSettingContextMenuSelected ， 它的值将是这些值中的一个。 更多...
int | getActivation_enable ()
| Get 3D启用条件设置，请参考值从 com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.e_3DActivationEnableSettingContentClicked ， 它的值将是这些值中的一个。 更多...
int | getActivation_playback ()
| Get 3D回放类型设置，请参考值从 com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.e_3DActivationPlaybackStyleOnPage ， 它的值将是这些值中的一个。 更多...
int | getBorder_width ()
| Get 3D边框类型，请参考值从 com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.e_3DAppearanceSettingBorderWidthNone ， 它的值将是这些值中的一个。 更多...
boolean | getIs_transparent_background ()
| Get 3D内容背景是否透明， true 表示透明， while false 不透明。默认值为 false。 更多...
String | getPoster_file_path ()
| Get 海报图象文件路径。 这个值只有当poster_image 为 com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.e_3DPosterImageCreateFromFile 时起作用。 更多...
int | getPoster_image ()
| Get 海报图象设置。请参考值从 com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.e_3DPosterImageKeepCurrent ， 它的值将是这些值中的一个。 更多...
int | getWindow_height ()
| Get 3D窗口高度设置，默认值为240。 更多...
int | getWindow_width ()
| Get 3D窗口宽度设置，默认值为320。 更多...
void | set (int activation_enable, int activation_disable, int activation_playback, int window_width, int window_height, int border_width, boolean is_transparent_background, int poster_image, String poster_file_path)
| 设置值。 更多...
void | setActivation_disable (int value)
| Set 3D停用条件设置，请参考值从 com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.e_3DActivationDisableSettingContextMenuSelected ， 它的值将是这些值中的一个。 更多...
void | setActivation_enable (int value)
| Set 3D启用条件设置，请参考值从 com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.e_3DActivationEnableSettingContentClicked ， 它的值将是这些值中的一个。 更多...
void | setActivation_playback (int value)
| Set 3D回放类型设置，请参考值从 com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.e_3DActivationPlaybackStyleOnPage ， 它的值将是这些值中的一个。 更多...
void | setBorder_width (int value)
| Set 3D边框类型，请参考值从 com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.e_3DAppearanceSettingBorderWidthNone ， 它的值将是这些值中的一个。 更多...
void | setIs_transparent_background (boolean value)
| Set 3D内容背景是否透明， true 表示透明， while false 不透明。默认值为 false。 更多...
void | setPoster_file_path (String value)
| Set 海报图象文件路径。 这个值只有当poster_image 为 com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.e_3DPosterImageCreateFromFile 时起作用。 更多...
void | setPoster_image (int value)
| Set 海报图象设置。请参考值从 com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.e_3DPosterImageKeepCurrent ， 它的值将是这些值中的一个。 更多...
void | setWindow_height (int value)
| Set 3D窗口高度设置，默认值为240。 更多...
void | setWindow_width (int value)
| Set 3D窗口宽度设置，默认值为320。 更多...

## 静态 Public 属性
static final int | e_3DActivationDisableSettingContextMenuSelected = 0
| 已在右键菜单中选择了"停用内容"。
static final int | e_3DActivationDisableSettingPageClosed = 1
| 包含内容的页面被关闭时。
static final int | e_3DActivationDisableSettingPageInvisible = 2
| 包含内容的页面不可见时。
static final int | e_3DActivationEnableSettingContentClicked = 0
| 当内容被点击时启用。
static final int | e_3DActivationEnableSettingPageOpened = 1
| 当包含内容的页面被打开时启用。
static final int | e_3DActivationEnableSettingPageVisible = 2
| 当包含内容的页面可见时启用。
static final int | e_3DActivationPlaybackStyleInFloatingWindow = 1
| 在浮动窗口中播放内容。
static final int | e_3DActivationPlaybackStyleOnPage = 0
| 在页面上播放内容。
static final int | e_3DAppearanceSettingBorderWidthMedium = 2
| 中。
static final int | e_3DAppearanceSettingBorderWidthNone = 0
| 无边框。
static final int | e_3DAppearanceSettingBorderWidthThick = 3
| 粗。
static final int | e_3DAppearanceSettingBorderWidthThin = 1
| 细。
static final int | e_3DPosterImageCreateFromFile = 2
| 从文件创建海报。
static final int | e_3DPosterImageKeepCurrent = 0
| 保持当前海报。
static final int | e_3DPosterImageRetrieveFromDefaultView = 1
| 从默认视图中返回。

## 详细描述

This class represents 3D launch setting.

## 构造及析构函数说明

## ◆ PDF3DLaunchSetting() [1/2]

com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.PDF3DLaunchSetting | ( | PDF3DLaunchSetting | launch_setting | ) |

带另一个3D启动设置对象的构造函数。

参数

  [in] | launch_setting | 另一个3D启动设置对象。

## ◆ PDF3DLaunchSetting() [2/2]

com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.PDF3DLaunchSetting | ( | int | activation_enable,
|  | int | activation_disable,
|  | int | activation_playback,
|  | int | window_width,
|  | int | window_height,
|  | int | border_width,
|  | boolean | is_transparent_background,
|  | int | poster_image,
|  | String | poster_file_path
| ) |  |

带参数构造函数。

参数

  [in] | activation_enable | 3D启用条件设置。 请参考从 com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.e_3DActivationEnableSettingContentClicked ， 它的值将是这些值中的一个。
  [in] | activation_disable | 3D停用条件设置。 请参考从 com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.e_3DActivationDisableSettingContextMenuSelected ， 它的值将是这些值中的一个。
  [in] | activation_playback | 3D回放类型设置。 请参考从 com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.e_3DActivationPlaybackStyleOnPage ， 它的值将是这些值中的一个。
  [in] | window_width | 3D窗口宽度设置，默认值为320。
  [in] | window_height | 3D窗口高度设置，默认值为240。
  [in] | border_width | 3D边框宽度设置。 请参考从 com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.e_3DAppearanceSettingBorderWidthNone ， 它的值将是这些值中的一个。
  [in] | is_transparent_background | 背景是否透明。
  [in] | poster_image | 海报图象设置。 请参考从 com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.e_3DPosterImageKeepCurrent ， 它的值将是这些值中的一个。
  [in] | poster_file_path | 海报图象路径。

## 成员函数说明

## ◆ delete()

synchronized void com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.delete | ( |  | ) |

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

返回
  无。

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

## ◆ getActivation_disable()

com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.getActivation_disable | ( |  | ) |

Get 3D停用条件设置，请参考值从 com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.e_3DActivationDisableSettingContextMenuSelected ， 它的值将是这些值中的一个。

返回
  3D停用条件设置，请参考值从 com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.e_3DActivationDisableSettingContextMenuSelected ， 它的值将是这些值中的一个。

## ◆ getActivation_enable()

com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.getActivation_enable | ( |  | ) |

Get 3D启用条件设置，请参考值从 com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.e_3DActivationEnableSettingContentClicked ， 它的值将是这些值中的一个。

返回
  3D启用条件设置，请参考值从 com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.e_3DActivationEnableSettingContentClicked ， 它的值将是这些值中的一个。

## ◆ getActivation_playback()

com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.getActivation_playback | ( |  | ) |

Get 3D回放类型设置，请参考值从 com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.e_3DActivationPlaybackStyleOnPage ， 它的值将是这些值中的一个。

返回
  3D回放类型设置，请参考值从 com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.e_3DActivationPlaybackStyleOnPage ， 它的值将是这些值中的一个。

## ◆ getBorder_width()

com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.getBorder_width | ( |  | ) |

Get 3D边框类型，请参考值从 com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.e_3DAppearanceSettingBorderWidthNone ， 它的值将是这些值中的一个。

返回
  3D边框类型，请参考值从 com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.e_3DAppearanceSettingBorderWidthNone ， 它的值将是这些值中的一个。

## ◆ getIs_transparent_background()

com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.getIs_transparent_background | ( |  | ) |

Get 3D内容背景是否透明， true 表示透明， while false 不透明。默认值为 false。

返回
  3D内容背景是否透明， true 表示透明， while false 不透明。默认值为 false。

## ◆ getPoster_file_path()

com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.getPoster_file_path | ( |  | ) |

Get 海报图象文件路径。 这个值只有当poster_image 为 com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.e_3DPosterImageCreateFromFile 时起作用。

返回
  海报图象文件路径。 这个值只有当poster_image 为 com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.e_3DPosterImageCreateFromFile 时起作用。

## ◆ getPoster_image()

com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.getPoster_image | ( |  | ) |

Get 海报图象设置。请参考值从 com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.e_3DPosterImageKeepCurrent ， 它的值将是这些值中的一个。

返回
  海报图象设置。请参考值从 com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.e_3DPosterImageKeepCurrent ， 它的值将是这些值中的一个。

## ◆ getWindow_height()

com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.getWindow_height | ( |  | ) |

Get 3D窗口高度设置，默认值为240。

返回
  3D窗口高度设置，默认值为240。

## ◆ getWindow_width()

com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.getWindow_width | ( |  | ) |

Get 3D窗口宽度设置，默认值为320。

返回
  3D窗口宽度设置，默认值为320。

## ◆ set()

void com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.set | ( | int | activation_enable,
|  | int | activation_disable,
|  | int | activation_playback,
|  | int | window_width,
|  | int | window_height,
|  | int | border_width,
|  | boolean | is_transparent_background,
|  | int | poster_image,
|  | String | poster_file_path
| ) |  |

设置值。

参数

  [in] | activation_enable | 3D启用条件设置。 请参考从 com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.e_3DActivationEnableSettingContentClicked ， 它的值将是这些值中的一个。
  [in] | activation_disable | 3D停用条件设置。 请参考从 com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.e_3DActivationDisableSettingContextMenuSelected ， 它的值将是这些值中的一个。
  [in] | activation_playback | 3D回放类型设置。 请参考从 com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.e_3DActivationPlaybackStyleOnPage ， 它的值将是这些值中的一个。
  [in] | window_width | 3D窗口宽度设置，默认值为320。
  [in] | window_height | 3D窗口高度设置，默认值为240。
  [in] | border_width | 3D边框宽度设置。 请参考从 com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.e_3DAppearanceSettingBorderWidthNone ， 它的值将是这些值中的一个。
  [in] | is_transparent_background | 背景是否透明。
  [in] | poster_image | 海报图象设置。 请参考从 com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.e_3DPosterImageKeepCurrent ， 它的值将是这些值中的一个。
  [in] | poster_file_path | 海报图象路径。

返回
  无。

## ◆ setActivation_disable()

com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.setActivation_disable | ( | int | value | ) |

Set 3D停用条件设置，请参考值从 com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.e_3DActivationDisableSettingContextMenuSelected ， 它的值将是这些值中的一个。

参数

  [in] | value | 3D停用条件设置，请参考值从 com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.e_3DActivationDisableSettingContextMenuSelected ， 它的值将是这些值中的一个。

返回
  None.

## ◆ setActivation_enable()

com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.setActivation_enable | ( | int | value | ) |

Set 3D启用条件设置，请参考值从 com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.e_3DActivationEnableSettingContentClicked ， 它的值将是这些值中的一个。

参数

  [in] | value | 3D启用条件设置，请参考值从 com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.e_3DActivationEnableSettingContentClicked ， 它的值将是这些值中的一个。

返回
  None.

## ◆ setActivation_playback()

com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.setActivation_playback | ( | int | value | ) |

Set 3D回放类型设置，请参考值从 com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.e_3DActivationPlaybackStyleOnPage ， 它的值将是这些值中的一个。

参数

  [in] | value | 3D回放类型设置，请参考值从 com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.e_3DActivationPlaybackStyleOnPage ， 它的值将是这些值中的一个。

返回
  None.

## ◆ setBorder_width()

com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.setBorder_width | ( | int | value | ) |

Set 3D边框类型，请参考值从 com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.e_3DAppearanceSettingBorderWidthNone ， 它的值将是这些值中的一个。

参数

  [in] | value | 3D边框类型，请参考值从 com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.e_3DAppearanceSettingBorderWidthNone ， 它的值将是这些值中的一个。

返回
  None.

## ◆ setIs_transparent_background()

com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.setIs_transparent_background | ( | boolean | value | ) |

Set 3D内容背景是否透明， true 表示透明， while false 不透明。默认值为 false。

参数

  [in] | value | 3D内容背景是否透明， true 表示透明， while false 不透明。默认值为 false。

返回
  None.

## ◆ setPoster_file_path()

com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.setPoster_file_path | ( | String | value | ) |

Set 海报图象文件路径。 这个值只有当poster_image 为 com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.e_3DPosterImageCreateFromFile 时起作用。

参数

  [in] | value | 海报图象文件路径。 这个值只有当poster_image 为 com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.e_3DPosterImageCreateFromFile 时起作用。

返回
  None.

## ◆ setPoster_image()

com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.setPoster_image | ( | int | value | ) |

Set 海报图象设置。请参考值从 com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.e_3DPosterImageKeepCurrent ， 它的值将是这些值中的一个。

参数

  [in] | value | 海报图象设置。请参考值从 com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.e_3DPosterImageKeepCurrent ， 它的值将是这些值中的一个。

返回
  None.

## ◆ setWindow_height()

com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.setWindow_height | ( | int | value | ) |

Set 3D窗口高度设置，默认值为240。

参数

  [in] | value | 3D窗口高度设置，默认值为240。

返回
  None.

## ◆ setWindow_width()

com.foxit.sdk.addon.pdf3d.PDF3DLaunchSetting.setWindow_width | ( | int | value | ) |

Set 3D窗口宽度设置，默认值为320。

参数

  [in] | value | 3D窗口宽度设置，默认值为320。

返回
  None.