Window

java.lang.Object
- ohos.agp.window.service.Window

```
public class Window
extends Object
```
An implementation class for windows.
This class provides methods of modifying attributes of windows based on LayoutConfig.

从以下版本开始:

2

嵌套类概要

嵌套类
限定符和类型类说明

static interface Window.IAccessibilityEventListener
An implementation class for Populate Accessibility Event Listener.

嵌套类
限定符和类型	类	说明
`static interface`	`Window.IAccessibilityEventListener`	An implementation class for Populate Accessibility Event Listener.

构造器概要

构造器
构造器说明

Window()
A constructor used to create a Window instance.

构造器
构造器	说明
`Window()`	A constructor used to create a `Window` instance.

方法概要

所有方法实例方法具体方法
限定符和类型	方法	说明
`void`	`addFlags(int flags)`	Add window flags.
`void`	`addWindowFlags(int flags)`	Add the characteristic flags of a window in ohos.
`void`	`clearFlags(int flags)`	Clears flags from a window.
`void`	`clearWindowFlags(int flags)`	Clear the flags from a window.
`float`	`getAltitude()`	Obtains the altitude of a window in the direction perpendicular to the phone screen.
`Rect`	`getBoundRect()`	Obtain the bounds of a moving window.
`Optional<Component>`	`getCurrentComponentFocus()`	Obtain the `Component` object that has gained focus in this window.
`Optional<WindowManager.LayoutConfig>`	`getLayoutConfig()`	Obtain the `LayoutConfig` object of the `Window` instance to read or modify.
`LayoutScatter`	`getLayoutScatter()`	Obtain the layout scatter of this window.
`int`	`getStatusBarVisibility()`	Obtain whether the status bar is visible.
`int`	`getSystemBarStyle()`	Obtain the visibility type of the navigation bar or status bar.
`boolean`	`isActive()`	Check whether this window is active.
`boolean`	`isMovable()`	Check whether a window is movable.
`boolean`	`isWCGMode()`	Check whether this window is in wide color gamut (WCG) mode.
`int`	`replicateFrom(WindowManager.LayoutConfig param)`	Set a layout attribute for this window.
`void`	`setAccessibilityEventListener(Window.IAccessibilityEventListener listener)`	Set a listener for accessibility events.
`void`	`setAltitude(float altitude)`	Sets the altitude of a window in the direction perpendicular to the phone screen.
`void`	`setBackground(String elementPath)`	Set the background for a window.
`void`	`setBackgroundColor(RgbColor rgbColor)`	Set the background color of a window.
`void`	`setBoundRect(Rect boundRect)`	Set the bounds of a moving window.
`void`	`setInputPanelDisplayType(int type)`	Set the display type for the soft input panel.
`void`	`setLayoutAlignment(int alignment)`	Set the text alignment for a window.
`void`	`setLayoutConfig(WindowManager.LayoutConfig param)`	Set the `LayoutConfig` of the `Window` instance.
`void`	`setLayoutFlags(int flags, int mask)`	Set flags for a window.
`void`	`setLayoutInDisplaySideMode(int mode)`	Set the display mode for the sidebar of this Window.
`void`	`setLayoutInNotchMode(WindowManager.NotchMode mode)`	Sets the display mode for this window in the notch.
`void`	`setMovable(boolean isMovable)`	Set whether a window is movable.
`void`	`setNavigationBarColor(int color)`	Set the color of a navigation bar.
`void`	`setOnApplyComponentPaddingListener(IApplyComponentPaddingListener listener)`	Set a listener to monitor `ComponentPadding` changes.
`void`	`setPadding(int left, int top, int right, int bottom)`	Set the inner padding of a window in the sequence of left, top, right, and bottom.
`void`	`setPixelFormat(int format)`	Set the pixel format for this window.
`void`	`setShadowStyle(Component.ShadowSize size, Component.ShadowMode mode, Component.ShadowDevice device)`	Sets the shadow style of a window.
`void`	`setStatusBarColor(int color)`	Set the color of the status bar.
`void`	`setStatusBarVisibility(int visibility)`	Set whether the status bar is visible.
`void`	`setSystemBarStyle(int visibility)`	Sets the visibility of the navigation bar or status bar.
`void`	`setTransparent(boolean isEnable)`	Set whether to enable transparency.
`void`	`setWindowFlags(int flags, int mask)`	Set window flags.
`void`	`setWindowLayout(int width, int height)`	Set the size of a window.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - Window
```
public Window()
```
    A constructor used to create a Window instance.
    This method can also be used for tests.
- 方法详细资料
  - isMovable
```
public boolean isMovable()
```
    Check whether a window is movable.
    
    返回:
    
    Returns True if the window is movable; returns false otherwise.
  - setMovable
