@ohos.window (窗口)

窗口提供管理窗口的一些基础能力，包括对当前窗口的创建、销毁、各属性设置，以及对各窗口间的管理调度。

该模块提供以下窗口相关的常用功能：

• Window：当前窗口实例，窗口管理器管理的基本单元。
• WindowStage：窗口管理器。管理各个基本窗口单元。

说明：

本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

导入模块

import window from '@ohos.window';

WindowType⁷⁺

窗口类型枚举。

系统能力： SystemCapability.WindowManager.WindowManager.Core

Configuration⁹⁺

创建子窗口或系统窗口时的参数。

系统能力： SystemCapability.WindowManager.WindowManager.Core

AvoidAreaType⁷⁺

窗口内容需要规避区域的类型枚举。

系统能力： SystemCapability.WindowManager.WindowManager.Core

SystemBarProperties

状态栏、导航栏的属性。

系统能力： SystemCapability.WindowManager.WindowManager.Core

Orientation⁹⁺

窗口显示方向类型枚举。

系统能力： SystemCapability.WindowManager.WindowManager.Core

Rect⁷⁺

窗口矩形区域。

系统能力： SystemCapability.WindowManager.WindowManager.Core

AvoidArea⁷⁺

窗口内容规避区域。如系统栏区域、刘海屏区域、手势区域、软键盘区域等与窗口内容重叠时，需要窗口内容避让的区域。在规避区无法响应用户点击事件。

除此之外还需注意规避区域的如下约束，具体为：

• 底部手势区域中非导航条区域支持点击、长按事件透传，不支持拖入。

• 左右侧边手势区域支持点击、长按以及上下滑动事件透传，不支持拖入。

• 导航条区域支持长按、点击、拖入事件响应，不支持事件向下透传。

系统能力： SystemCapability.WindowManager.WindowManager.Core

Size⁷⁺

窗口大小。

系统能力： SystemCapability.WindowManager.WindowManager.Core

WindowProperties

窗口属性。

系统能力： SystemCapability.WindowManager.WindowManager.Core

ColorSpace⁸⁺

色域模式。

系统能力： SystemCapability.WindowManager.WindowManager.Core

WindowEventType¹⁰⁺

窗口生命周期。

WindowLimits¹¹⁺

窗口尺寸限制参数。可以通过setWindowLimits设置窗口尺寸限制，并且可以通过getWindowLimits获得当前的窗口尺寸限制。

系统能力： SystemCapability.Window.SessionManager

WindowStatusType¹¹⁺

窗口模式枚举。

系统能力： SystemCapability.Window.SessionManager

TitleButtonRect¹¹⁺

标题栏上的最小化、最大化、关闭按钮矩形区域，该区域位置坐标相对窗口右上角。

系统能力： SystemCapability.Window.SessionManager

window.createWindow⁹⁺

createWindow(config: Configuration, callback: AsyncCallback<Window>): void

创建子窗口或者系统窗口，使用callback异步回调。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

import { BusinessError } from '@ohos.base';

let windowClass: window.Window | undefined = undefined;
let config: window.Configuration = {
  name: "test",
  windowType: window.WindowType.TYPE_DIALOG,
  ctx: this.context
};
try {
  window.createWindow(config, (err: BusinessError, data) => {
    const errCode: number = err.code;
    if (errCode) {
      console.error('Failed to create the window. Cause: ' + JSON.stringify(err));
      return;
    }
    windowClass = data;
    console.info('Succeeded in creating the window. Data: ' + JSON.stringify(data));
    windowClass.resize(500, 1000);
  });
} catch (exception) {
  console.error('Failed to create the window. Cause: ' + JSON.stringify(exception));
}

window.createWindow⁹⁺

createWindow(config: Configuration): Promise<Window>

创建子窗口或者系统窗口，使用Promise异步回调。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

返回值：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

import { BusinessError } from '@ohos.base';

let windowClass: window.Window | undefined = undefined;
let config: window.Configuration = {
  name: "test",
  windowType: window.WindowType.TYPE_DIALOG,
  ctx: this.context
};
try {
  let promise = window.createWindow(config);
  promise.then((data) => {
    windowClass = data;
    console.info('Succeeded in creating the window. Data:' + JSON.stringify(data));
  }).catch((err: BusinessError) => {
    console.error('Failed to create the Window. Cause:' + JSON.stringify(err));
  });
} catch (exception) {
  console.error('Failed to create the window. Cause: ' + JSON.stringify(exception));
}

window.findWindow⁹⁺

findWindow(name: string): Window

查找name所对应的窗口。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

返回值：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

let windowClass: window.Window | undefined = undefined;
try {
  windowClass = window.findWindow('test');
} catch (exception) {
  console.error('Failed to find the Window. Cause: ' + JSON.stringify(exception));
}

window.getLastWindow⁹⁺

getLastWindow(ctx: BaseContext, callback: AsyncCallback<Window>): void

获取当前应用内最上层的子窗口，若无应用子窗口，则返回应用主窗口，使用callback异步回调。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

import UIAbility from '@ohos.app.ability.UIAbility';
import window from '@ohos.window';
import { BusinessError } from '@ohos.base';

export default class EntryAbility extends UIAbility {
  // ...
  onWindowStageCreate(windowStage: window.WindowStage) {
    console.info('onWindowStageCreate');
    let windowClass: window.Window | undefined = undefined;
    try {
      window.getLastWindow(this.context, (err: BusinessError, data) => {
        const errCode: number = err.code;
        if (errCode) {
          console.error('Failed to obtain the top window. Cause: ' + JSON.stringify(err));
          return;
        }
        windowClass = data;
        console.info('Succeeded in obtaining the top window. Data: ' + JSON.stringify(data));
      });
    } catch (exception) {
      console.error('Failed to obtain the top window. Cause: ' + JSON.stringify(exception));
    }
  }
}

window.getLastWindow⁹⁺

getLastWindow(ctx: BaseContext): Promise<Window>

获取当前应用内最上层的子窗口，若无应用子窗口，则返回应用主窗口，使用Promise异步回调。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

返回值：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

import UIAbility from '@ohos.app.ability.UIAbility';
import window from '@ohos.window';
import { BusinessError } from '@ohos.base';

export default class EntryAbility extends UIAbility {
  // ...
  onWindowStageCreate(windowStage: window.WindowStage) {
    console.info('onWindowStageCreate');
    let windowClass: window.Window | undefined = undefined;
    try {
      let promise = window.getLastWindow(this.context);
      promise.then((data) => {
        windowClass = data;
        console.info('Succeeded in obtaining the top window. Data: ' + JSON.stringify(data));
      }).catch((err: BusinessError) => {
        console.error('Failed to obtain the top window. Cause: ' + JSON.stringify(err));
      });
    } catch (exception) {
      console.error('Failed to obtain the top window. Cause: ' + JSON.stringify(exception));
    }
  }
}

window.shiftAppWindowFocus¹¹⁺

shiftAppWindowFocus(sourceWindowId: number, targetWindowId: number): Promise<void>

在同应用内将窗口焦点从源窗口转移到目标窗口，仅支持应用主窗和子窗的焦点转移。

系统能力： SystemCapability.Window.SessionManager

参数：

返回值：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

import UIAbility from '@ohos.app.ability.UIAbility';
import window from '@ohos.window';
import { BusinessError } from '@ohos.base';

export default class EntryAbility extends UIAbility {
  onWindowStageCreate(windowStage: window.WindowStage) {
    // ...
    console.info('onWindowStageCreate');
    let windowClass: window.Window | undefined = undefined;
    let subWindowClass: window.Window | undefined = undefined;
    let windowClassId: number = -1;
    let subWindowClassId: number = -1;

    // 获取应用主窗及ID
    try {
      let promise = windowStage.getMainWindow();
      promise.then((data) => {
        if (data == null) {
          console.error("Failed to obtaining the window. Cause: The data is empty");
          return;
        }
        windowClass = data;
        windowClass.setUIContent("pages/Index");
        try {
          windowClassId = windowClass.getWindowProperties().id;
        } catch (exception) {
          console.error('Failed to obtain the window. Cause: ' + JSON.stringify(exception))
        }
        console.info('Succeeded in obtaining the window')
      }).catch((err: BusinessError) => {
        console.error('Failed to obtaining the window. Cause: ' + JSON.stringify(err))
      })
    } catch (exception) {
      console.error('Failed to obtain the window. Cause: ' + JSON.stringify(exception))
    }

    // 创建或获取子窗及ID，此时子窗口获焦
    try {
      let promise = windowStage.createSubWindow("testSubWindow");
      promise.then((data) => {
        if (data == null) {
          console.error("Failed to obtaining the window. Cause: The data is empty");
          return;
        }
        subWindowClass = data;
        try {
          subWindowClassId = subWindowClass.getWindowProperties().id;
        } catch (exception) {
          console.error('Failed to obtain the window. Cause: ' + JSON.stringify(exception))
        }
        subWindowClass.resize(500, 500);
        subWindowClass.setUIContent("pages/Index2");
        subWindowClass.showWindow();

        // 监听Window状态，确保已经就绪
        subWindowClass.on("windowEvent", (windowEvent) => {
          if (windowEvent == window.WindowEventType.WINDOW_ACTIVE) {
            // 切换焦点
            try {
              let promise = window.shiftAppWindowFocus(subWindowClassId, windowClassId);
              promise.then(() => {
                console.info('Succeeded in shifting app window focus');
              }).catch((err: BusinessError) => {
                console.error('Failed to shift app window focus. Cause: ' + JSON.stringify(err));
              })
            } catch (exception) {
              console.error('Failed to shift app window focus. Cause: ' + JSON.stringify(exception));
            }
          }
        })
      })
    } catch (exception) {
      console.error('Failed to create the subWindow. Cause: ' + JSON.stringify(exception));
    }
  }
}

