鸿蒙OS DisplayNotch

DisplayNotch

java.lang.Object

|---ohos.agp.window.service.DisplayNotch

public class DisplayNotch
extends Object

表示一个显示槽口，不能用于显示内容。

您可以使用此类中的方法来获取设备上的缺口大小和安全填充。

Since:

5

构造函数摘要

构造函数	描述
DisplayNotch()	用于创建 DisplayNotch 实例的构造函数。

方法总结

修饰符和类型	方法	描述
boolean	equals(Object object)	检查此 DisplayNotch 对象是否等于指定的对象。
Rect	getNotchRectBottom()	获取屏幕底部的矩形显示槽口。
Rect	getNotchRectLeft()	获取屏幕左侧的矩形显示槽口。
Rect	getNotchRectRight()	获取屏幕右侧的矩形显示槽口。
ListRect	getNotchRects()	获取 Rect 对象列表，每个对象代表屏幕上的一个矩形显示槽口。
Rect	getNotchRectTop()	获取屏幕顶部的矩形显示槽口。
int	getPaddingBottom()	从屏幕底部获取安全填充，不包括显示槽口。
int	getPaddingLeft()	从屏幕左侧获取安全填充，不包括显示槽口。
int	getPaddingRight()	从屏幕右侧获取安全填充，不包括显示槽口。
int	getPaddingTop()	从屏幕顶部获取安全填充，不包括显示槽口。
int	hashCode()	获取此 DisplayNotch 对象的哈希码。
String	toString()	返回表示此 DisplayNotch 对象的字符串。

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

构造函数详细信息

DisplayNotch

public DisplayNotch()

用于创建 DisplayNotch 实例的构造函数。

方法详情

getNotchRectBottom

public Rect getNotchRectBottom()

获取屏幕底部的矩形显示槽口。

返回:

返回一个 Rect 对象，以像素为单位。

Throws:

Throw名称	Throw描述
ohos.agp.window.view.DisplayCutoutWrapper.ParameterInvalidException	如果 mDisplayCutoutWrapper 为空，则抛出此异常。

Since:

5

getNotchRectLeft

public Rect getNotchRectLeft()

获取屏幕左侧的矩形显示槽口。

返回:

返回一个 Rect 对象，以像素为单位。

Throws:

Throw名称	Throw描述
ohos.agp.window.view.DisplayCutoutWrapper.ParameterInvalidException	如果 mDisplayCutoutWrapper 为空，则抛出此异常。

Since:

5

getNotchRectRight

public Rect getNotchRectRight()

获取屏幕右侧的矩形显示槽口。

返回:

返回一个 Rect 对象，以像素为单位。

Throws:

Throw名称	Throw描述
ohos.agp.window.view.DisplayCutoutWrapper.ParameterInvalidException	如果 mDisplayCutoutWrapper 为空，则抛出此异常。

Since:

5

getNotchRectTop

public Rect getNotchRectTop()

获取屏幕顶部的矩形显示槽口。

返回:

返回一个 Rect 对象，以像素为单位。

Throws:

Throw名称	Throw描述
ohos.agp.window.view.DisplayCutoutWrapper.ParameterInvalidException	如果 mDisplayCutoutWrapper 为空，则抛出此异常。

Since:

5

getNotchRects

public ListRect getNotchRects()

获取 Rect 对象列表，每个对象代表屏幕上的一个矩形显示槽口。

返回:

返回 Rect 对象的列表。

Throws:

Throw名称	Throw描述
ohos.agp.window.view.DisplayCutoutWrapper.ParameterInvalidException	如果 mDisplayCutoutWrapper 为空，则抛出此异常。

Since:

5

getPaddingBottom

public int getPaddingBottom()

从屏幕底部获取安全填充，不包括显示槽口。

返回:

从底部返回安全填充，以像素为单位。

Throws:

Throw名称	Throw描述
ohos.agp.window.view.DisplayCutoutWrapper.ParameterInvalidException	如果 mDisplayCutoutWrapper 为空，则抛出此异常。

Since:

5

getPaddingLeft

public int getPaddingLeft()

从屏幕左侧获取安全填充，不包括显示槽口。

返回:

从左侧返回安全填充，以像素为单位。

Throws:

Throw名称	Throw描述
ohos.agp.window.view.DisplayCutoutWrapper.ParameterInvalidException	如果 mDisplayCutoutWrapper 为空，则抛出此异常。

Since:

5

getPaddingRight

public int getPaddingRight()

从屏幕右侧获取安全填充，不包括显示槽口。

返回:

从右侧返回安全填充，以像素为单位。

Throws:

Throw名称	Throw描述
ohos.agp.window.view.DisplayCutoutWrapper.ParameterInvalidException	如果 mDisplayCutoutWrapper 为空，则抛出此异常。

Since:

5

getPaddingTop

public int getPaddingTop()

从屏幕顶部获取安全填充，不包括显示槽口。

返回:

从顶部返回安全填充，以像素为单位。

Throws:

Throw名称	Throw描述
ohos.agp.window.view.DisplayCutoutWrapper.ParameterInvalidException	如果 mDisplayCutoutWrapper 为空，则抛出此异常。

Since:

5

toString

public String toString()

返回表示此 DisplayNotch 对象的字符串。

覆盖：

类 Object 中的 toString

返回:

返回字符串表示。

Throws:

Throw名称	Throw描述
ohos.agp.window.view.DisplayCutoutWrapper.ParameterInvalidException	如果 mDisplayCutoutWrapper 为空，则抛出此异常。

Since:

5

equals

public boolean equals(Object object)

检查此 DisplayNotch 对象是否等于指定的对象。

覆盖：

类 Object 中的等于

参数：

参数名称	参数描述
object	指示指定的 DisplayNotch 对象进行比较。

返回:

如果它们相等，则返回 true； 否则返回 false。

Throws:

Throw名称	Throw描述
ohos.agp.window.view.DisplayCutoutWrapper.ParameterInvalidException	如果 mDisplayCutoutWrapper 为空，则抛出此异常。

Since:

5

hashCode

public int hashCode()

获取此 DisplayNotch 对象的哈希码。

覆盖：

类 Object 中的 hashCode

返回:

返回哈希码。

Throws:

Throw名称	Throw描述
ohos.agp.window.view.DisplayCutoutWrapper.ParameterInvalidException	如果 mDisplayCutoutWrapper 为空，则抛出此异常。

Since:

5