DisplayCutout

DisplayCutout

public DisplayCutout (Insets safeInsets, 
                Rect boundLeft, 
                Rect boundTop, 
                Rect boundRight, 
                Rect boundBottom)

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.

DisplayCutout

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

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.

DisplayCutout

public DisplayCutout (Rect safeInsets, 
                List<Rect> boundingRects)

This constructor is 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.

equals

public boolean equals (Object o)

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.

getBoundingRectBottom

public Rect getBoundingRectBottom ()

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

getBoundingRectLeft

public Rect getBoundingRectLeft ()

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

getBoundingRectRight

public Rect getBoundingRectRight ()

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

getBoundingRectTop

public Rect getBoundingRectTop ()

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

getBoundingRects

public List<Rect> getBoundingRects ()

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.

getCutoutPath

public Path getCutoutPath ()

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().

getSafeInsetBottom

public int getSafeInsetBottom ()

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

getSafeInsetLeft

public int getSafeInsetLeft ()

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

getSafeInsetRight

public int getSafeInsetRight ()

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

getSafeInsetTop

public int getSafeInsetTop ()

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

getWaterfallInsets

public Insets getWaterfallInsets ()

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.

hashCode

public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

toString

public String toString ()

Returns a string representation of the object.