window.create^(deprecated)

create(id: string, type: WindowType, callback: AsyncCallback<Window>): void

创建子窗口，使用callback异步回调。

说明：

从 API version 7开始支持，从API version 9开始废弃，推荐使用createWindow()。

模型约束： 此接口仅可在FA模型下使用。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

示例：

import { BusinessError } from '@ohos.base';

let windowClass: window.Window | undefined = undefined;
window.create('test', window.WindowType.TYPE_APP, (err: BusinessError, data) => {
  const errCode: number = err.code;
  if (errCode) {
    console.error('Failed to create the subWindow. Cause: ' + JSON.stringify(err));
    return;
  }
  windowClass = data;
  console.info('Succeeded in creating the subWindow. Data: ' + JSON.stringify(data));
});

window.create^(deprecated)

create(id: string, type: WindowType): Promise<Window>

创建子窗口，使用Promise异步回调。

说明：

从 API version 7开始支持，从API version 9开始废弃，推荐使用createWindow()。

模型约束： 此接口仅可在FA模型下使用。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

返回值：

示例：

import { BusinessError } from '@ohos.base';

let windowClass: window.Window | undefined = undefined;
let promise = window.create('test', window.WindowType.TYPE_APP);
promise.then((data) => {
  windowClass = data;
  console.info('Succeeded in creating the subWindow. Data: ' + JSON.stringify(data));
}).catch((err: BusinessError) => {
  console.error('Failed to create the subWindow. Cause: ' + JSON.stringify(err));
});

window.create^(deprecated)

create(ctx: BaseContext, id: string, type: WindowType, callback: AsyncCallback<Window>): void

创建系统窗口，使用callback异步回调。

说明：

从 API version 7开始支持，从API version 9开始废弃，推荐使用createWindow()。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

示例：

import { BusinessError } from '@ohos.base';

let windowClass: window.Window | undefined = undefined;
window.create('test', window.WindowType.TYPE_SYSTEM_ALERT, (err: BusinessError, data) => {
  const errCode: number = err.code;
  if (errCode) {
    console.error('Failed to create the window. Cause: ' + JSON.stringify(err));
    return;
  }
  windowClass = data;
  console.info('Succeeded in creating the window. Data: ' + JSON.stringify(data));
  windowClass.resetSize(500, 1000);
});

window.create^(deprecated)

create(ctx: BaseContext, id: string, type: WindowType): Promise<Window>

创建系统窗口，使用Promise异步回调。

说明：

从 API version 7开始支持，从API version 9开始废弃，推荐使用createWindow()。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

返回值：

示例：

import { BusinessError } from '@ohos.base';

let windowClass: window.Window | undefined = undefined;
let promise = window.create('test', window.WindowType.TYPE_SYSTEM_ALERT);
promise.then((data) => {
  windowClass = data;
  console.info('Succeeded in creating the window. Data:' + JSON.stringify(data));
}).catch((err: BusinessError) => {
  console.error('Failed to create the Window. Cause:' + JSON.stringify(err));
});

window.find^(deprecated)

find(id: string, callback: AsyncCallback<Window>): void

查找id所对应的窗口，使用callback异步回调。

说明：

从 API version 7开始支持，从API version 9开始废弃，推荐使用findWindow()。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

示例：

import { BusinessError } from '@ohos.base';

let windowClass: window.Window | undefined = undefined;
window.find('test', (err: BusinessError, data) => {
  const errCode: number = err.code;
  if (errCode) {
    console.error('Failed to find the Window. Cause: ' + JSON.stringify(err));
    return;
  }
  windowClass = data;
  console.info('Succeeded in finding the window. Data: ' + JSON.stringify(data));
});

window.find^(deprecated)

find(id: string): Promise<Window>

查找id所对应的窗口，使用Promise异步回调。

说明：

从 API version 7开始支持，从API version 9开始废弃，推荐使用findWindow()。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

返回值：

示例：

import { BusinessError } from '@ohos.base';

let windowClass: window.Window | undefined = undefined;
let promise = window.find('test');
promise.then((data) => {
  windowClass = data;
  console.info('Succeeded in finding the window. Data: ' + JSON.stringify(data));
}).catch((err: BusinessError) => {
  console.error('Failed to find the Window. Cause: ' + JSON.stringify(err));
});

window.getTopWindow^(deprecated)

getTopWindow(callback: AsyncCallback<Window>): void

获取当前应用内最后显示的窗口，使用callback异步回调。

说明：

从 API version 6开始支持，从API version 9开始废弃，推荐使用getLastWindow()。

模型约束： 此接口仅可在FA模型下使用。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

示例：

import { BusinessError } from '@ohos.base';

let windowClass: window.Window | undefined = undefined;
window.getTopWindow((err: BusinessError, data) => {
  const errCode: number = err.code;
  if (errCode) {
    console.error('Failed to obtain the top window. Cause: ' + JSON.stringify(err));
    return;
  }
  windowClass = data;
  console.info('Succeeded in obtaining the top window. Data: ' + JSON.stringify(data));
});

window.getTopWindow^(deprecated)

getTopWindow(): Promise<Window>

获取当前应用内最后显示的窗口，使用Promise异步回调。

说明：

从 API version 6开始支持，从API version 9开始废弃，推荐使用getLastWindow()。

模型约束： 此接口仅可在FA模型下使用。

系统能力： SystemCapability.WindowManager.WindowManager.Core

返回值：

示例：

import { BusinessError } from '@ohos.base';

let windowClass: window.Window | undefined = undefined;
let promise = window.getTopWindow();
promise.then((data)=> {
  windowClass = data;
  console.info('Succeeded in obtaining the top window. Data: ' + JSON.stringify(data));
}).catch((err: BusinessError)=>{
  console.error('Failed to obtain the top window. Cause: ' + JSON.stringify(err));
});

window.getTopWindow^(deprecated)

getTopWindow(ctx: BaseContext, callback: AsyncCallback<Window>): void

获取当前应用内最后显示的窗口，使用callback异步回调。

说明：

从 API version 8开始支持，从API version 9开始废弃，推荐使用getLastWindow()。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

示例：

import { BusinessError } from '@ohos.base';

export default class EntryAbility extends UIAbility {
  onWindowStageCreate(windowStage:window.WindowStage){
    console.info('onWindowStageCreate');
    let windowClass: window.Window | undefined = undefined;
    try {
      window.getTopWindow(this.context, (err: BusinessError, data) => {
        const errCode: number = err.code;
        if(errCode){
          console.error('Failed to obtain the top window. Cause: ' + JSON.stringify(err));
          return ;
        }
        windowClass = data;
        console.info('Succeeded in obtaining the top window. Data: ' + JSON.stringify(data));
      });
    } catch(error){
      console.error('Failed to obtain the top window. Cause: ' + JSON.stringify(error));
    }
  }
}

window.getTopWindow^(deprecated)

getTopWindow(ctx: BaseContext): Promise<Window>

获取当前应用内最后显示的窗口，使用Promise异步回调。

说明：

从 API version 8开始支持，从API version 9开始废弃，推荐使用getLastWindow()。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

返回值：

示例：

import { BusinessError } from '@ohos.base';

export default class EntryAbility extends UIAbility {
  onWindowStageCreate(windowStage:window.WindowStage) {
    console.info('onWindowStageCreate');
    let windowClass: window.Window | undefined = undefined;
    let promise = window.getTopWindow(this.context);
    promise.then((data) => {
      windowClass = data;
      console.info('Succeeded in obtaining the top window. Data: ' + JSON.stringify(data));
    }).catch((error: BusinessError) => {
      console.error('Failed to obtain the top window. Cause: ' + JSON.stringify(error));
    });
  }
}

SpecificSystemBar¹¹⁺

当前支持显示或隐藏的系统栏类型。

系统能力： SystemCapability.Window.SessionManager

Window

当前窗口实例，窗口管理器管理的基本单元。

下列API示例中都需先使用getLastWindow()、createWindow()、findWindow()中的任一方法获取到Window实例（windowClass），再通过此实例调用对应方法。

showWindow⁹⁺

showWindow(callback: AsyncCallback<void>): void

显示当前窗口，使用callback异步回调。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

import { BusinessError } from '@ohos.base';

windowClass.showWindow((err: BusinessError) => {
  const errCode: number = err.code;
  if (errCode) {
    console.error('Failed to show the window. Cause: ' + JSON.stringify(err));
    return;
  }
  console.info('Succeeded in showing the window.');
});

showWindow⁹⁺

showWindow(): Promise<void>

显示当前窗口，使用Promise异步回调。

系统能力： SystemCapability.WindowManager.WindowManager.Core

返回值：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

import { BusinessError } from '@ohos.base';

let promise = windowClass.showWindow();
promise.then(() => {
  console.info('Succeeded in showing the window.');
}).catch((err: BusinessError) => {
  console.error('Failed to show the window. Cause: ' + JSON.stringify(err));
});

destroyWindow⁹⁺

destroyWindow(callback: AsyncCallback<void>): void

销毁当前窗口，使用callback异步回调。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

import { BusinessError } from '@ohos.base';

windowClass.destroyWindow((err) => {
  const errCode: number = err.code;
  if (errCode) {
    console.error('Failed to destroy the window. Cause:' + JSON.stringify(err));
    return;
  }
  console.info('Succeeded in destroying the window.');
});

destroyWindow⁹⁺

destroyWindow(): Promise<void>

销毁当前窗口，使用Promise异步回调。

