鴻蒙OS ComponentPadding

ComponentPadding

java.lang.Object

|---ohos.agp.window.service.ComponentPadding

public class ComponentPadding
extends Object

描述窗口填充。

通過(guò) Window#setOnApplyComponentPaddingListener 設(shè)置監(jiān)聽(tīng)器后，將在填充更改時(shí)調(diào)用回調(diào) IApplyComponentPaddingListener#notifyPaddingChange(ComponentPadding padding)。 應(yīng)用程序?qū)⑹褂脗鬟f給回調(diào)的新填充值進(jìn)行布局。

Since:

5

構(gòu)造函數(shù)摘要

構(gòu)造函數(shù)	描述
ComponentPadding()	用于創(chuàng)建 ComponentPadding 實(shí)例的構(gòu)造函數(shù)。

方法總結(jié)

修飾符和類型	方法	描述
DisplayNotch	getDisplayNotch()	獲取有關(guān)顯示槽口的信息。
Rect	getGestureRect()	獲取可設(shè)置的系統(tǒng)手勢(shì)區(qū)域。
Rect	getNotSettableGestureRect()	獲取無(wú)法設(shè)置的系統(tǒng)手勢(shì)區(qū)域。
int	getSystemComponentPaddingBottom()	從系統(tǒng)窗口獲取到屏幕底部的填充。
int	getSystemComponentPaddingLeft()	從屏幕左側(cè)的系統(tǒng)窗口獲取填充。
int	getSystemComponentPaddingRight()	從屏幕右側(cè)的系統(tǒng)窗口獲取填充。
int	getSystemComponentPaddingTop()	獲取從系統(tǒng)窗口到屏幕頂部的填充。
int	getUnchangedPaddingBottom()	獲取從未更改區(qū)域到屏幕底部的填充。
int	getUnchangedPaddingLeft()	從屏幕左側(cè)未更改的區(qū)域獲取填充。
int	getUnchangedPaddingRight()	從屏幕右側(cè)未更改的區(qū)域獲取填充。
int	getUnchangedPaddingTop()	獲取從未更改區(qū)域到屏幕頂部的填充。
boolean	hasNonZeroPadding()	檢查是否有任何非零填充。
boolean	hasSystemComponentPadding()	檢查系統(tǒng)窗口是否有任何填充。
boolean	hasUnchangedPadding()	檢查是否有任何未更改的窗口填充。
boolean	isPaddingFullyUsed()	檢查填充是否被充分使用。
boolean	isRoundCorner()	檢查關(guān)聯(lián)窗口是否有圓角。
ComponentPadding	useDisplayNotch()	清除顯示槽口。
ComponentPadding	useSystemComponentPadding()	清除系統(tǒng)組件填充。
ComponentPadding	useUnchangedPadding()	清除未更改的區(qū)域。

從類 java.lang.Object 繼承的方法
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

構(gòu)造函數(shù)詳細(xì)信息

ComponentPadding

public ComponentPadding()

用于創(chuàng)建 ComponentPadding 實(shí)例的構(gòu)造函數(shù)。

方法詳情

getNotSettableGestureRect

public Rect getNotSettableGestureRect()

獲取無(wú)法設(shè)置的系統(tǒng)手勢(shì)區(qū)域。

返回:

返回一個(gè) Rect 對(duì)象，表示獲得的系統(tǒng)手勢(shì)區(qū)域。

Throws:

Throw名稱	Throw描述
ohos.agp.window.view.WindowInsetsWrapper.ParameterInvalidException	如果 mWindowInsetsWrapper 無(wú)效，則拋出此異常。

Since:

5

getGestureRect

public Rect getGestureRect()

獲取可設(shè)置的系統(tǒng)手勢(shì)區(qū)域。

返回:

返回一個(gè) Rect 對(duì)象，表示獲得的系統(tǒng)手勢(shì)區(qū)域。

Throws:

Throw名稱	Throw描述
ohos.agp.window.view.WindowInsetsWrapper.ParameterInvalidException	如果 mWindowInsetsWrapper 無(wú)效，則拋出此異常。

Since:

5

useDisplayNotch

public ComponentPadding useDisplayNotch()

清除顯示槽口。

返回:

返回一個(gè)清除顯示槽口的新 ComponentPadding 對(duì)象。

Throws:

Throw名稱	Throw描述
ohos.agp.window.view.WindowInsetsWrapper.ParameterInvalidException	如果 mWindowInsetsWrapper 無(wú)效，則拋出此異常。

Since:

5

useUnchangedPadding

public ComponentPadding useUnchangedPadding()

清除未更改的區(qū)域。

在未更改的區(qū)域中，與狀態(tài)欄關(guān)聯(lián)的填充值不會(huì)更改，無(wú)論狀態(tài)欄是顯示還是隱藏。

返回:

返回一個(gè)清除未更改區(qū)域的新 ComponentPadding 對(duì)象。

Throws:

Throw名稱	Throw描述
ohos.agp.window.view.WindowInsetsWrapper.ParameterInvalidException	如果 mWindowInsetsWrapper 無(wú)效，則拋出此異常。

Since:

5

useSystemComponentPadding

public ComponentPadding useSystemComponentPadding()

清除系統(tǒng)組件填充。

返回:

返回一個(gè)清除了填充的新 ComponentPadding 對(duì)象。

Throws:

Throw名稱	Throw描述
ohos.agp.window.view.WindowInsetsWrapper.ParameterInvalidException	如果 mWindowInsetsWrapper 無(wú)效，則拋出此異常。

Since:

5

getDisplayNotch

public DisplayNotch getDisplayNotch()

獲取有關(guān)顯示槽口的信息。

返回:

返回一個(gè) DisplayNotch 對(duì)象。

Throws:

Throw名稱	Throw描述
ohos.agp.window.view.WindowInsetsWrapper.ParameterInvalidException	如果 mWindowInsetsWrapper 無(wú)效，則拋出此異常。

Since:

5

getUnchangedPaddingBottom

public int getUnchangedPaddingBottom()

獲取從未更改區(qū)域到屏幕底部的填充。

返回:

返回填充，以像素為單位。

Throws:

Throw名稱	Throw描述
ohos.agp.window.view.WindowInsetsWrapper.ParameterInvalidException	如果 mWindowInsetsWrapper 無(wú)效，則拋出此異常。

Since:

5

getUnchangedPaddingLeft

public int getUnchangedPaddingLeft()

從屏幕左側(cè)未更改的區(qū)域獲取填充。

返回:

返回填充，以像素為單位。

Throws:

Throw名稱	Throw描述
ohos.agp.window.view.WindowInsetsWrapper.ParameterInvalidException	如果 mWindowInsetsWrapper 無(wú)效，則拋出此異常。

Since:

5

getUnchangedPaddingRight

public int getUnchangedPaddingRight()

從屏幕右側(cè)未更改的區(qū)域獲取填充。

返回:

返回填充，以像素為單位。

Throws:

Throw名稱	Throw描述
ohos.agp.window.view.WindowInsetsWrapper.ParameterInvalidException	如果 mWindowInsetsWrapper 無(wú)效，則拋出此異常。

Since:

5

getUnchangedPaddingTop

public int getUnchangedPaddingTop()

獲取從未更改區(qū)域到屏幕頂部的填充。

返回:

返回填充，以像素為單位。

Throws:

Throw名稱	Throw描述
ohos.agp.window.view.WindowInsetsWrapper.ParameterInvalidException	如果 mWindowInsetsWrapper 無(wú)效，則拋出此異常。

Since:

5

getSystemComponentPaddingBottom

public int getSystemComponentPaddingBottom()

從系統(tǒng)窗口獲取到屏幕底部的填充。

返回:

返回填充，以像素為單位。

Throws:

Throw名稱	Throw描述
ohos.agp.window.view.WindowInsetsWrapper.ParameterInvalidException	如果 mWindowInsetsWrapper 無(wú)效，則拋出此異常。

Since:

5

getSystemComponentPaddingLeft

public int getSystemComponentPaddingLeft()

從屏幕左側(cè)的系統(tǒng)窗口獲取填充。

返回:

返回填充，以像素為單位。

Throws:

Throw名稱	Throw描述
ohos.agp.window.view.WindowInsetsWrapper.ParameterInvalidException	如果 mWindowInsetsWrapper 無(wú)效，則拋出此異常。

Since:

5

getSystemComponentPaddingRight

public int getSystemComponentPaddingRight()

從屏幕右側(cè)的系統(tǒng)窗口獲取填充。

返回:

返回填充，以像素為單位。

Throws:

Throw名稱	Throw描述
ohos.agp.window.view.WindowInsetsWrapper.ParameterInvalidException	如果 mWindowInsetsWrapper 無(wú)效，則拋出此異常。

Since:

5

getSystemComponentPaddingTop

public int getSystemComponentPaddingTop()

獲取從系統(tǒng)窗口到屏幕頂部的填充。

返回:

返回填充，以像素為單位。

Throws:

Throw名稱	Throw描述
ohos.agp.window.view.WindowInsetsWrapper.ParameterInvalidException	如果 mWindowInsetsWrapper 無(wú)效，則拋出此異常。

Since:

5

hasNonZeroPadding

public boolean hasNonZeroPadding()

檢查是否有任何非零填充。

返回:

如果非零填充可用，則返回 true； 否則返回假。

Throws:

Throw名稱	Throw描述
ohos.agp.window.view.WindowInsetsWrapper.ParameterInvalidException	如果 mWindowInsetsWrapper 無(wú)效，則拋出此異常。

Since:

5

hasUnchangedPadding

public boolean hasUnchangedPadding()

檢查是否有任何未更改的窗口填充。

返回:

如果未更改的窗口填充可用，則返回 true； 否則返回 false。

Throws:

Throw名稱	Throw描述
ohos.agp.window.view.WindowInsetsWrapper.ParameterInvalidException	如果 mWindowInsetsWrapper 無(wú)效，則拋出此異常。

Since:

5

hasSystemComponentPadding

public boolean hasSystemComponentPadding()

檢查系統(tǒng)窗口是否有任何填充。

返回:

如果填充可用于系統(tǒng)窗口，則返回 true； 否則返回 false。

Throws:

Throw名稱	Throw描述
ohos.agp.window.view.WindowInsetsWrapper.ParameterInvalidException	如果 mWindowInsetsWrapper 無(wú)效，則拋出此異常。

Since:

5

isPaddingFullyUsed

public boolean isPaddingFullyUsed()

檢查填充是否被充分使用。

返回:

如果填充被完全使用，則返回 true； 否則返回 false。

Throws:

Throw名稱	Throw描述
ohos.agp.window.view.WindowInsetsWrapper.ParameterInvalidException	如果 mWindowInsetsWrapper 無(wú)效，則拋出此異常。

Since:

5

isRoundCorner

public boolean isRoundCorner()

檢查關(guān)聯(lián)窗口是否有圓角。

返回:

如果關(guān)聯(lián)的窗口有圓角，則返回 true； 否則返回 false。

Throws:

Throw名稱	Throw描述
ohos.agp.window.view.WindowInsetsWrapper.ParameterInvalidException	如果 mWindowInsetsWrapper 無(wú)效，則拋出此異常。

Since:

5