```
public void setMovable(boolean isMovable)
```
    Set whether a window is movable.
    
    参数:
    
    isMovable - Indicate whether the window is movable. True indicates movable; false indicates otherwise.
  - getBoundRect
```
public Rect getBoundRect()
```
    Obtain the bounds of a moving window.
    
    返回:
    
    Returns the rectangular bounds of the window.
  - setBoundRect
```
public void setBoundRect(Rect boundRect)
```
    Set the bounds of a moving window.
    
    参数:
    
    boundRect - Indicates the rectangular bounds of the window.
  - getLayoutConfig
```
public Optional<WindowManager.LayoutConfig> getLayoutConfig()
```
    Obtain the LayoutConfig object of the Window instance to read or modify.
    
    返回:
    
    Returns the current WindowManager.LayoutConfig attributes of the Window instance.
    
    抛出:
    
    NullPointerException - Throws this exception if mAgpWindow is null.
  - setLayoutConfig
```
public void setLayoutConfig(WindowManager.LayoutConfig param)
```
    Set the LayoutConfig of the Window instance.
    
    参数:
    
    param - Indicates the parameters to pass to this method. You can obtain the LayoutConfig parameters from the getLayoutConfig() method.
    
    抛出:
    
    NullPointerException - Throws this exception if input para is null.
  - setLayoutAlignment
```
public void setLayoutAlignment(int alignment)
```
    Set the text alignment for a window.
    You can obtain the supported attributes from TextAlignment.
    - HORIZONTAL_CENTER
    - VERTICAL_CENTER
    参数:
    
    alignment - Indicates the alignment attribute to set for the window.
    
    从以下版本开始:
    
    4
  - addFlags
```
public void addFlags(int flags)
```
    Add window flags. You can obtain the currently supported flags from WindowManager.LayoutConfig.
    
    参数:
    
    flags - Indicates the flags to set add.
  - clearFlags
```
public void clearFlags(int flags)
```
    Clears flags from a window.
    
    参数:
    
    flags - Indicates the flags to be cleared from the window.
  - setLayoutFlags
```
public void setLayoutFlags(int flags,
                           int mask)
```
    Set flags for a window.
    Different from the addFlags(int flags) method, this method clears the existing flags using the attrs.flag &~ mask calculation and then sets new flags.
    
    参数:
    
    flags - Indicates the new flags specified by WindowManager.LayoutConfig.
    
    mask - Indicates the mask of the window.
    
    抛出:
    
    NullPointerException - Throws this exception if mAgpWindow is null.
  - setWindowLayout
```
public void setWindowLayout(int width,
                            int height)
```
    Set the size of a window.
    
    参数:
    
    width - Indicates the width of the window.
    
    height - Indicates the height of the window.
  - setNavigationBarColor
```
public void setNavigationBarColor(int color)
```
    Set the color of a navigation bar.
    
    参数:
    
    color - Indicates the color of the navigation bar.
    
    抛出:
    
    NullPointerException - Throws this exception if mAgpWindow is null.
  - setStatusBarColor
```
public void setStatusBarColor(int color)
```
    Set the color of the status bar.
    
    参数:
    
    color - Indicates the color of the status bar.
    
    抛出:
    
    NullPointerException - Throws this exception if mAgpWindow is null.
  - setPadding
```
public void setPadding(int left,
                       int top,
                       int right,
                       int bottom)
```
    Set the inner padding of a window in the sequence of left, top, right, and bottom.
    
    参数:
    
    left - Indicates the left padding.
    
    top - Indicates the top padding.
    
    right - Indicates the right padding.
    
    bottom - Indicates the bottom padding.
    
    抛出:
    
    NullPointerException - Throws this exception if mAgpWindow is null.
  - setStatusBarVisibility
```
public void setStatusBarVisibility(int visibility)
```
    Set whether the status bar is visible. Component.INVISIBLE indicates the status bar is invisible.
    
    参数:
    
    visibility - Indicates whether the status bar is visible. Component.VISIBLE indicates visible; Component.INVISIBLE indicates invisible.
    
    抛出:
    
    NullPointerException - Throws this exception if mAgpWindow is null.
  - getStatusBarVisibility
```
public int getStatusBarVisibility()
```
    Obtain whether the status bar is visible. Component.INVISIBLE indicates the status bar is invisible.
    
    返回:
    
    Return Component.VISIBLE if the status bar is visible; Return Component.INVISIBLE if the status bar is invisible.
    
    抛出:
    
    NullPointerException - Throws this exception if mAgpWindow is null.
  - setSystemBarStyle