系统能力： SystemCapability.WindowManager.WindowManager.Core

返回值：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

import { BusinessError } from '@ohos.base';

let promise = windowClass.destroyWindow();
promise.then(() => {
  console.info('Succeeded in destroying the window.');
}).catch((err: BusinessError) => {
  console.error('Failed to destroy the window. Cause: ' + JSON.stringify(err));
});

moveWindowTo⁹⁺

moveWindowTo(x: number, y: number, callback: AsyncCallback<void>): void

移动窗口位置，使用callback异步回调。

全屏模式窗口不支持该操作。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

import { BusinessError } from '@ohos.base';

try {
  windowClass.moveWindowTo(300, 300, (err: BusinessError) => {
    const errCode: number = err.code;
    if (errCode) {
      console.error('Failed to move the window. Cause:' + JSON.stringify(err));
      return;
    }
    console.info('Succeeded in moving the window.');
  });
} catch (exception) {
  console.error('Failed to move the window. Cause:' + JSON.stringify(exception));
}

moveWindowTo⁹⁺

moveWindowTo(x: number, y: number): Promise<void>

移动窗口位置，使用Promise异步回调。

全屏模式窗口不支持该操作。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

返回值：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

import { BusinessError } from '@ohos.base';

try {
  let promise = windowClass.moveWindowTo(300, 300);
  promise.then(() => {
    console.info('Succeeded in moving the window.');
  }).catch((err: BusinessError) => {
    console.error('Failed to move the window. Cause: ' + JSON.stringify(err));
  });
} catch (exception) {
  console.error('Failed to move the window. Cause:' + JSON.stringify(exception));
}

resize⁹⁺

resize(width: number, height: number, callback: AsyncCallback<void>): void

改变当前窗口大小，使用callback异步回调。

应用主窗口与子窗口存在大小限制，默认宽度范围：[320, 1920]，默认高度范围：[240, 1920]，单位为vp。 应用主窗口与子窗口的最小宽度与最小高度可由产品端进行配置，配置后的最小宽度与最小高度以产品段配置值为准，具体尺寸限制范围可以通过getWindowLimits接口进行查询。

系统窗口存在大小限制，宽度范围：[0, 1920]，高度范围：[0, 1920]，单位为vp。

设置的宽度与高度受到此约束限制，规则： 若所设置的窗口宽/高尺寸小于窗口最小宽/高限值，则窗口最小宽/高限值生效； 若所设置的窗口宽/高尺寸大于窗口最大宽/高限值，则窗口最大宽/高限值生效。

全屏模式窗口不支持该操作。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

import { BusinessError } from '@ohos.base';

try {
  windowClass.resize(500, 1000, (err: BusinessError) => {
    const errCode: number = err.code;
    if (errCode) {
      console.error('Failed to change the window size. Cause:' + JSON.stringify(err));
      return;
    }
    console.info('Succeeded in changing the window size.');
  });
} catch (exception) {
  console.error('Failed to change the window size. Cause:' + JSON.stringify(exception));
}

resize⁹⁺

resize(width: number, height: number): Promise<void>

改变当前窗口大小，使用Promise异步回调。

应用主窗口与子窗口存在大小限制，默认宽度范围：[320, 1920]，默认高度范围：[240, 1920]，单位为vp。 应用主窗口与子窗口的最小宽度与最小高度可由产品端进行配置，配置后的最小宽度与最小高度以产品段配置值为准，具体尺寸限制范围可以通过getWindowLimits接口进行查询。

系统窗口存在大小限制，宽度范围：[0, 1920]，高度范围：[0, 1920]，单位为vp。

设置的宽度与高度受到此约束限制，规则： 若所设置的窗口宽/高尺寸小于窗口最小宽/高限值，则窗口最小宽/高限值生效； 若所设置的窗口宽/高尺寸大于窗口最大宽/高限值，则窗口最大宽/高限值生效。

全屏模式窗口不支持该操作。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

返回值：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

import { BusinessError } from '@ohos.base';

try {
  let promise = windowClass.resize(500, 1000);
  promise.then(() => {
    console.info('Succeeded in changing the window size.');
  }).catch((err: BusinessError) => {
    console.error('Failed to change the window size. Cause: ' + JSON.stringify(err));
  });
} catch (exception) {
  console.error('Failed to change the window size. Cause: ' + JSON.stringify(exception));
}

getWindowProperties⁹⁺

getWindowProperties(): WindowProperties

获取当前窗口的属性，返回WindowProperties。

系统能力： SystemCapability.WindowManager.WindowManager.Core

返回值：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

try {
  let properties = windowClass.getWindowProperties();
} catch (exception) {
  console.error('Failed to obtain the window properties. Cause: ' + JSON.stringify(exception));
}

getWindowAvoidArea⁹⁺

getWindowAvoidArea(type: AvoidAreaType): AvoidArea

获取窗口内容规避的区域；如系统栏区域、刘海屏区域、手势区域、软键盘区域等与窗口内容重叠时，需要窗口内容避让的区域。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

返回值：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

let type = window.AvoidAreaType.TYPE_SYSTEM;
try {
  let avoidArea = windowClass.getWindowAvoidArea(type);
} catch (exception) {
  console.error('Failed to obtain the area. Cause:' + JSON.stringify(exception));
}

setWindowLayoutFullScreen⁹⁺

setWindowLayoutFullScreen(isLayoutFullScreen: boolean, callback: AsyncCallback<void>): void

设置窗口的布局是否为沉浸式布局，使用callback异步回调。 沉浸式布局是指布局不避让状态栏与导航栏，组件可能产生与其重叠的情况。 非沉浸式布局是指布局避让状态栏与导航栏，组件不会与其重叠。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

import { BusinessError } from '@ohos.base';

let isLayoutFullScreen = true;
try {
  windowClass.setWindowLayoutFullScreen(isLayoutFullScreen, (err: BusinessError) => {
    const errCode: number = err.code;
    if (errCode) {
      console.error('Failed to set the window layout to full-screen mode. Cause:' + JSON.stringify(err));
      return;
    }
    console.info('Succeeded in setting the window layout to full-screen mode.');
  });
} catch (exception) {
  console.error('Failed to set the window layout to full-screen mode. Cause:' + JSON.stringify(exception));
}

setWindowLayoutFullScreen⁹⁺

setWindowLayoutFullScreen(isLayoutFullScreen: boolean): Promise<void>

设置窗口的布局是否为沉浸式布局，使用Promise异步回调。 沉浸式布局是指布局不避让状态栏与导航栏，组件可能产生与其重叠的情况。 非沉浸式布局是指布局避让状态栏与导航栏，组件不会与其重叠。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

返回值：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

import { BusinessError } from '@ohos.base';

let isLayoutFullScreen = true;
try {
  let promise = windowClass.setWindowLayoutFullScreen(isLayoutFullScreen);
  promise.then(() => {
    console.info('Succeeded in setting the window layout to full-screen mode.');
  }).catch((err: BusinessError) => {
    console.error('Failed to set the window layout to full-screen mode. Cause:' + JSON.stringify(err));
  });
} catch (exception) {
  console.error('Failed to set the window layout to full-screen mode. Cause:' + JSON.stringify(exception));
}

setWindowSystemBarEnable⁹⁺

setWindowSystemBarEnable(names: Array<'status' | 'navigation'>, callback: AsyncCallback<void>): void

设置窗口全屏模式时导航栏、状态栏的可见模式，使用callback异步回调。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

// 此处以不显示导航栏、状态栏为例
import { BusinessError } from '@ohos.base';

let names: Array<'status' | 'navigation'> = [];
try {
  windowClass.setWindowSystemBarEnable(names, (err: BusinessError) => {
    const errCode: number = err.code;
    if (errCode) {
      console.error('Failed to set the system bar to be invisible. Cause:' + JSON.stringify(err));
      return;
    }
    console.info('Succeeded in setting the system bar to be invisible.');
  });
} catch (exception) {
  console.error('Failed to set the system bar to be invisible. Cause:' + JSON.stringify(exception));
}

setWindowSystemBarEnable⁹⁺

setWindowSystemBarEnable(names: Array<'status' | 'navigation'>): Promise<void>

设置窗口全屏模式时导航栏、状态栏的可见模式，使用Promise异步回调。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

返回值：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

// 此处以不显示导航栏、状态栏为例
import { BusinessError } from '@ohos.base';

let names: Array<'status' | 'navigation'> = [];
try {
  let promise = windowClass.setWindowSystemBarEnable(names);
  promise.then(() => {
    console.info('Succeeded in setting the system bar to be invisible.');
  }).catch((err: BusinessError) => {
    console.error('Failed to set the system bar to be invisible. Cause:' + JSON.stringify(err));
  });
} catch (exception) {
  console.error('Failed to set the system bar to be invisible. Cause:' + JSON.stringify(exception));
}

setSpecificSystemBarEnabled¹¹⁺

setSpecificSystemBarEnabled(name: SpecificSystemBar, enable: boolean): Promise<void>

设置窗口全屏模式时导航栏、状态栏、底部导航条的显示和隐藏，使用Promise异步回调。

系统能力： SystemCapability.Window.SessionManager

参数：

返回值：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

// 此处以隐藏底部导航条为例
import { BusinessError } from '@ohos.base';

try {
  let promise = windowClass.setSpecificSystemBarEnabled('navigationIndicator', false);
  promise.then(() => {
    console.info('Succeeded in setting the system bar to be invisible.');
  }).catch((err: BusinessError) => {
    console.error('Failed to set the system bar to be invisible. Cause:' + JSON.stringify(err));
  });
} catch (exception) {
  console.error('Failed to set the system bar to be invisible. Cause:' + JSON.stringify(exception));
}

