ComponentPadding
java.lang.Object
|—ohos.agp.window.service.ComponentPadding
public class ComponentPadding
extends Object
描述窗口填充。
通过 Window#setOnApplyComponentPaddingListener 设置监听器后,将在填充更改时调用回调 IApplyComponentPaddingListener#notifyPaddingChange(ComponentPadding padding)。 应用程序将使用传递给回调的新填充值进行布局。
Since:
5
构造函数摘要
构造函数 | 描述 |
---|---|
ComponentPadding() | 用于创建 ComponentPadding 实例的构造函数。 |
方法总结
修饰符和类型 | 方法 | 描述 |
---|---|---|
DisplayNotch | getDisplayNotch() | 获取有关显示槽口的信息。 |
Rect | getGestureRect() | 获取可设置的系统手势区域。 |
Rect | getNotSettableGestureRect() | 获取无法设置的系统手势区域。 |
int | getSystemComponentPaddingBottom() | 从系统窗口获取到屏幕底部的填充。 |
int | getSystemComponentPaddingLeft() | 从屏幕左侧的系统窗口获取填充。 |
int | getSystemComponentPaddingRight() | 从屏幕右侧的系统窗口获取填充。 |
int | getSystemComponentPaddingTop() | 获取从系统窗口到屏幕顶部的填充。 |
int | getUnchangedPaddingBottom() | 获取从未更改区域到屏幕底部的填充。 |
int | getUnchangedPaddingLeft() | 从屏幕左侧未更改的区域获取填充。 |
int | getUnchangedPaddingRight() | 从屏幕右侧未更改的区域获取填充。 |
int | getUnchangedPaddingTop() | 获取从未更改区域到屏幕顶部的填充。 |
boolean | hasNonZeroPadding() | 检查是否有任何非零填充。 |
boolean | hasSystemComponentPadding() | 检查系统窗口是否有任何填充。 |
boolean | hasUnchangedPadding() | 检查是否有任何未更改的窗口填充。 |
boolean | isPaddingFullyUsed() | 检查填充是否被充分使用。 |
boolean | isRoundCorner() | 检查关联窗口是否有圆角。 |
ComponentPadding | useDisplayNotch() | 清除显示槽口。 |
ComponentPadding | useSystemComponentPadding() | 清除系统组件填充。 |
ComponentPadding | useUnchangedPadding() | 清除未更改的区域。 |
从类 java.lang.Object 继承的方法 |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
构造函数详细信息
ComponentPadding
public ComponentPadding()
用于创建 ComponentPadding 实例的构造函数。
方法详情
getNotSettableGestureRect
public Rect getNotSettableGestureRect()
获取无法设置的系统手势区域。
返回:
返回一个 Rect 对象,表示获得的系统手势区域。
Throws:
Throw名称 | Throw描述 |
---|---|
ohos.agp.window.view.WindowInsetsWrapper.ParameterInvalidException | 如果 mWindowInsetsWrapper 无效,则抛出此异常。 |
Since:
5
getGestureRect
public Rect getGestureRect()
获取可设置的系统手势区域。
返回:
返回一个 Rect 对象,表示获得的系统手势区域。
Throws:
Throw名称 | Throw描述 |
---|---|
ohos.agp.window.view.WindowInsetsWrapper.ParameterInvalidException | 如果 mWindowInsetsWrapper 无效,则抛出此异常。 |
Since:
5
useDisplayNotch
public ComponentPadding useDisplayNotch()
清除显示槽口。
返回:
返回一个清除显示槽口的新 ComponentPadding 对象。
Throws:
Throw名称 | Throw描述 |
---|---|
ohos.agp.window.view.WindowInsetsWrapper.ParameterInvalidException | 如果 mWindowInsetsWrapper 无效,则抛出此异常。 |
Since:
5
useUnchangedPadding
public ComponentPadding useUnchangedPadding()
清除未更改的区域。
在未更改的区域中,与状态栏关联的填充值不会更改,无论状态栏是显示还是隐藏。
返回:
返回一个清除未更改区域的新 ComponentPadding 对象。
Throws:
Throw名称 | Throw描述 |
---|---|
ohos.agp.window.view.WindowInsetsWrapper.ParameterInvalidException | 如果 mWindowInsetsWrapper 无效,则抛出此异常。 |
Since:
5
useSystemComponentPadding
public ComponentPadding useSystemComponentPadding()
清除系统组件填充。
返回:
返回一个清除了填充的新 ComponentPadding 对象。
Throws:
Throw名称 | Throw描述 |
---|---|
ohos.agp.window.view.WindowInsetsWrapper.ParameterInvalidException | 如果 mWindowInsetsWrapper 无效,则抛出此异常。 |
Since:
5
getDisplayNotch
public DisplayNotch getDisplayNotch()
获取有关显示槽口的信息。
返回:
返回一个 DisplayNotch 对象。
Throws:
Throw名称 | Throw描述 |
---|---|
ohos.agp.window.view.WindowInsetsWrapper.ParameterInvalidException | 如果 mWindowInsetsWrapper 无效,则抛出此异常。 |
Since:
5
getUnchangedPaddingBottom
public int getUnchangedPaddingBottom()
获取从未更改区域到屏幕底部的填充。
返回:
返回填充,以像素为单位。
Throws:
Throw名称 | Throw描述 |
---|---|
ohos.agp.window.view.WindowInsetsWrapper.ParameterInvalidException | 如果 mWindowInsetsWrapper 无效,则抛出此异常。 |
Since:
5
getUnchangedPaddingLeft
public int getUnchangedPaddingLeft()
从屏幕左侧未更改的区域获取填充。
返回:
返回填充,以像素为单位。
Throws:
Throw名称 | Throw描述 |
---|---|
ohos.agp.window.view.WindowInsetsWrapper.ParameterInvalidException | 如果 mWindowInsetsWrapper 无效,则抛出此异常。 |
Since:
5
getUnchangedPaddingRight
public int getUnchangedPaddingRight()
从屏幕右侧未更改的区域获取填充。
返回:
返回填充,以像素为单位。
Throws:
Throw名称 | Throw描述 |
---|---|
ohos.agp.window.view.WindowInsetsWrapper.ParameterInvalidException | 如果 mWindowInsetsWrapper 无效,则抛出此异常。 |
Since:
5
getUnchangedPaddingTop
public int getUnchangedPaddingTop()
获取从未更改区域到屏幕顶部的填充。
返回:
返回填充,以像素为单位。
Throws:
Throw名称 | Throw描述 |
---|---|
ohos.agp.window.view.WindowInsetsWrapper.ParameterInvalidException | 如果 mWindowInsetsWrapper 无效,则抛出此异常。 |
Since:
5
getSystemComponentPaddingBottom
public int getSystemComponentPaddingBottom()
从系统窗口获取到屏幕底部的填充。
返回:
返回填充,以像素为单位。
Throws:
Throw名称 | Throw描述 |
---|---|
ohos.agp.window.view.WindowInsetsWrapper.ParameterInvalidException | 如果 mWindowInsetsWrapper 无效,则抛出此异常。 |
Since:
5
getSystemComponentPaddingLeft
public int getSystemComponentPaddingLeft()
从屏幕左侧的系统窗口获取填充。
返回:
返回填充,以像素为单位。
Throws:
Throw名称 | Throw描述 |
---|---|
ohos.agp.window.view.WindowInsetsWrapper.ParameterInvalidException | 如果 mWindowInsetsWrapper 无效,则抛出此异常。 |
Since:
5
getSystemComponentPaddingRight
public int getSystemComponentPaddingRight()
从屏幕右侧的系统窗口获取填充。
返回:
返回填充,以像素为单位。
Throws:
Throw名称 | Throw描述 |
---|---|
ohos.agp.window.view.WindowInsetsWrapper.ParameterInvalidException | 如果 mWindowInsetsWrapper 无效,则抛出此异常。 |
Since:
5
getSystemComponentPaddingTop
public int getSystemComponentPaddingTop()
获取从系统窗口到屏幕顶部的填充。
返回:
返回填充,以像素为单位。
Throws:
Throw名称 | Throw描述 |
---|---|
ohos.agp.window.view.WindowInsetsWrapper.ParameterInvalidException | 如果 mWindowInsetsWrapper 无效,则抛出此异常。 |
Since:
5
hasNonZeroPadding
public boolean hasNonZeroPadding()
检查是否有任何非零填充。
返回:
如果非零填充可用,则返回 true; 否则返回假。
Throws:
Throw名称 | Throw描述 |
---|---|
ohos.agp.window.view.WindowInsetsWrapper.ParameterInvalidException | 如果 mWindowInsetsWrapper 无效,则抛出此异常。 |
Since:
5
hasUnchangedPadding
public boolean hasUnchangedPadding()
检查是否有任何未更改的窗口填充。
返回:
如果未更改的窗口填充可用,则返回 true; 否则返回 false。
Throws:
Throw名称 | Throw描述 |
---|---|
ohos.agp.window.view.WindowInsetsWrapper.ParameterInvalidException | 如果 mWindowInsetsWrapper 无效,则抛出此异常。 |
Since:
5
hasSystemComponentPadding
public boolean hasSystemComponentPadding()
检查系统窗口是否有任何填充。
返回:
如果填充可用于系统窗口,则返回 true; 否则返回 false。
Throws:
Throw名称 | Throw描述 |
---|---|
ohos.agp.window.view.WindowInsetsWrapper.ParameterInvalidException | 如果 mWindowInsetsWrapper 无效,则抛出此异常。 |
Since:
5
isPaddingFullyUsed
public boolean isPaddingFullyUsed()
检查填充是否被充分使用。
返回:
如果填充被完全使用,则返回 true; 否则返回 false。
Throws:
Throw名称 | Throw描述 |
---|---|
ohos.agp.window.view.WindowInsetsWrapper.ParameterInvalidException | 如果 mWindowInsetsWrapper 无效,则抛出此异常。 |
Since:
5
isRoundCorner
public boolean isRoundCorner()
检查关联窗口是否有圆角。
返回:
如果关联的窗口有圆角,则返回 true; 否则返回 false。
Throws:
Throw名称 | Throw描述 |
---|---|
ohos.agp.window.view.WindowInsetsWrapper.ParameterInvalidException | 如果 mWindowInsetsWrapper 无效,则抛出此异常。 |
Since:
5