ComponentPadding

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

```
public class ComponentPadding
extends Object
```
Describe window padding.
After a listener is set via Window#setOnApplyComponentPaddingListener, the callback IApplyComponentPaddingListener#notifyPaddingChange(ComponentPadding padding) will be invoked upon padding changes. Applications will use the new padding values passed to the callback for layout.

从以下版本开始:

5

构造器概要

构造器
构造器说明

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

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

方法概要

所有方法实例方法具体方法
限定符和类型	方法	说明
`DisplayNotch`	`getDisplayNotch()`	Obtain information about a display notch.
`Rect`	`getGestureRect()`	Obtain the system gesture area that can be set.
`Rect`	`getNotSettableGestureRect()`	Obtain the system gesture area that cannot be set.
`int`	`getSystemComponentPaddingBottom()`	Obtain the padding from the system window to the bottom of the screen.
`int`	`getSystemComponentPaddingLeft()`	Obtain the padding from the system window to the left of the screen.
`int`	`getSystemComponentPaddingRight()`	Obtain the padding from the system window to the right of the screen.
`int`	`getSystemComponentPaddingTop()`	Obtain the padding from the system window to the top of the screen.
`int`	`getUnchangedPaddingBottom()`	Obtain the padding from the unchanged area to the bottom of the screen.
`int`	`getUnchangedPaddingLeft()`	Obtain the padding from the unchanged area to the left of the screen.
`int`	`getUnchangedPaddingRight()`	Obtain the padding from the unchanged area to the right of the screen.
`int`	`getUnchangedPaddingTop()`	Obtain the padding from the unchanged area to the top of the screen.
`boolean`	`hasNonZeroPadding()`	Check whether there is any non-zero padding.
`boolean`	`hasSystemComponentPadding()`	Check whether there is any padding for the system window.
`boolean`	`hasUnchangedPadding()`	Check whether there is any unchanged window padding.
`boolean`	`isPaddingFullyUsed()`	Check whether padding is fully used.
`boolean`	`isRoundCorner()`	Check whether the associated window has rounded corners.
`ComponentPadding`	`useDisplayNotch()`	Clear a display notch.
`ComponentPadding`	`useSystemComponentPadding()`	Clear system component paddings.
`ComponentPadding`	`useUnchangedPadding()`	Clear an unchanged area.

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

- 构造器详细资料
  - ComponentPadding
```
public ComponentPadding()
```
    A constructor used to create a ComponentPadding instance.
- 方法详细资料
  - getNotSettableGestureRect
```
public Rect getNotSettableGestureRect()
```
    Obtain the system gesture area that cannot be set.
    
    返回:
    
    Return a Rect object representing the obtained system gesture area.
    
    抛出:
    
    ohos.agp.window.view.WindowInsetsWrapper.ParameterInvalidException - Throw this exception if mWindowInsetsWrapper is invalid.
    
    从以下版本开始:
    
    5
  - getGestureRect
```
public Rect getGestureRect()
```
    Obtain the system gesture area that can be set.
    
    返回:
    
    Return a Rect object representing the obtained system gesture area.
    
    抛出:
    
    ohos.agp.window.view.WindowInsetsWrapper.ParameterInvalidException - Throw this exception if mWindowInsetsWrapper is invalid.
    
    从以下版本开始:
    
    5
  - useDisplayNotch
```
public ComponentPadding useDisplayNotch()
```
    Clear a display notch.
    
    返回:
    
    Return a new ComponentPadding object with the display notch cleared.
    
    抛出:
    
    ohos.agp.window.view.WindowInsetsWrapper.ParameterInvalidException - Throw this exception if mWindowInsetsWrapper is invalid.
    
    从以下版本开始:
    
    5
  - useUnchangedPadding
```
public ComponentPadding useUnchangedPadding()
```
    Clear an unchanged area.
    In an unchanged area, padding values associated with the status bar do not change, regardless of whether the status bar is shown or hidden.
    
    返回:
    
    Return a new ComponentPadding object with the unchanged area cleared.
    
    抛出:
    
    ohos.agp.window.view.WindowInsetsWrapper.ParameterInvalidException - Throw this exception if mWindowInsetsWrapper is invalid.
    
    从以下版本开始:
    
    5
  - useSystemComponentPadding
```
public ComponentPadding useSystemComponentPadding()
```
    Clear system component paddings.
    
    返回:
    
    Return a new ComponentPadding object with paddings cleared.
    
    抛出:
    
    ohos.agp.window.view.WindowInsetsWrapper.ParameterInvalidException - Throw this exception if mWindowInsetsWrapper is invalid.
    
    从以下版本开始:
    
    5
  - getDisplayNotch
```
public DisplayNotch getDisplayNotch()
```
    Obtain information about a display notch.
    
    返回:
    
    Return a DisplayNotch object.
    
    抛出:
    
    ohos.agp.window.view.WindowInsetsWrapper.ParameterInvalidException - Throw this exception if mWindowInsetsWrapper is invalid.
    
    从以下版本开始:
    
    5
  - getUnchangedPaddingBottom
```
public int getUnchangedPaddingBottom()
```
    Obtain the padding from the unchanged area to the bottom of the screen.
    
    返回:
    
    Return the padding, in pixels.
    
    抛出:
    
    ohos.agp.window.view.WindowInsetsWrapper.ParameterInvalidException - Throw this exception if mWindowInsetsWrapper is invalid.
    
    从以下版本开始:
    
    5
  - getUnchangedPaddingLeft
