• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# @ohos.inputMethod.Panel (Input Method Panel)
2<!--Kit: IME Kit-->
3<!--Subsystem: MiscServices-->
4<!--Owner: @illybyy-->
5<!--Designer: @andeszhang-->
6<!--Tester: @murphy1984-->
7<!--Adviser: @zhang_yixin13-->
8
9The **inputMethod.Panel** module provides APIs for managing the attributes of the input method panel.
10
11> **NOTE**
12>
13>The initial APIs of this module are supported since API version 11. Newly added APIs will be marked with a superscript to indicate their earliest API version.
14
15## Modules to Import
16
17```ts
18import { PanelInfo, PanelType, PanelFlag } from '@kit.IMEKit';
19```
20
21## PanelInfo
22
23Defines the attributes of the input method panel.
24
25**System capability**: SystemCapability.MiscServices.InputMethodFramework
26
27| Name| Type| Mandatory| Description|
28| -------- | -------- | -------- | -------- |
29| type | [PanelType](#paneltype) | Yes| Type of the input method panel.|
30| flag | [PanelFlag](#panelflag) | No| State type of the input method panel.<br>- The default value is **FLAG_FIXED**.<br>- Currently, this parameter is used to describe the state type of the soft keyboard.|
31
32##  PanelType
33
34Enumerates the types of the input method panel.
35
36**System capability**: SystemCapability.MiscServices.InputMethodFramework
37
38| Name         | Value  | Description        |
39| ------------- | ---- | ------------ |
40| SOFT_KEYBOARD | 0    | Soft keyboard.|
41| STATUS_BAR    | 1    | Status bar.|
42
43##  PanelFlag
44
45Enumerates the state types of the input method panel.
46
47**System capability**: SystemCapability.MiscServices.InputMethodFramework
48
49| Name          | Value  | Description                                                        |
50| -------------- | ---- | ------------------------------------------------------------ |
51| FLAG_FIXED     | 0    | Fixed state type.                                            |
52| FLAG_FLOATING  | 1    | Floating state type.                                            |
53| FLAG_CANDIDATE | 2    | Candidate state type.<br>- When in the candidate state type, the input method panel is a window displaying candidates based on user input.<br>- The input method service does not proactively control the visibility of the candidate panel. You need to control the visibility on your own.|
54