Added in API level 28

DisplayCutout


class DisplayCutout
kotlin.Any
   ↳ android.view.DisplayCutout

Represents the area of the display that is not functional for displaying content.

DisplayCutout is immutable.

Summary

Nested classes

A Builder class to construct a DisplayCutout instance.

Public constructors
DisplayCutout(safeInsets: Insets, boundLeft: Rect?, boundTop: Rect?, boundRight: Rect?, boundBottom: Rect?)

Creates a DisplayCutout instance.

DisplayCutout(safeInsets: Insets, boundLeft: Rect?, boundTop: Rect?, boundRight: Rect?, boundBottom: Rect?, waterfallInsets: Insets)

Creates a DisplayCutout instance.

DisplayCutout(safeInsets: Rect?, boundingRects: MutableList<Rect!>?)

Creates a DisplayCutout instance.

Public methods
Boolean
equals(other: Any?)

Indicates whether some other object is "equal to" this one.

Rect

Returns a bounding rectangle for a non-functional area on the display which is located on the bottom of the screen.

Rect

Returns a bounding rectangle for a non-functional area on the display which is located on the left of the screen.

Rect

Returns a bounding rectangle for a non-functional area on the display which is located on the right of the screen.

Rect

Returns a bounding rectangle for a non-functional area on the display which is located on the top of the screen.

MutableList<Rect!>

Returns a list of Rects, each of which is the bounding rectangle for a non-functional area on the display.

Path?

Returns a Path that contains the cutout paths of all sides on the display.

Int

Returns the inset from the bottom which avoids the display cutout in pixels.

Int

Returns the inset from the left which avoids the display cutout in pixels.

Int

Returns the inset from the right which avoids the display cutout in pixels.

Int

Returns the inset from the top which avoids the display cutout in pixels.

Insets

Returns the insets representing the curved areas of a waterfall display.

Int

String

Public constructors

DisplayCutout

Added in API level 29
DisplayCutout(
    safeInsets: Insets,
    boundLeft: Rect?,
    boundTop: Rect?,
    boundRight: Rect?,
    boundBottom: Rect?)

Creates a DisplayCutout instance.

Note that this is only useful for tests. For production code, developers should always use a DisplayCutout obtained from the system.

Parameters
safeInsets Insets: the insets from each edge which avoid the display cutout as returned by getSafeInsetTop() etc. This value cannot be null.
boundLeft Rect?: the left bounding rect of the display cutout in pixels. If null is passed, it's treated as an empty rectangle (0,0)-(0,0).
boundTop Rect?: the top bounding rect of the display cutout in pixels. If null is passed, it's treated as an empty rectangle (0,0)-(0,0).
boundRight Rect?: the right bounding rect of the display cutout in pixels. If null is passed, it's treated as an empty rectangle (0,0)-(0,0).
boundBottom Rect?: the bottom bounding rect of the display cutout in pixels. If null is passed, it's treated as an empty rectangle (0,0)-(0,0).

DisplayCutout

Added in API level 30
DisplayCutout(
    safeInsets: Insets,
    boundLeft: Rect?,
    boundTop: Rect?,
    boundRight: Rect?,
    boundBottom: Rect?,
    waterfallInsets: Insets)

Creates a DisplayCutout instance.

Note that this is only useful for tests. For production code, developers should always use a DisplayCutout obtained from the system.

Parameters
safeInsets Insets: the insets from each edge which avoid the display cutout as returned by getSafeInsetTop() etc. This value cannot be null.
boundLeft Rect?: the left bounding rect of the display cutout in pixels. If null is passed, it's treated as an empty rectangle (0,0)-(0,0).
boundTop Rect?: the top bounding rect of the display cutout in pixels. If null is passed, it's treated as an empty rectangle (0,0)-(0,0).
boundRight Rect?: the right bounding rect of the display cutout in pixels. If null is passed, it's treated as an empty rectangle (0,0)-(0,0).
boundBottom Rect?: the bottom bounding rect of the display cutout in pixels. If null is passed, it's treated as an empty rectangle (0,0)-(0,0).
waterfallInsets Insets: the insets for the curved areas in waterfall display. This value cannot be null.

