HarmonyOS 鸿蒙Next开发获取当前应用页面在虚拟键盘弹出时的避让模式

HarmonyOS 鸿蒙Next开发获取当前应用页面在虚拟键盘弹出时的避让模式

import { KeyboardAvoidMode, window } from '@kit.ArkUI'; // 导入ArkUI的window模块
import { common } from '@kit.AbilityKit'; // 导入AbilityKit的common模块

export class AppUtil {
  private static windowStage: window.WindowStage; // 静态变量，用于存储窗口管理器
  private static context: common.UIAbilityContext; // 静态变量，用于存储UIAbility的上下文信息

  /**
   * 初始化方法，缓存全局变量，在UIAbility的onWindowStageCreate方法中调用该方法进行初始化。
   * Initialization method, caches global variables, call this method in the onWindowStageCreate method of UIAbility for initialization.
   * @param context 上下文
   * @param windowStage 窗口管理器
   */
  static init(context: common.UIAbilityContext, windowStage: window.WindowStage) {
    AppUtil.context = context; // 初始化上下文
    AppUtil.windowStage = windowStage; // 初始化窗口管理器
  }

  /**
   * 获取主窗口
   * Get the main window
   */
  static getMainWindow(): window.Window {
    if (!AppUtil.windowStage) { // 如果窗口管理器未初始化
      console.error("windowStage为空，请在UIAbility的onWindowStageCreate方法中调用AppUtil的init方法进行初始化！WindowStage is null, please call the init method of AppUtil in the onWindowStageCreate method of UIAbility for initialization!");
    }
    return AppUtil.windowStage.getMainWindowSync(); // 同步获取主窗口
  }

  /**
   * 获取UIContext
   * @returns
   */
  static getUIContext(): UIContext {
    return AppUtil.getMainWindow().getUIContext();
  }

  /**
   * 获取当前应用页面在虚拟键盘弹出时的避让模式。该模式决定了页面如何适应键盘的出现。
   *
   * @returns 返回当前页面避让虚拟键盘的模式，可能的返回值有：
   *          - KeyboardAvoidMode.OFFSET: 表示页面将上抬以避开键盘，即键盘出现时页面内容会上移。
   *          - KeyboardAvoidMode.RESIZE: 表示页面将重新调整大小以适应键盘，即键盘出现时页面内容将被压缩。
   */
  static getKeyboardAvoidMode(): KeyboardAvoidMode {
    let mode = AppUtil.getUIContext().getKeyboardAvoidMode();
    if (typeof mode === 'string') {
      // 如果获取到的模式是字符串类型，将其转换为对应的枚举值
      if ('KeyBoardAvoidMode.RESIZE' === mode) {
        return KeyboardAvoidMode.RESIZE;
      } else {
        return KeyboardAvoidMode.OFFSET;
      }
    }
    // 如果获取到的模式已经是枚举类型，直接返回
    return mode;
  }
}