setWindowSystemBarProperties⁹⁺

setWindowSystemBarProperties(systemBarProperties: SystemBarProperties, callback: AsyncCallback<void>): void

设置窗口全屏模式时窗口内导航栏、状态栏的属性，使用callback异步回调。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

import { BusinessError } from '@ohos.base';

let SystemBarProperties: window.SystemBarProperties = {
  statusBarColor: '#ff00ff',
  navigationBarColor: '#00ff00',
  //以下两个属性从API Version8开始支持
  statusBarContentColor: '#ffffff',
  navigationBarContentColor: '#00ffff'
};
try {
  windowClass.setWindowSystemBarProperties(SystemBarProperties, (err: BusinessError) => {
    const errCode: number = err.code;
    if (errCode) {
      console.error('Failed to set the system bar properties. Cause: ' + JSON.stringify(err));
      return;
    }
    console.info('Succeeded in setting the system bar properties.');
  });
} catch (exception) {
  console.error('Failed to set the system bar properties. Cause: ' + JSON.stringify(exception));
}

setWindowSystemBarProperties⁹⁺

setWindowSystemBarProperties(systemBarProperties: SystemBarProperties): Promise<void>

设置窗口全屏模式时窗口内导航栏、状态栏的属性，使用Promise异步回调。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

返回值：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

import { BusinessError } from '@ohos.base';

let SystemBarProperties: window.SystemBarProperties = {
  statusBarColor: '#ff00ff',
  navigationBarColor: '#00ff00',
  //以下两个属性从API Version8开始支持
  statusBarContentColor: '#ffffff',
  navigationBarContentColor: '#00ffff'
};
try {
  let promise = windowClass.setWindowSystemBarProperties(SystemBarProperties);
  promise.then(() => {
    console.info('Succeeded in setting the system bar properties.');
  }).catch((err: BusinessError) => {
    console.error('Failed to set the system bar properties. Cause: ' + JSON.stringify(err));
  });
} catch (exception) {
  console.error('Failed to set the system bar properties. Cause: ' + JSON.stringify(exception));
}

setPreferredOrientation⁹⁺

setPreferredOrientation(orientation: Orientation, callback: AsyncCallback<void>): void

设置窗口的显示方向属性，使用callback异步回调。仅在支持跟随sensor旋转的设备上生效。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

import { BusinessError } from '@ohos.base';

let orientation = window.Orientation.AUTO_ROTATION;
try {
  windowClass.setPreferredOrientation(orientation, (err: BusinessError) => {
    const errCode: number = err.code;
    if (errCode) {
      console.error('Failed to set window orientation. Cause: ' + JSON.stringify(err));
      return;
    }
    console.info('Succeeded in setting window orientation.');
  });
} catch (exception) {
  console.error('Failed to set window orientation. Cause: ' + JSON.stringify(exception));
}

setPreferredOrientation⁹⁺

setPreferredOrientation(orientation: Orientation): Promise<void>

设置窗口的显示方向属性，使用Promise异步回调。仅在支持跟随sensor旋转的设备上生效。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

返回值：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

import { BusinessError } from '@ohos.base';

let orientation = window.Orientation.AUTO_ROTATION;
try {
  let promise = windowClass.setPreferredOrientation(orientation);
  promise.then(() => {
    console.info('Succeeded in setting the window orientation.');
  }).catch((err: BusinessError) => {
    console.error('Failed to set the window orientation. Cause: ' + JSON.stringify(err));
  });
} catch (exception) {
  console.error('Failed to set window orientation. Cause: ' + JSON.stringify(exception));
}

getUIContext¹⁰⁺

getUIContext(): UIContext

获取UIContext实例。

模型约束： 此接口仅可在Stage模型下使用。

系统能力： SystemCapability.WindowManager.WindowManager.Core

返回值：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

import UIAbility from '@ohos.app.ability.UIAbility';
import window from '@ohos.window';
import { BusinessError } from '@ohos.base';
import { UIContext } from '@ohos.arkui.UIContext';

export default class EntryAbility extends UIAbility {
  onWindowStageCreate(windowStage: window.WindowStage) {
    // 为主窗口加载对应的目标页面。
    windowStage.loadContent("pages/page2", (err: BusinessError) => {
      let errCode: number = err.code;
      if (errCode) {
        console.error('Failed to load the content. Cause:' + JSON.stringify(err));
        return;
      }
      console.info('Succeeded in loading the content.');
      // 获取应用主窗口。
      let windowClass: window.Window | undefined = undefined;
      windowStage.getMainWindow((err: BusinessError, data) => {
        let errCode: number = err.code;
        if (errCode) {
          console.error('Failed to obtain the main window. Cause: ' + JSON.stringify(err));
          return;
        }
        windowClass = data;
        console.info('Succeeded in obtaining the main window. Data: ' + JSON.stringify(data));
        // 获取UIContext实例。
        let uiContext: UIContext | null = null;
        uiContext = windowClass.getUIContext();
      })
    });
  }
};

setUIContent⁹⁺

setUIContent(path: string, callback: AsyncCallback<void>): void

根据当前工程中某个页面的路径为窗口加载具体页面内容，使用callback异步回调。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

import { BusinessError } from '@ohos.base';

try {
  windowClass.setUIContent('pages/page2/page3', (err: BusinessError) => {
    const errCode: number = err.code;
    if (errCode) {
      console.error('Failed to load the content. Cause:' + JSON.stringify(err));
      return;
    }
    console.info('Succeeded in loading the content.');
  });
} catch (exception) {
  console.error('Failed to load the content. Cause:' + JSON.stringify(exception));
}

setUIContent⁹⁺

setUIContent(path: string): Promise<void>

根据当前工程中某个页面的路径为窗口加载具体页面内容，使用Promise异步回调。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

返回值：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

import { BusinessError } from '@ohos.base';

try {
  let promise = windowClass.setUIContent('pages/page2/page3');
  promise.then(() => {
    console.info('Succeeded in loading the content.');
  }).catch((err: BusinessError) => {
    console.error('Failed to load the content. Cause: ' + JSON.stringify(err));
  });
} catch (exception) {
  console.error('Failed to load the content. Cause: ' + JSON.stringify(exception));
}

loadContent⁹⁺

loadContent(path: string, storage: LocalStorage, callback: AsyncCallback<void>): void

根据当前工程中某个页面的路径为窗口加载具体页面内容，通过LocalStorage传递状态属性给加载的页面，使用callback异步回调。

模型约束： 此接口仅可在Stage模型下使用。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

import UIAbility from '@ohos.app.ability.UIAbility';
import window from '@ohos.window';
import { BusinessError } from '@ohos.base';

export default class EntryAbility extends UIAbility {
  // ...

  onWindowStageCreate(windowStage: window.WindowStage) {
    console.info('onWindowStageCreate');
    let storage: LocalStorage = new LocalStorage();
    storage.setOrCreate('storageSimpleProp', 121);
    try {
      if (!windowClass) {
        console.info('Failed to load the content. Cause: windowClass is null');
      }
      else {
        (windowClass as window.Window).loadContent('pages/page2', storage, (err: BusinessError) => {
          const errCode: number = err.code;
          if (errCode) {
            console.error('Failed to load the content. Cause:' + JSON.stringify(err));
            return;
          }
          console.info('Succeeded in loading the content.');
        });
      }
    } catch (exception) {
      console.error('Failed to load the content. Cause:' + JSON.stringify(exception));
    }
  }
};

loadContent⁹⁺

loadContent(path: string, storage: LocalStorage): Promise<void>

根据当前工程中某个页面的路径为窗口加载具体页面内容，通过LocalStorage传递状态属性给加载的页面，使用Promise异步回调。

模型约束： 此接口仅可在Stage模型下使用。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

返回值：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

import UIAbility from '@ohos.app.ability.UIAbility';
import window from '@ohos.window';
import { BusinessError } from '@ohos.base';

export default class EntryAbility extends UIAbility {
  // ...

  onWindowStageCreate(windowStage: window.WindowStage) {
    console.info('onWindowStageCreate');
    let storage: LocalStorage = new LocalStorage();
    storage.setOrCreate('storageSimpleProp', 121);
    try {
      if (!windowClass) {
        console.info('Failed to load the content. Cause: windowClass is null');
      }
      else {
        let promise = (windowClass as window.Window).loadContent('pages/page2', storage);
        promise.then(() => {
          console.info('Succeeded in loading the content.');
        }).catch((err: BusinessError) => {
          console.error('Failed to load the content. Cause:' + JSON.stringify(err));
        });
      }
    } catch (exception) {
      console.error('Failed to load the content. Cause:' + JSON.stringify(exception));
    }
  }
};

loadContentByName¹¹⁺

loadContentByName(name: string, storage: LocalStorage, callback: AsyncCallback<void>): void

为当前窗口加载命名路由页面，通过LocalStorage传递状态属性给加载的页面，使用callback异步回调。

模型约束： 此接口仅可在Stage模型下使用。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

import window from '@ohos.window';
import { BusinessError } from '@ohos.base';
import * as Index from '../pages/Index'; // 导入命名路由页面

console.info('onWindowStageCreate');
let storage: LocalStorage = new LocalStorage();
storage.setOrCreate('storageSimpleProp', 121);
try {
  (windowClass as window.Window).loadContentByName(Index.entryName, storage, (err: BusinessError) => {
    const errCode: number = err.code;
    if (errCode) {
      console.error(`Failed to load the content. Cause code: ${err.code}, message: ${err.message}`);
      return;
    }
    console.info('Succeeded in loading the content.');
  });
} catch (exception) {
  console.error(`Failed to load the content. Cause code: ${exception.code}, message: ${exception.message}`);
}

