# com.herewhite.sdk.domain.WindowDocsEvent class 参考 (/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-window-docs-event)

> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).

<a id="details"></a>

## 详细描述 [#详细描述]

适用版本：**Whiteboard Android SDK 2.16.134**。

## 属性与 JSON 字段 [#属性与-json-字段]

Java 非公开字段通过对应 getter/setter 访问；可选包装类型未设置时通常不写入 JSON。初值包含字段声明及无参构造中的直接赋值；其他构造参数以签名为准。

| 字段 | 声明 | 源码初值 | 说明 |
| --- | --- | --- | --- |
| [PrevPage](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-window-docs-event#a54424251eb7db1bbb842edf37fae7ec7) | `WindowDocsEvent PrevPage` | new WindowDocsEvent(...) | [api-center-table-0 details](#table-slot-api-center-table-0) |
| [NextPage](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-window-docs-event#ac2d4fb290f5bd84398f76cb4f59cf27e) | `WindowDocsEvent NextPage` | new WindowDocsEvent(...) | [api-center-table-1 details](#table-slot-api-center-table-1) |
| [PrevStep](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-window-docs-event#ac42c3a796f3077ffa8edc7c1967d011f) | `WindowDocsEvent PrevStep` | new WindowDocsEvent(...) | [api-center-table-2 details](#table-slot-api-center-table-2) |
| [NextStep](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-window-docs-event#a4a5ddfc6bca2ba26b462e335e5d9b12e) | `WindowDocsEvent NextStep` | new WindowDocsEvent(...) | [api-center-table-3 details](#table-slot-api-center-table-3) |
| [event](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-window-docs-event#aedb8f233f76082619845a4fc2c25d1c6) | `String event` | 未显式赋值 | [api-center-table-4 details](#table-slot-api-center-table-4) |
| [options](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-window-docs-event#a54b79add8e4b4e1d54d9344b64a99ba5) | `Options options` | new Options(...) | [api-center-table-5 details](#table-slot-api-center-table-5) |

<a id="table-slot-api-center-table-0"></a>

**api-center-table-0 details**

公开常量或属性。

<a id="table-slot-api-center-table-1"></a>

**api-center-table-1 details**

公开常量或属性。

<a id="table-slot-api-center-table-2"></a>

**api-center-table-2 details**

公开常量或属性。

<a id="table-slot-api-center-table-3"></a>

**api-center-table-3 details**

公开常量或属性。

<a id="table-slot-api-center-table-4"></a>

**api-center-table-4 details**

模型属性；通过对应 getter/setter 访问。

<a id="table-slot-api-center-table-5"></a>

**api-center-table-5 details**

模型属性；通过对应 getter/setter 访问。

| 公开成员签名 |  |
| --- | --- |
|  | [WindowDocsEvent](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-window-docs-event#aeebee8eb7235ff62a00d7d48c8684215) (String event) |
|  | [WindowDocsEvent](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-window-docs-event#ae1621e8775231eddb45bc4fd32c611ae) (String event, Options options) |
| WindowDocsEvent | [JumpToPage](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-window-docs-event#a9102805f760173eede329af8078eee10) (Integer page) |
| WindowDocsEvent | [ScalePage](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-window-docs-event#a375f92bc517c8513aae43357d30a6bac) (Double scale) |
| String | [getEvent](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-window-docs-event#a5bcff9c692d58276b96d338aa5c73156) () |
| void | [setEvent](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-window-docs-event#a32edd9a0ef68e400602f3b013cfb45e9) (String event) |
| Options | [getOptions](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-window-docs-event#a673ca458ec86ecc798f286e4db3d187a) () |
| void | [setOptions](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-window-docs-event#afcb6a762104dc7aa24aae5a037fc0904) (Options options) |
| WindowDocsEvent | [withTarget](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-window-docs-event#a104ab15779a3620c2f04f3cd07a914e1) (String target) |

## 变量说明 [#变量说明]

<a id="a54424251eb7db1bbb842edf37fae7ec7"></a>


<a id="ad5785268175d048f620944af33fd972e"></a>

### PrevPage [#prevpage]

```text
WindowDocsEvent PrevPage
```

源码初值：new WindowDocsEvent(...)

公开常量或属性。

<a id="ac2d4fb290f5bd84398f76cb4f59cf27e"></a>


<a id="aedf821539faafb8218917eae89a7c368"></a>

### NextPage [#nextpage]

```text
WindowDocsEvent NextPage
```

源码初值：new WindowDocsEvent(...)

公开常量或属性。

<a id="ac42c3a796f3077ffa8edc7c1967d011f"></a>


<a id="a022821139a3d40ddb23761a4a0bd8197"></a>

### PrevStep [#prevstep]

```text
WindowDocsEvent PrevStep
```

源码初值：new WindowDocsEvent(...)

公开常量或属性。

<a id="a4a5ddfc6bca2ba26b462e335e5d9b12e"></a>


<a id="aed61a32e60215c44667794affe622815"></a>

### NextStep [#nextstep]

```text
WindowDocsEvent NextStep
```

源码初值：new WindowDocsEvent(...)

公开常量或属性。

<a id="aedb8f233f76082619845a4fc2c25d1c6"></a>

### event [#event]

```text
String event
```

源码初值：未显式赋值

模型属性；通过对应 getter/setter 访问。

<a id="a54b79add8e4b4e1d54d9344b64a99ba5"></a>

### options [#options]

```text
Options options
```

源码初值：new Options(...)

模型属性；通过对应 getter/setter 访问。

## 函数说明 [#函数说明]

<a id="aeebee8eb7235ff62a00d7d48c8684215"></a>

### WindowDocsEvent() [#windowdocsevent]

<ApiSignature>

WindowDocsEvent(String event)

</ApiSignature>

WindowDocsEvent：com.herewhite.sdk.domain.WindowDocsEvent 的公开成员。参数和返回类型见下方签名。

<a id="ae1621e8775231eddb45bc4fd32c611ae"></a>

### WindowDocsEvent() [#windowdocsevent-1]

<ApiSignature>

WindowDocsEvent(String event, Options options)

</ApiSignature>

<ParameterList title="参数">
<Parameter name="event">

文档事件。包括以下几种：

- `prevPage`: 上一页。
- `nextPage`: 下一页。
- `prevStep`: 上一步。
- `nextStep`: 下一步。
- `jumpToPage`: 跳转至页码。

</Parameter>
<Parameter name="options">

事件参数。仅当 `event` 为 `jumpToPage` 时需要传入，用于指定期望跳转的页码。

</Parameter>
</ParameterList>

<a id="a9102805f760173eede329af8078eee10"></a>

### JumpToPage() [#jumptopage]

<ApiSignature>

static WindowDocsEvent JumpToPage(Integer page)

</ApiSignature>

跳转至页码。

<ParameterList title="参数">
<Parameter name="page">

期望跳转的页码。

</Parameter>
</ParameterList>

<a id="a375f92bc517c8513aae43357d30a6bac"></a>

### ScalePage() [#scalepage]

<ApiSignature>

static WindowDocsEvent ScalePage(Double scale)

</ApiSignature>

ScalePage：com.herewhite.sdk.domain.WindowDocsEvent 的公开成员。参数和返回类型见下方签名。

<a id="a5bcff9c692d58276b96d338aa5c73156"></a>

### getEvent() [#getevent]

<ApiSignature>

String getEvent()

</ApiSignature>

getEvent：com.herewhite.sdk.domain.WindowDocsEvent 的公开成员。参数和返回类型见下方签名。

<a id="a32edd9a0ef68e400602f3b013cfb45e9"></a>

### setEvent() [#setevent]

<ApiSignature>

void setEvent(String event)

</ApiSignature>

setEvent：com.herewhite.sdk.domain.WindowDocsEvent 的公开成员。参数和返回类型见下方签名。

<a id="a673ca458ec86ecc798f286e4db3d187a"></a>

### getOptions() [#getoptions]

<ApiSignature>

Options getOptions()

</ApiSignature>

getOptions：com.herewhite.sdk.domain.WindowDocsEvent 的公开成员。参数和返回类型见下方签名。

<a id="afcb6a762104dc7aa24aae5a037fc0904"></a>

### setOptions() [#setoptions]

<ApiSignature>

void setOptions(Options options)

</ApiSignature>

setOptions：com.herewhite.sdk.domain.WindowDocsEvent 的公开成员。参数和返回类型见下方签名。

<a id="a104ab15779a3620c2f04f3cd07a914e1"></a>

### withTarget() [#withtarget]

<ApiSignature>

WindowDocsEvent withTarget(String target)

</ApiSignature>

withTarget：com.herewhite.sdk.domain.WindowDocsEvent 的公开成员。参数和返回类型见下方签名。