```
public void setSystemBarStyle(int visibility)
```
    Sets the visibility of the navigation bar or status bar.
    
    参数:
    
    visibility - Indicates the visibility type. The value can be WindowManager.LayoutConfig#SYSTEM_BAR_HIDE_NAVIGATION_ONCE, WindowManager.LayoutConfig#SYSTEM_BAR_HIDE_STATUS_ONCE, WindowManager.LayoutConfig#SYSTEM_BAR_HIDE_NAVIGATION_AUTO, WindowManager.LayoutConfig#SYSTEM_BAR_HIDE_STATUS_AUTO, WindowManager.LayoutConfig#SYSTEM_BAR_BRIGHT_STATUS, or WindowManager.LayoutConfig#SYSTEM_BAR_BRIGHT_NAVIGATION.
    
    抛出:
    
    NullPointerException - Throws this exception if mAgpWindow is null.
  - getSystemBarStyle
```
public int getSystemBarStyle()
```
    Obtain the visibility type of the navigation bar or status bar.
    
    返回:
    
    Returns the visibility type.
    
    抛出:
    
    NullPointerException - Throws this exception if mAgpWindow is null.
  - getCurrentComponentFocus
```
public Optional<Component> getCurrentComponentFocus()
```
    Obtain the Component object that has gained focus in this window.
    
    返回:
    
    Returns the Component object that has gained focus in this window.
    
    抛出:
    
    NullPointerException - Throws this exception if mAgpWindow is null.
  - setBackgroundColor
```
public void setBackgroundColor(RgbColor rgbColor)
```
    Set the background color of a window.
    
    参数:
    
    rgbColor - Indicates the value of the color for the window.
    
    抛出:
    
    NullPointerException - Throws this exception if mAgpWindow is null.
    
    从以下版本开始:
    
    4
  - setBackground
```
public void setBackground(String elementPath)
```
    Set the background for a window.
    
    参数:
    
    elementPath - Indicates the path of background resources for the window.
    
    抛出:
    
    NullPointerException - Throws this exception if mAgpWindow is null.
  - addWindowFlags
```
public void addWindowFlags(int flags)
```
    Add the characteristic flags of a window in ohos. You can obtain supported flags from WindowManager.LayoutConfig.
    
    参数:
    
    flags - Indicates the value of the flags to set for the window.
  - clearWindowFlags
```
public void clearWindowFlags(int flags)
```
    Clear the flags from a window.
    
    参数:
    
    flags - Indicates the window flags to be cleared.
  - setWindowFlags
```
public void setWindowFlags(int flags,
                           int mask)
```
    Set window flags.
    
    参数:
    
    flags - Indicates the window flags to set.
    
    mask - Indicates the mask to set.
    
    抛出:
    
    NullPointerException - Throws this exception if mAgpWindow is null.
  - setTransparent
```
public void setTransparent(boolean isEnable)
```
    Set whether to enable transparency.
    
    参数:
    
    isEnable - Specifies whether transparency is enabled. True indicates that transparency is enabled, and False indicates disabled.
    
    抛出:
    
    NullPointerException - Throws this exception if mAgpWindow is null.
  - setOnApplyComponentPaddingListener
```
public void setOnApplyComponentPaddingListener(IApplyComponentPaddingListener listener)
```
    Set a listener to monitor ComponentPadding changes.
    
    参数:
    
    listener - IApplyComponentPaddingListener
    
    抛出:
    
    NullPointerException - Throw this exception if input para is null.
    
    从以下版本开始:
    
    5
  - getLayoutScatter
```
public LayoutScatter getLayoutScatter()
```
    Obtain the layout scatter of this window.
    
    返回:
    
    Return the layout scatter.
    
    抛出:
    
    NullPointerException - Throws this exception if mAgpWindow is null.
    
    从以下版本开始:
    
    5
    
    另请参阅:
    
    LayoutScatter
  - isActive
```
public boolean isActive()
```
    Check whether this window is active.
    
    返回:
    
    Return true if this window is active; return false otherwise.
    
    抛出:
    
    NullPointerException - Throws this exception if mAgpWindow is null.
    
    从以下版本开始:
    
    5
  - isWCGMode
```
public boolean isWCGMode()
```
    Check whether this window is in wide color gamut (WCG) mode.
    
    返回:
    
    Return true if this window is in WCG mode; return false otherwise.
    
    抛出:
    
    NullPointerException - Throws this exception if mAgpWindow is null.
    
    从以下版本开始:
    
    5
  - setPixelFormat