// ets/pages/Index.ets
export const entryName : string = 'Index';
@Entry({routeName: entryName, storage : LocalStorage.getShared()})
@Component
export struct Index {
  @State message: string = 'Hello World'
  build() {
    Row() {
      Column() {
        Text(this.message)
          .fontSize(50)
          .fontWeight(FontWeight.Bold)
      }
      .width('100%')
    }
    .height('100%')
  }
}

loadContentByName¹¹⁺

loadContentByName(name: string, callback: AsyncCallback<void>): void

为当前窗口加载命名路由页面内容，使用callback异步回调。

模型约束： 此接口仅可在Stage模型下使用。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

import window from '@ohos.window';
import { BusinessError } from '@ohos.base';
import * as Index from '../pages/Index'; // 导入命名路由页面

try {  
  (windowClass as window.Window).loadContentByName(Index.entryName, (err: BusinessError) => {
    const errCode: number = err.code;
    if (errCode) {
      console.error(`Failed to load the content. Cause code: ${err.code}, message: ${err.message}`);
      return;
    }
    console.info('Succeeded in loading the content.');
  });
} catch (exception) {
  console.error(`Failed to load the content. Cause code: ${exception.code}, message: ${exception.message}`);
}

// ets/pages/Index.ets
export const entryName : string = 'Index';
@Entry({routeName: entryName})
@Component
export struct Index {
  @State message: string = 'Hello World'
  build() {
    Row() {
      Column() {
        Text(this.message)
          .fontSize(50)
          .fontWeight(FontWeight.Bold)
      }
      .width('100%')
    }
    .height('100%')
  }
}

loadContentByName¹¹⁺

loadContentByName(name: string, storage?: LocalStorage): Promise<void>

为当前窗口加载命名路由页面，通过LocalStorage传递状态属性给加载的页面，使用Promise异步回调。

模型约束： 此接口仅可在Stage模型下使用。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

返回值：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

import window from '@ohos.window';
import { BusinessError } from '@ohos.base';
import * as Index from '../pages/Index'; // 导入命名路由页面

let storage: LocalStorage = new LocalStorage();
storage.setOrCreate('storageSimpleProp', 121);
try {
  let promise = (windowClass as window.Window).loadContentByName(Index.entryName, storage);
  promise.then(() => {
    console.info('Succeeded in loading the content.');
  }).catch((err: BusinessError) => {
    console.error(`Failed to load the content. Cause code: ${err.code}, message: ${err.message}`);
  });
} catch (exception) {
  console.error(`Failed to load the content. Cause code: ${exception.code}, message: ${exception.message}`);
}

// ets/pages/Index.ets
export const entryName : string = 'Index';
@Entry({routeName: entryName, storage : LocalStorage.getShared()})
@Component
export struct Index {
  @State message: string = 'Hello World'
  build() {
    Row() {
      Column() {
        Text(this.message)
          .fontSize(50)
          .fontWeight(FontWeight.Bold)
      }
      .width('100%')
    }
    .height('100%')
  }
}

isWindowShowing⁹⁺

isWindowShowing(): boolean

判断当前窗口是否已显示。

系统能力： SystemCapability.WindowManager.WindowManager.Core

返回值：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

try {
  let data = windowClass.isWindowShowing();
  console.info('Succeeded in checking whether the window is showing. Data: ' + JSON.stringify(data));
} catch (exception) {
  console.error('Failed to check whether the window is showing. Cause: ' + JSON.stringify(exception));
}

on('windowSizeChange')⁷⁺

on(type: 'windowSizeChange', callback: Callback<Size>): void

开启窗口尺寸变化的监听。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

示例：

try {
  windowClass.on('windowSizeChange', (data) => {
    console.info('Succeeded in enabling the listener for window size changes. Data: ' + JSON.stringify(data));
  });
} catch (exception) {
  console.error('Failed to enable the listener for window size changes. Cause: ' + JSON.stringify(exception));
}

off('windowSizeChange')⁷⁺

off(type: 'windowSizeChange', callback?: Callback<Size>): void

关闭窗口尺寸变化的监听。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

示例：

try {
  windowClass.off('windowSizeChange');
} catch (exception) {
  console.error('Failed to disable the listener for window size changes. Cause: ' + JSON.stringify(exception));
}

on('avoidAreaChange')⁹⁺

on(type: 'avoidAreaChange', callback: Callback<{ type: AvoidAreaType, area: AvoidArea}>): void

开启系统规避区变化的监听。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

示例：

try {
  windowClass.on('avoidAreaChange', (data) => {
    console.info('Succeeded in enabling the listener for system avoid area changes. type:' +
    JSON.stringify(data.type) + ', area: ' + JSON.stringify(data.area));
  });
} catch (exception) {
  console.error('Failed to enable the listener for system avoid area changes. Cause: ' + JSON.stringify(exception));
}

off('avoidAreaChange')⁹⁺

off(type: 'avoidAreaChange', callback?: Callback<{ type: AvoidAreaType, area: AvoidArea }>): void

关闭系统规避区变化的监听。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

示例：

try {
  windowClass.off('avoidAreaChange');
} catch (exception) {
  console.error('Failed to disable the listener for system avoid area changes. Cause: ' + JSON.stringify(exception));
}

on('keyboardHeightChange')⁷⁺

on(type: 'keyboardHeightChange', callback: Callback<number>): void

开启固定态输入法窗口软键盘高度变化的监听。从API version 10开始，改变输入法窗口为固定态或者悬浮态方法详细介绍请参见输入法服务。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

示例：

try {
  windowClass.on('keyboardHeightChange', (data) => {
    console.info('Succeeded in enabling the listener for keyboard height changes. Data: ' + JSON.stringify(data));
  });
} catch (exception) {
  console.error('Failed to enable the listener for keyboard height changes. Cause: ' + JSON.stringify(exception));
}

off('keyboardHeightChange')⁷⁺

off(type: 'keyboardHeightChange', callback?: Callback<number>): void

关闭固定态输入法窗口软键盘高度变化的监听。从API version 10开始，改变输入法窗口为固定态或者悬浮态方法详细介绍请参见输入法服务。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

示例：

try {
  windowClass.off('keyboardHeightChange');
} catch (exception) {
  console.error('Failed to disable the listener for keyboard height changes. Cause: ' + JSON.stringify(exception));
}

on('touchOutside')¹¹⁺

on(type: 'touchOutside', callback: Callback<void>): void

开启本窗口区域范围外的点击事件的监听。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

示例：

try {
  windowClass.on('touchOutside', () => {
    console.info('touch outside');
  });
} catch (exception) {
  console.error('Failed to register callback. Cause: ' + JSON.stringify(exception));
}

off('touchOutside')¹¹⁺

off(type: 'touchOutside', callback?: Callback<void>): void

关闭本窗口区域范围外的点击事件的监听。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

示例：

try {
  windowClass.off('touchOutside');
} catch (exception) {
  console.error('Failed to unregister callback. Cause: ' + JSON.stringify(exception));
}

on('screenshot')⁹⁺

on(type: 'screenshot', callback: Callback<void>): void

开启截屏事件的监听。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

示例：

try {
  windowClass.on('screenshot', () => {
    console.info('screenshot happened');
  });
} catch (exception) {
  console.error('Failed to register callback. Cause: ' + JSON.stringify(exception));
}

off('screenshot')⁹⁺

off(type: 'screenshot', callback?: Callback<void>): void

关闭截屏事件的监听。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

示例：

let callback = () => {
  console.info('screenshot happened');
};
try {
  windowClass.on('screenshot', callback);
} catch (exception) {
  console.error('Failed to register callback. Cause: ' + JSON.stringify(exception));
}
try {
  windowClass.off('screenshot', callback);
  // 如果通过on开启多个callback进行监听，同时关闭所有监听：
  windowClass.off('screenshot');
} catch (exception) {
  console.error('Failed to unregister callback. Cause: ' + JSON.stringify(exception));
}

on('dialogTargetTouch')¹⁰⁺

on(type: 'dialogTargetTouch', callback: Callback<void>): void

开启模态窗口所遮盖窗口的点击或触摸事件的监听。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

示例：

try {
  windowClass.on('dialogTargetTouch', () => {
    console.info('touch dialog target');
  });
} catch (exception) {
  console.error('Failed to register callback. Cause: ' + JSON.stringify(exception));
}

off('dialogTargetTouch')¹⁰⁺

off(type: 'dialogTargetTouch', callback?: Callback<void>): void

关闭模态窗口目标窗口的点击事件的监听。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

示例：

try {
  windowClass.off('dialogTargetTouch');
} catch (exception) {
  console.error('Failed to unregister callback. Cause: ' + JSON.stringify(exception));
}

on('windowEvent')¹⁰⁺

on(type: 'windowEvent', callback: Callback<WindowEventType>): void

开启窗口生命周期变化的监听。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

示例：

try {
  windowClass.on('windowEvent', (data) => {
    console.info('Window event happened. Event:' + JSON.stringify(data));
  });
} catch (exception) {
  console.error('Failed to register callback. Cause: ' + JSON.stringify(exception));
}

off('windowEvent')¹⁰⁺

off(type: 'windowEvent', callback?: Callback<WindowEventType >): void

关闭窗口生命周期变化的监听。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

示例：

try {
  windowClass.off('windowEvent');
} catch (exception) {
  console.error('Failed to unregister callback. Cause: ' + JSON.stringify(exception));
}

on('windowVisibilityChange')¹¹⁺