DisplayCutout

Added in API level 28
DisplayCutout(
    safeInsets: Rect?,
    boundingRects: MutableList<Rect!>?)

Deprecated: Use DisplayCutout#DisplayCutout(Insets, Rect, Rect, Rect, Rect) instead.

Creates a DisplayCutout instance.

Note that this is only useful for tests. For production code, developers should always use a DisplayCutout obtained from the system.

Parameters
safeInsets Rect?: the insets from each edge which avoid the display cutout as returned by getSafeInsetTop() etc. This value may be null.
boundingRects MutableList<Rect!>?: the bounding rects of the display cutouts as returned by getBoundingRects() ()}. This value may be null.

Public methods

equals

Added in API level 28
fun equals(other: Any?): Boolean

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj the reference object with which to compare.
o This value may be null.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

getBoundingRectBottom

Added in API level 29
fun getBoundingRectBottom(): Rect

Returns a bounding rectangle for a non-functional area on the display which is located on the bottom of the screen.

Return
Rect bounding rectangle in pixels. In case of no bounding rectangle, an empty rectangle is returned. This value cannot be null.

getBoundingRectLeft

Added in API level 29
fun getBoundingRectLeft(): Rect

Returns a bounding rectangle for a non-functional area on the display which is located on the left of the screen.

Return
Rect bounding rectangle in pixels. In case of no bounding rectangle, an empty rectangle is returned. This value cannot be null.

getBoundingRectRight

Added in API level 29
fun getBoundingRectRight(): Rect

Returns a bounding rectangle for a non-functional area on the display which is located on the right of the screen.

Return
Rect bounding rectangle in pixels. In case of no bounding rectangle, an empty rectangle is returned. This value cannot be null.

getBoundingRectTop

Added in API level 29
fun getBoundingRectTop(): Rect

Returns a bounding rectangle for a non-functional area on the display which is located on the top of the screen.

Return
Rect bounding rectangle in pixels. In case of no bounding rectangle, an empty rectangle is returned. This value cannot be null.

getBoundingRects

Added in API level 28
fun getBoundingRects(): MutableList<Rect!>

Returns a list of Rects, each of which is the bounding rectangle for a non-functional area on the display. There will be at most one non-functional area per edge of the device.

Note that there is no bounding rectangle for waterfall cutout since it just represents the curved areas of the display but not the non-functional areas.

Return
MutableList<Rect!> a list of bounding Rects, one for each display cutout area. No empty Rect is returned. This value cannot be null.

getCutoutPath

Added in API level 31
fun getCutoutPath(): Path?

Returns a Path that contains the cutout paths of all sides on the display. To get a cutout path for one specific side, apps can intersect the Path with the Rect obtained from getBoundingRectLeft(), getBoundingRectTop(), getBoundingRectRight() or getBoundingRectBottom().

Return
Path? a Path contains all the cutout paths based on display coordinate. Returns null if there is no cutout on the display.

getSafeInsetBottom

Added in API level 28
fun getSafeInsetBottom(): Int

Returns the inset from the bottom which avoids the display cutout in pixels.

getSafeInsetLeft

Added in API level 28
fun getSafeInsetLeft(): Int

Returns the inset from the left which avoids the display cutout in pixels.

getSafeInsetRight

Added in API level 28
fun getSafeInsetRight(): Int

Returns the inset from the right which avoids the display cutout in pixels.

getSafeInsetTop

Added in API level 28
fun getSafeInsetTop(): Int

Returns the inset from the top which avoids the display cutout in pixels.

getWaterfallInsets

Added in API level 30
fun getWaterfallInsets(): Insets

Returns the insets representing the curved areas of a waterfall display. A waterfall display has curved areas along the edges of the screen. Apps should be careful when showing UI and handling touch input in those insets because the curve may impair legibility and can frequently lead to unintended touch inputs.

Return
Insets the insets for the curved areas of a waterfall display in pixels or Insets.NONE if there are no curved areas or they don't overlap with the window. This value cannot be null.

hashCode

Added in API level 28
fun hashCode(): Int
Return
Int a hash code value for this object.

toString

Added in API level 28
fun toString(): String
Return
String a string representation of the object.