```
public void setPixelFormat(int format)
```
    Set the pixel format for this window.
    
    参数:
    
    format - Indicate the pixel format to set.
    
    抛出:
    
    NullPointerException - Throws this exception if mAgpWindow is null.
    
    从以下版本开始:
    
    5
    
    另请参阅:
    
    Surface.PixelFormat#PIXEL_FORMAT_YCBCR_422_I, Surface.PixelFormat#PIXEL_FORMAT_YCRCB_420_SP, Surface.PixelFormat#PIXEL_FORMAT_YV12
  - replicateFrom
```
public int replicateFrom(WindowManager.LayoutConfig param)
```
    Set a layout attribute for this window.
    
    参数:
    
    param - Indicate the layout attribute to set.
    
    返回:
    
    Return the changed attributes, as described in WindowManager.LayoutConfig#ALTER_LAYOUT.
    
    抛出:
    
    NullPointerException - Throws this exception if mAgpWindow is null.
    
    从以下版本开始:
    
    5
  - setLayoutInDisplaySideMode
```
public void setLayoutInDisplaySideMode(int mode)
```
    Set the display mode for the sidebar of this Window. This method applies to smartphones with a super curved screen.
    
    参数:
    
    mode - Indicate the display mode to set. The value can be WindowManager.LayoutConfig#LAYOUT_IN_DISPLAY_SIDE_MODE_DEFAULT, WindowManager.LayoutConfig#LAYOUT_IN_DISPLAY_SIDE_MODE_ALWAYS, or WindowManager.LayoutConfig#LAYOUT_IN_DISPLAY_SIDE_MODE_NEVER.
    
    抛出:
    
    NullPointerException - Throws this exception if mAgpWindow is null.
    
    从以下版本开始:
    
    5
  - setLayoutInNotchMode
```
public void setLayoutInNotchMode(WindowManager.NotchMode mode)
```
    Sets the display mode for this window in the notch.
    
    参数:
    
    mode - Indicates the display mode for this window in the notch. For details, see WindowManager.NotchMode.
    
    从以下版本开始:
    
    6
  - setAccessibilityEventListener
```
public void setAccessibilityEventListener(Window.IAccessibilityEventListener listener)
```
    Set a listener for accessibility events.
    
    参数:
    
    listener - Indicate the listener to set.
    
    从以下版本开始:
    
    3
  - setInputPanelDisplayType
```
public void setInputPanelDisplayType(int type)
```
    Set the display type for the soft input panel.
    
    参数:
    
    type - Indicates the display type to set, which can be WindowManager.LayoutConfig#INPUT_ADJUST_RESIZE, WindowManager.LayoutConfig#INPUT_ADJUST_PAN, or WindowManager.LayoutConfig#INPUT_ADJUST_NOTHING.
    
    抛出:
    
    NullPointerException - Throws this exception if mAgpWindow is null.
    
    从以下版本开始:
    
    4
  - getAltitude
```
public float getAltitude()
```
    Obtains the altitude of a window in the direction perpendicular to the phone screen.
    
    返回:
    
    Returns the altitude of the window in the direction perpendicular to the phone screen.
    
    从以下版本开始:
    
    8
    
    另请参阅:
    
    setAltitude(float)
  - setAltitude
```
public void setAltitude(float altitude)
```
    Sets the altitude of a window in the direction perpendicular to the phone screen.
    
    参数:
    
    Indicates - the altitude of the window in the direction perpendicular to the phone screen.
    
    从以下版本开始:
    
    8
    
    另请参阅:
    
    getAltitude()
  - setShadowStyle
```
public void setShadowStyle(Component.ShadowSize size,
                           Component.ShadowMode mode,
                           Component.ShadowDevice device)
```
    Sets the shadow style of a window.
    The shadow style is generated based on the input size, mode, and device.
    
    参数:
    
    size - Indicates the shadow size, which is defined in Component.ShadowSize.
    
    mode - Indicates the shadow mode, which is defined in Component.ShadowMode.
    
    device - Indicates the device type, which is defined in Component.ShadowDevice.
    
    从以下版本开始:
    
    8

类 Window

嵌套类概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

Window

方法详细资料

isMovable

setMovable

getBoundRect

setBoundRect

getLayoutConfig

setLayoutConfig

setLayoutAlignment

addFlags

clearFlags

setLayoutFlags

setWindowLayout

setNavigationBarColor

setStatusBarColor

setPadding

setStatusBarVisibility

getStatusBarVisibility

setSystemBarStyle

getSystemBarStyle

getCurrentComponentFocus

setBackgroundColor

setBackground

addWindowFlags

clearWindowFlags

setWindowFlags

setTransparent

setOnApplyComponentPaddingListener

getLayoutScatter

isActive

isWCGMode

setPixelFormat

replicateFrom

setLayoutInDisplaySideMode

setLayoutInNotchMode

setAccessibilityEventListener

setInputPanelDisplayType

getAltitude

setAltitude

setShadowStyle