on(type: 'windowVisibilityChange', callback: Callback<boolean>): void

开启本窗口可见状态变化事件的监听。

系统能力： SystemCapability.Window.SessionManager

参数：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

try {
  windowClass.on('windowVisibilityChange', (boolean) => {
    console.info('Window visibility changed, isVisible=' + boolean);
  });
} catch (exception) {
  console.error('Failed to register callback. Cause: ' + JSON.stringify(exception));
}

off('windowVisibilityChange')¹¹⁺

off(type: 'windowVisibilityChange', callback?: Callback<boolean>): void

关闭本窗口可见状态变化事件的监听。

系统能力： SystemCapability.Window.SessionManager

参数：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

try {
  windowClass.off('windowVisibilityChange');
} catch (exception) {
  console.error('Failed to unregister callback. Cause: ' + JSON.stringify(exception));
}

on('windowStatusChange')¹¹⁺

on(type: 'windowStatusChange', callback: Callback<WindowStatusType>): void

开启窗口模式变化的监听。

系统能力： SystemCapability.Window.SessionManager

参数：

示例：

try {
  windowClass.on('windowStatusChange', (WindowStatusType) => {
    console.info('Succeeded in enabling the listener for window status changes. Data: ' + JSON.stringify(WindowStatusType));
  });
} catch (exception) {
  console.error('Failed to enable the listener for window status changes. Cause: ' + JSON.stringify(exception));
}

off('windowStatusChange')¹¹⁺

off(type: 'windowStatusChange', callback?: Callback<WindowStatusType>): void

关闭窗口模式变化的监听。

系统能力： SystemCapability.Window.SessionManager

参数：

示例：

try {
  windowClass.off('windowStatusChange');
} catch (exception) {
  console.error('Failed to disable the listener for window status changes. Cause: ' + JSON.stringify(exception));
}

on('windowTitleButtonRectChange')¹¹⁺

on(type: 'windowTitleButtonRectChange', callback: Callback<TitleButtonRect>): void

开启标题栏上的最小化、最大化、关闭按钮矩形区域变化的监听。

系统能力： SystemCapability.Window.SessionManager

参数：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

try {
  windowClass.on('windowTitleButtonRectChange', (titleButtonRect) => {
    console.info('Succeeded in enabling the listener for window title buttons area changes. Data: ' + JSON.stringify(titleButtonRect));
  });
} catch (exception) {
  console.error('Failed to enable the listener for window title buttons area changes. Cause: ' + JSON.stringify(exception));
}

off('windowTitleButtonRectChange')¹¹⁺

off(type: 'windowTitleButtonRectChange', callback?: Callback<TitleButtonRect>): void

关闭标题栏上的最小化、最大化、关闭按钮矩形区域变化的监听。

系统能力： SystemCapability.Window.SessionManager

参数：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

try {
  windowClass.off('windowTitleButtonRectChange');
} catch (exception) {
  console.error('Failed to disable the listener for window title buttons area changes. Cause: ' + JSON.stringify(exception));
}

isWindowSupportWideGamut⁹⁺

isWindowSupportWideGamut(callback: AsyncCallback<boolean>): void

判断当前窗口是否支持广色域模式，使用callback异步回调。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

import { BusinessError } from '@ohos.base';

windowClass.isWindowSupportWideGamut((err: BusinessError, data) => {
  const errCode: number = err.code;
  if (errCode) {
    console.error('Failed to check whether the window support WideGamut. Cause:' + JSON.stringify(err));
    return;
  }
  console.info('Succeeded in checking whether the window support WideGamut Data: ' + JSON.stringify(data));
});

isWindowSupportWideGamut⁹⁺

isWindowSupportWideGamut(): Promise<boolean>

判断当前窗口是否支持广色域模式，使用Promise异步回调。

系统能力： SystemCapability.WindowManager.WindowManager.Core

返回值：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

import { BusinessError } from '@ohos.base';

let promise = windowClass.isWindowSupportWideGamut();
promise.then((data) => {
  console.info('Succeeded in checking whether the window support WideGamut. Data: ' + JSON.stringify(data));
}).catch((err: BusinessError) => {
  console.error('Failed to check whether the window support WideGamut. Cause: ' + JSON.stringify(err));
});

setWindowColorSpace⁹⁺

setWindowColorSpace(colorSpace:ColorSpace, callback: AsyncCallback<void>): void

设置当前窗口为广色域模式或默认色域模式，使用callback异步回调。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

import { BusinessError } from '@ohos.base';

try {
  windowClass.setWindowColorSpace(window.ColorSpace.WIDE_GAMUT, (err: BusinessError) => {
    const errCode: number = err.code;
    if (errCode) {
      console.error('Failed to set window colorspace. Cause:' + JSON.stringify(err));
      return;
    }
    console.info('Succeeded in setting window colorspace.');
  });
} catch (exception) {
  console.error('Failed to set window colorspace. Cause:' + JSON.stringify(exception));
}

setWindowColorSpace⁹⁺

setWindowColorSpace(colorSpace:ColorSpace): Promise<void>

设置当前窗口为广色域模式或默认色域模式，使用Promise异步回调。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

返回值：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

import { BusinessError } from '@ohos.base';

try {
  let promise = windowClass.setWindowColorSpace(window.ColorSpace.WIDE_GAMUT);
  promise.then(() => {
    console.info('Succeeded in setting window colorspace.');
  }).catch((err: BusinessError) => {
    console.error('Failed to set window colorspace. Cause: ' + JSON.stringify(err));
  });
} catch (exception) {
  console.error('Failed to set window colorspace. Cause:' + JSON.stringify(exception));
}

getWindowColorSpace⁹⁺

getWindowColorSpace(): ColorSpace

获取当前窗口色域模式。

系统能力： SystemCapability.WindowManager.WindowManager.Core

返回值：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

let colorSpace = windowClass.getWindowColorSpace();

setWindowBackgroundColor⁹⁺

setWindowBackgroundColor(color: string): void

设置窗口的背景色。Stage模型下，该接口需要在loadContent()或setUIContent()调用生效后使用。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

import { BusinessError } from '@ohos.base';

private SetUIContent(windowClass: window.Window) {
  windowClass.setUIContent("pages/ButtonWindow",(err: BusinessError) => {
    if (err.code) {
      console.error('Failed to load the content. Cause:' + JSON.stringify(err));
      return;
    }
    console.info('Succeeded in loading the content.');
    let color: string = '#00ff33';
    try {
      windowClass.setWindowBackgroundColor(color);
    } catch (exception) {
      console.error('Failed to set the background color. Cause: ' + JSON.stringify(exception));
    };
  });
}

setWindowBrightness⁹⁺

setWindowBrightness(brightness: number, callback: AsyncCallback<void>): void

允许应用窗口设置屏幕亮度值，使用callback异步回调。

当前屏幕亮度规格：窗口设置屏幕亮度生效时，控制中心不可以调整系统屏幕亮度，窗口恢复默认系统亮度之后，控制中心可以调整系统屏幕亮度。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

import { BusinessError } from '@ohos.base';

let brightness: number = 1;
try {
  windowClass.setWindowBrightness(brightness, (err: BusinessError) => {
    const errCode: number = err.code;
    if (errCode) {
      console.error('Failed to set the brightness. Cause: ' + JSON.stringify(err));
      return;
    }
    console.info('Succeeded in setting the brightness.');
  });
} catch (exception) {
  console.error('Failed to set the brightness. Cause: ' + JSON.stringify(exception));
}

setWindowBrightness⁹⁺

setWindowBrightness(brightness: number): Promise<void>

允许应用窗口设置屏幕亮度值，使用Promise异步回调。

当前屏幕亮度规格：窗口设置屏幕亮度生效时，控制中心不可以调整系统屏幕亮度，窗口恢复默认系统亮度之后，控制中心可以调整系统屏幕亮度。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

返回值：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

import { BusinessError } from '@ohos.base';

let brightness: number = 1;
try {
  let promise = windowClass.setWindowBrightness(brightness);
  promise.then(() => {
    console.info('Succeeded in setting the brightness.');
  }).catch((err: BusinessError) => {
    console.error('Failed to set the brightness. Cause: ' + JSON.stringify(err));
  });
} catch (exception) {
  console.error('Failed to set the brightness. Cause: ' + JSON.stringify(exception));
}

setWindowFocusable⁹⁺

setWindowFocusable(isFocusable: boolean, callback: AsyncCallback<void>): void

设置使用点击或其他方式使该窗口获焦的场景时，该窗口是否支持从点击前的获焦窗口切换到该窗口，使用callback异步回调。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

import { BusinessError } from '@ohos.base';

let isFocusable: boolean = true;
try {
  windowClass.setWindowFocusable(isFocusable, (err: BusinessError) => {
    const errCode: number = err.code;
    if (errCode) {
      console.error('Failed to set the window to be focusable. Cause:' + JSON.stringify(err));
      return;
    }
    console.info('Succeeded in setting the window to be focusable.');
  });
} catch (exception) {
  console.error('Failed to set the window to be focusable. Cause:' + JSON.stringify(exception));
}

setWindowFocusable⁹⁺

setWindowFocusable(isFocusable: boolean): Promise<void>

设置使用点击或其他方式使该窗口获焦的场景时，该窗口是否支持从点击前的获焦窗口切换到该窗口，使用Promise异步回调。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

返回值：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

import { BusinessError } from '@ohos.base';

let isFocusable: boolean = true;
try {
  let promise = windowClass.setWindowFocusable(isFocusable);
  promise.then(() => {
    console.info('Succeeded in setting the window to be focusable.');
  }).catch((err: BusinessError) => {
    console.error('Failed to set the window to be focusable. Cause: ' + JSON.stringify(err));
  });
} catch (exception) {
  console.error('Failed to set the window to be focusable. Cause:' + JSON.stringify(exception));
}