```
public int getUnchangedPaddingLeft()
```
    Obtain the padding from the unchanged area to the left of the screen.
    
    返回:
    
    Return the padding, in pixels.
    
    抛出:
    
    ohos.agp.window.view.WindowInsetsWrapper.ParameterInvalidException - Throw this exception if mWindowInsetsWrapper is invalid.
    
    从以下版本开始:
    
    5
  - getUnchangedPaddingRight
```
public int getUnchangedPaddingRight()
```
    Obtain the padding from the unchanged area to the right of the screen.
    
    返回:
    
    Return the padding, in pixels.
    
    抛出:
    
    ohos.agp.window.view.WindowInsetsWrapper.ParameterInvalidException - Throw this exception if mWindowInsetsWrapper is invalid.
    
    从以下版本开始:
    
    5
  - getUnchangedPaddingTop
```
public int getUnchangedPaddingTop()
```
    Obtain the padding from the unchanged area to the top of the screen.
    
    返回:
    
    Return the padding, in pixels.
    
    抛出:
    
    ohos.agp.window.view.WindowInsetsWrapper.ParameterInvalidException - Throw this exception if mWindowInsetsWrapper is invalid.
    
    从以下版本开始:
    
    5
  - getSystemComponentPaddingBottom
```
public int getSystemComponentPaddingBottom()
```
    Obtain the padding from the system window to the bottom of the screen.
    
    返回:
    
    Return the padding, in pixels.
    
    抛出:
    
    ohos.agp.window.view.WindowInsetsWrapper.ParameterInvalidException - Throw this exception if mWindowInsetsWrapper is invalid.
    
    从以下版本开始:
    
    5
  - getSystemComponentPaddingLeft
```
public int getSystemComponentPaddingLeft()
```
    Obtain the padding from the system window to the left of the screen.
    
    返回:
    
    Return the padding, in pixels.
    
    抛出:
    
    ohos.agp.window.view.WindowInsetsWrapper.ParameterInvalidException - Throw this exception if mWindowInsetsWrapper is invalid.
    
    从以下版本开始:
    
    5
  - getSystemComponentPaddingRight
```
public int getSystemComponentPaddingRight()
```
    Obtain the padding from the system window to the right of the screen.
    
    返回:
    
    Return the padding, in pixels.
    
    抛出:
    
    ohos.agp.window.view.WindowInsetsWrapper.ParameterInvalidException - Throw this exception if mWindowInsetsWrapper is invalid.
    
    从以下版本开始:
    
    5
  - getSystemComponentPaddingTop
```
public int getSystemComponentPaddingTop()
```
    Obtain the padding from the system window to the top of the screen.
    
    返回:
    
    Return the padding, in pixels.
    
    抛出:
    
    ohos.agp.window.view.WindowInsetsWrapper.ParameterInvalidException - Throw this exception if mWindowInsetsWrapper is invalid.
    
    从以下版本开始:
    
    5
  - hasNonZeroPadding
```
public boolean hasNonZeroPadding()
```
    Check whether there is any non-zero padding.
    
    返回:
    
    Return true if non-zero padding is available; return false otherwise.
    
    抛出:
    
    ohos.agp.window.view.WindowInsetsWrapper.ParameterInvalidException - Throw this exception if mWindowInsetsWrapper is invalid.
    
    从以下版本开始:
    
    5
  - hasUnchangedPadding
```
public boolean hasUnchangedPadding()
```
    Check whether there is any unchanged window padding.
    
    返回:
    
    Return true if unchanged window padding is available; return false otherwise.
    
    抛出:
    
    ohos.agp.window.view.WindowInsetsWrapper.ParameterInvalidException - Throw this exception if mWindowInsetsWrapper is invalid.
    
    从以下版本开始:
    
    5
  - hasSystemComponentPadding
```
public boolean hasSystemComponentPadding()
```
    Check whether there is any padding for the system window.
    
    返回:
    
    Return true if padding is available for the system window; return false otherwise.
    
    抛出:
    
    ohos.agp.window.view.WindowInsetsWrapper.ParameterInvalidException - Throw this exception if mWindowInsetsWrapper is invalid.
    
    从以下版本开始:
    
    5
  - isPaddingFullyUsed
```
public boolean isPaddingFullyUsed()
```
    Check whether padding is fully used.
    
    返回:
    
    Return true if padding is fully used; return false otherwise.
    
    抛出:
    
    ohos.agp.window.view.WindowInsetsWrapper.ParameterInvalidException - Throw this exception if mWindowInsetsWrapper is invalid.
    
    从以下版本开始:
    
    5
  - isRoundCorner
```
public boolean isRoundCorner()
```
    Check whether the associated window has rounded corners.
    
    返回:
    
    Return true if the associated window has rounded corners; return false otherwise.
    
    抛出:
    
    ohos.agp.window.view.WindowInsetsWrapper.ParameterInvalidException - Throw this exception if mWindowInsetsWrapper is invalid.
    
    从以下版本开始:
    
    5

类 ComponentPadding

构造器概要

方法概要

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

构造器详细资料

ComponentPadding

方法详细资料

getNotSettableGestureRect

getGestureRect

useDisplayNotch

useUnchangedPadding

useSystemComponentPadding

getDisplayNotch

getUnchangedPaddingBottom

getUnchangedPaddingLeft

getUnchangedPaddingRight

getUnchangedPaddingTop

getSystemComponentPaddingBottom

getSystemComponentPaddingLeft

getSystemComponentPaddingRight

getSystemComponentPaddingTop

hasNonZeroPadding

hasUnchangedPadding

hasSystemComponentPadding

isPaddingFullyUsed

isRoundCorner