setWindowKeepScreenOn⁹⁺

setWindowKeepScreenOn(isKeepScreenOn: boolean, callback: AsyncCallback<void>): void

设置屏幕是否为常亮状态，使用callback异步回调。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

import { BusinessError } from '@ohos.base';

let isKeepScreenOn: boolean = true;
try {
  windowClass.setWindowKeepScreenOn(isKeepScreenOn, (err: BusinessError) => {
    const errCode: number = err.code;
    if (errCode) {
      console.error('Failed to set the screen to be always on. Cause: ' + JSON.stringify(err));
      return;
    }
    console.info('Succeeded in setting the screen to be always on.');
  });
} catch (exception) {
  console.error('Failed to set the screen to be always on. Cause: ' + JSON.stringify(exception));
}

setWindowKeepScreenOn⁹⁺

setWindowKeepScreenOn(isKeepScreenOn: boolean): Promise<void>

设置屏幕是否为常亮状态，使用Promise异步回调。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

返回值：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

import { BusinessError } from '@ohos.base';

let isKeepScreenOn: boolean = true;
try {
  let promise = windowClass.setWindowKeepScreenOn(isKeepScreenOn);
  promise.then(() => {
    console.info('Succeeded in setting the screen to be always on.');
  }).catch((err: BusinessError) => {
    console.info('Failed to set the screen to be always on. Cause:  ' + JSON.stringify(err));
  });
} catch (exception) {
  console.error('Failed to set the screen to be always on. Cause: ' + JSON.stringify(exception));
}

setWindowPrivacyMode⁹⁺

setWindowPrivacyMode(isPrivacyMode: boolean, callback: AsyncCallback<void>): void

设置窗口是否为隐私模式，使用callback异步回调。设置为隐私模式的窗口，窗口内容将无法被截屏或录屏。此接口可用于禁止截屏/录屏的场景。

系统能力： SystemCapability.WindowManager.WindowManager.Core

需要权限： ohos.permission.PRIVACY_WINDOW

参数：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

import { BusinessError } from '@ohos.base';

let isPrivacyMode: boolean = true;
try {
  windowClass.setWindowPrivacyMode(isPrivacyMode, (err: BusinessError) => {
    const errCode: number = err.code;
    if (errCode) {
      console.error('Failed to set the window to privacy mode. Cause:' + JSON.stringify(err));
      return;
    }
    console.info('Succeeded in setting the window to privacy mode.');
  });
} catch (exception) {
  console.error('Failed to set the window to privacy mode. Cause:' + JSON.stringify(exception));
}

setWindowPrivacyMode⁹⁺

setWindowPrivacyMode(isPrivacyMode: boolean): Promise<void>

设置窗口是否为隐私模式，使用Promise异步回调。设置为隐私模式的窗口，窗口内容将无法被截屏或录屏。此接口可用于禁止截屏/录屏的场景。

系统能力： SystemCapability.WindowManager.WindowManager.Core

需要权限： ohos.permission.PRIVACY_WINDOW

参数：

返回值：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

import { BusinessError } from '@ohos.base';

let isPrivacyMode: boolean = true;
try {
  let promise = windowClass.setWindowPrivacyMode(isPrivacyMode);
  promise.then(() => {
    console.info('Succeeded in setting the window to privacy mode.');
  }).catch((err: BusinessError) => {
    console.error('Failed to set the window to privacy mode. Cause: ' + JSON.stringify(err));
  });
} catch (exception) {
  console.error('Failed to set the window to privacy mode. Cause:' + JSON.stringify(exception));
}

setWindowTouchable⁹⁺

setWindowTouchable(isTouchable: boolean, callback: AsyncCallback<void>): void

设置窗口是否为可触状态，使用callback异步回调。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

import { BusinessError } from '@ohos.base';

let isTouchable = true;
try {
  windowClass.setWindowTouchable(isTouchable, (err: BusinessError) => {
    const errCode: number = err.code;
    if (errCode) {
      console.error('Failed to set the window to be touchable. Cause:' + JSON.stringify(err));
      return;
    }
    console.info('Succeeded in setting the window to be touchable.');
  });
} catch (exception) {
  console.error('Failed to set the window to be touchable. Cause:' + JSON.stringify(exception));
}

setWindowTouchable⁹⁺

setWindowTouchable(isTouchable: boolean): Promise<void>

设置窗口是否为可触状态，使用Promise异步回调。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

返回值：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

import { BusinessError } from '@ohos.base';

let isTouchable: boolean = true;
try {
  let promise = windowClass.setWindowTouchable(isTouchable);
  promise.then(() => {
    console.info('Succeeded in setting the window to be touchable.');
  }).catch((err: BusinessError) => {
    console.error('Failed to set the window to be touchable. Cause: ' + JSON.stringify(err));
  });
} catch (exception) {
  console.error('Failed to set the window to be touchable. Cause:' + JSON.stringify(exception));
}

snapshot⁹⁺

snapshot(callback: AsyncCallback<image.PixelMap>): void

获取窗口截图，使用callback异步回调。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

import { BusinessError } from '@ohos.base';
import image from '@ohos.multimedia.image';

windowClass.snapshot((err: BusinessError, pixelMap: image.PixelMap) => {
  const errCode: number = err.code;
  if (errCode) {
    console.error('Failed to snapshot window. Cause:' + JSON.stringify(err));
    return;
  }
  console.info('Succeeded in snapshotting window. Pixel bytes number: ' + pixelMap.getPixelBytesNumber());
  pixelMap.release(); // PixelMap使用完后及时释放内存
});

snapshot⁹⁺

snapshot(): Promise<image.PixelMap>

获取窗口截图，使用Promise异步回调。

系统能力： SystemCapability.WindowManager.WindowManager.Core

返回值：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

import { BusinessError } from '@ohos.base';
import image from '@ohos.multimedia.image';

let promise = windowClass.snapshot();
promise.then((pixelMap: image.PixelMap) => {
  console.info('Succeeded in snapshotting window. Pixel bytes number: ' + pixelMap.getPixelBytesNumber());
  pixelMap.release(); // PixelMap使用完后及时释放内存
}).catch((err: BusinessError) => {
  console.error('Failed to snapshot window. Cause:' + JSON.stringify(err));
});

setAspectRatio¹⁰⁺

setAspectRatio(ratio: number): Promise<void>

设置窗口内容布局的比例，使用Promise异步回调。

仅应用主窗口支持此接口功能，比例参数将持久化保存，关闭应用或重启设备设置的比例仍然生效。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

返回值：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

import UIAbility from '@ohos.app.ability.UIAbility';
import window from '@ohos.window';
import { BusinessError } from '@ohos.base';

export default class EntryAbility extends UIAbility {

  // ...
  onWindowStageCreate(windowStage: window.WindowStage) {
    console.info('onWindowStageCreate');
    let windowClass: window.Window = windowStage.getMainWindowSync(); // 获取应用主窗口
    if (!windowClass) {
      console.info('windowClass is null');
    }
    try {
      let ratio = 1.0;
      let promise = windowClass.setAspectRatio(ratio);
      promise.then(() => {
        console.info('Succeeded in setting aspect ratio of window.');
      }).catch((err: BusinessError) => {
        console.error(`Failed to set the aspect ratio of window. Cause code: ${err.code}, message: ${err.message}`);
      });
    } catch (exception) {
      console.error(`Failed to set the aspect ratio of window. Cause code: ${exception.code}, message: ${exception.message}`);
    }
  }
}

setAspectRatio¹⁰⁺

setAspectRatio(ratio: number, callback: AsyncCallback<void>): void

设置窗口内容布局的比例，使用callback异步回调。

仅应用主窗口支持此接口功能，比例参数将持久化保存，关闭应用或重启设备设置的比例仍然生效。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

import UIAbility from '@ohos.app.ability.UIAbility';
import window from '@ohos.window';
import { BusinessError } from '@ohos.base';

export default class EntryAbility extends UIAbility {

  // ...
  onWindowStageCreate(windowStage: window.WindowStage) {
    console.info('onWindowStageCreate');
    let windowClass: window.Window = windowStage.getMainWindowSync(); // 获取应用主窗口
    if (!windowClass) {
      console.info('Failed to load the content. Cause: windowClass is null');
    }
    try {
      let ratio = 1.0;
      windowClass.setAspectRatio(ratio, (err: BusinessError) => {
        const errCode: number = err.code;
        if (errCode) {
          console.error(`Failed to set the aspect ratio of window. Cause code: ${err.code}, message: ${err.message}`);
          return;
        }
        console.info('Succeeded in setting the aspect ratio of window.');
      });
    } catch (exception) {
      console.error(`Failed to set the aspect ratio of window. Cause code: ${exception.code}, message: ${exception.message}`);
    }
  }
}

resetAspectRatio¹⁰⁺

resetAspectRatio(): Promise<void>

取消设置窗口内容布局的比例，使用Promise异步回调。

仅应用主窗口支持此接口功能，调用后将清除持久化储存的比例信息。

系统能力： SystemCapability.WindowManager.WindowManager.Core

返回值：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

import UIAbility from '@ohos.app.ability.UIAbility';
import window from '@ohos.window';
import { BusinessError } from '@ohos.base';

export default class EntryAbility extends UIAbility {

  // ...
  onWindowStageCreate(windowStage: window.WindowStage) {
    console.info('onWindowStageCreate');
    let windowClass: window.Window = windowStage.getMainWindowSync(); // 获取应用主窗口
    if (!windowClass) {
      console.info('Failed to load the content. Cause: windowClass is null');
    }
    try {
      let promise = windowClass.resetAspectRatio();
      promise.then(() => {
        console.info('Succeeded in resetting aspect ratio of window.');
      }).catch((err: BusinessError) => {
        console.error(`Failed to reset the aspect ratio of window. Cause code: ${err.code}, message: ${err.message}`);
      });
    } catch (exception) {
      console.error(`Failed to reset the aspect ratio of window. Cause code: ${exception.code}, message: ${exception.message}`);
    }
  }
}

resetAspectRatio¹⁰⁺

resetAspectRatio(callback: AsyncCallback<void>): void

取消设置窗口内容布局的比例，使用callback异步回调。

仅应用主窗口支持此接口功能，调用后将清除持久化储存的比例信息。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

import UIAbility from '@ohos.app.ability.UIAbility';
import window from '@ohos.window';
import { BusinessError } from '@ohos.base';

export default class EntryAbility extends UIAbility {

  // ...
  onWindowStageCreate(windowStage: window.WindowStage) {
    console.info('onWindowStageCreate');
    let windowClass: window.Window = windowStage.getMainWindowSync(); // 获取应用主窗口
    if (!windowClass) {
      console.info('Failed to load the content. Cause: windowClass is null');
    }
    try {
      windowClass.resetAspectRatio((err: BusinessError) => {
        const errCode: number = err.code;
        if (errCode) {
          console.error(`Failed to reset the aspect ratio of window. Cause code: ${err.code}, message: ${err.message}`);
          return;
        }
        console.info('Succeeded in resetting aspect ratio of window.');
      });
    } catch (exception) {
      console.error(`Failed to reset the aspect ratio of window. Cause code: ${exception.code}, message: ${exception.message}`);
    }
  }
}

minimize¹¹⁺

minimize(callback: AsyncCallback<void>): void

此接口根据调用对象不同，实现不同的两个功能：

当调用对象为主窗口时，实现最小化功能，可在Dock栏中还原；

当调用对象为子窗口时，实现隐藏功能，不可在Dock栏中还原。

使用callback异步回调。

系统能力： SystemCapability.Window.SessionManager

参数：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

import { BusinessError } from '@ohos.base';

windowClass.minimize((err: BusinessError) => {
  const errCode: number = err.code;
  if (errCode) {
    console.error('Failed to minimize the window. Cause: ' + JSON.stringify(err));
    return;
  }
  console.info('Succeeded in minimizing the window.');
});

minimize¹¹⁺

minimize(): Promise<void>

此接口根据调用对象不同，实现不同的两个功能：

当调用对象为主窗口时，实现最小化功能，可在Dock栏中还原；

当调用对象为子窗口时，实现隐藏功能，不可在Dock栏中还原。

使用Promise异步回调。

系统能力： SystemCapability.Window.SessionManager

返回值：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

import { BusinessError } from '@ohos.base';

let promise = windowClass.minimize();
promise.then(() => {
  console.info('Succeeded in minimizing the window.');
}).catch((err: BusinessError) => {
  console.error('Failed to minimize the window. Cause: ' + JSON.stringify(err));
});

recover¹¹⁺

recover(): Promise<void>

将主窗口从全屏、最大化、分屏模式下还原为浮动窗口，并恢复到进入该模式之前的大小和位置，已经是浮动窗口模式不可再还原。使用Promise异步回调。此接口仅在多窗层叠布局效果下生效。

系统能力： SystemCapability.Window.SessionManager

返回值：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

import { BusinessError } from '@ohos.base';

let promise = windowClass.recover();
promise.then(() => {
  console.info('Succeeded in recovering the window.');
}).catch((err: BusinessError) => {
  console.error('Failed to recover the window. Cause: ' + JSON.stringify(err));
});

getWindowLimits¹¹⁺

getWindowLimits(): WindowLimits

获取当前窗口的尺寸限制。

系统能力： SystemCapability.Window.SessionManager

返回值：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

try {
  let windowLimits = windowClass.getWindowLimits();
} catch (exception) {
  console.error('Failed to obtain the window limits of window. Cause: ' + JSON.stringify(exception));
}

setWindowLimits¹¹⁺

setWindowLimits(windowLimits: WindowLimits): Promise<WindowLimits>

设置当前窗口的尺寸限制，使用Promise异步回调。

系统能力： SystemCapability.Window.SessionManager

参数：

返回值：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

import { BusinessError } from '@ohos.base';
try {
  let windowLimits: window.WindowLimits = {
    maxWidth: 1500,
    maxHeight: 1000,
    minWidth: 500,
    minHeight: 400
  };
  let promise = windowClass.setWindowLimits(windowLimits);
    promise.then((data) => {
    console.info('Succeeded in changing the window limits. Cause:' + JSON.stringify(data));
  }).catch((err: BusinessError) => {
    console.error('Failed to change the window limits. Cause: ' + JSON.stringify(err));
  });
} catch (exception) {
  console.error('Failed to change the window limits. Cause:' + JSON.stringify(exception));
}

keepKeyboardOnFocus¹¹⁺

keepKeyboardOnFocus(keepKeyboardFlag: boolean): void

窗口获焦时保留由其他窗口创建的软键盘，仅支持系统窗口与应用子窗口。

系统能力： SystemCapability.Window.SessionManager

参数：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

try {
  windowClass.keepKeyboardOnFocus(true);
} catch (exception) {
  console.error('Failed to keep keyboard onFocus. Cause: ' + JSON.stringify(exception));
}

setWindowDecorVisible¹¹⁺

setWindowDecorVisible(isVisible: boolean): void

主窗口设置标题栏是否可见。

系统能力： SystemCapability.Window.SessionManager

参数：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

import UIAbility from '@ohos.app.ability.UIAbility';
import { BusinessError } from '@ohos.base';

export default class EntryAbility extends UIAbility {
  onWindowStageCreate(windowStage: window.WindowStage) {
    // 为主窗口加载对应的目标页面。
    windowStage.loadContent("pages/page2", (err: BusinessError) => {
      let errCode: number = err.code;
      if (errCode) {
        console.error('Failed to load the content. Cause:' + JSON.stringify(err));
        return;
      }
      console.info('Succeeded in loading the content.');
      // 获取应用主窗口。
      let mainWindow: window.Window | undefined = undefined;
      windowStage.getMainWindow((err: BusinessError, data) => {
        let errCode: number = err.code;
        if (errCode) {
          console.error('Failed to obtain the main window. Cause: ' + JSON.stringify(err));
          return;
        }
        mainWindow = data;
        console.info('Succeeded in obtaining the main window. Data: ' + JSON.stringify(data));
        let isVisible = false;
        // 调用setWindowDecorVisible接口
        try {
          mainWindow.setWindowDecorVisible(isVisible);
        } catch (exception) {
          console.error('Failed to set the visibility of window decor. Cause: ' + JSON.stringify(exception));
        }
      })
    });
  }
};

setWindowDecorHeight¹¹⁺

setWindowDecorHeight(height: number): void

设置窗口标题栏高度。

系统能力： SystemCapability.Window.SessionManager

参数：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

let height: number = 50;
try {
  windowClass.setWindowDecorHeight(height);
} catch (exception) {
  console.error('Failed to set the height of window decor. Cause: ' + JSON.stringify(exception));
}

getWindowDecorHeight¹¹⁺

getWindowDecorHeight(): number

获取窗口标题栏高度。

系统能力： SystemCapability.Window.SessionManager

返回值：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

try {
  let height = windowClass.getWindowDecorHeight();
} catch (exception) {
  console.error('Failed to get the height of window decor. Cause: ' + JSON.stringify(exception));
}

getTitleButtonRect¹¹⁺

getTitleButtonRect(): TitleButtonRect

获取标题栏上的最小化、最大化、关闭按钮矩形区域。

系统能力： SystemCapability.Window.SessionManager

返回值：

错误码：

以下错误码的详细介绍请参见窗口错误码。

示例：

try {
  let titleButtonArea = windowClass.getTitleButtonRect();
  console.info('Succeeded in obtaining the area of title buttons. Data: ' + JSON.stringify(titleButtonArea));
} catch (exception) {
  console.error('Failed to get the area of title buttons. Cause: ' + JSON.stringify(exception));
}

show^(deprecated)

show(callback: AsyncCallback<void>): void

显示当前窗口，使用callback异步回调。

说明：

从 API version 7开始支持，从API version 9开始废弃，推荐使用showWindow()。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：

示例：

import { BusinessError } from '@ohos.base';

windowClass.show((err: BusinessError) => {
  const errCode: number = err.code;
  if (errCode) {
    console.error('Failed to show the window. Cause: ' + JSON.stringify(err));
    return;
  }
  console.info('Succeeded in showing the window.');
});

show^(deprecated)

show(): Promise<void>

显示当前窗口，使用Promise异步回调。

说明：

从 API version 7开始支持，从API version 9开始废弃，推荐使用showWindow()。

系统能力： SystemCapability.WindowManager.WindowManager.Core

返回值：

示例：

import { BusinessError } from '@ohos.base';

let promise = windowClass.show();
promise.then(() => {
  console.info('Succeeded in showing the window.');
}).catch((err: BusinessError) => {
  console.error('Failed to show the window. Cause: ' + JSON.stringify(err));
});

destroy^(deprecated)

destroy(callback: AsyncCallback<void>): void

销毁当前窗口，使用callback异步回调。

说明：

从 API version 7开始支持，从API version 9开始废弃，推荐使用destroyWindow()。

系统能力： SystemCapability.WindowManager.WindowManager.Core

参数：