DisplayCutout: Add clarifying images to LAYOUT_IN_DISPLAY_CUTOUT_MODE_SHORT_EDGES

Fixes: 76462084
Test: make doc-comment-check-docs, open $ANDROID_BUILD_TOP/out/target/common/docs/doc-comment-check/reference/android/view/WindowManager.LayoutParams.html, navigate to LAYOUT_IN_DISPLAY_CUTOUT_MODE_SHORT_EDGES
Change-Id: I8a9df979cbb062896fa874a163414a4f8a095b21
This commit is contained in:
Adrian Roos
2018-03-27 19:17:50 +02:00
parent c6d9f7ce1d
commit ad1da31764
15 changed files with 29 additions and 0 deletions

View File

@@ -2279,6 +2279,35 @@ public interface WindowManager extends ViewManager {
* The window must make sure that no important content overlaps with the
* {@link DisplayCutout}.
*
* <p>
* In this mode, the window extends under cutouts on the short edge of the display in both
* portrait and landscape, regardless of whether the window is hiding the system bars:<br/>
* <img src="{@docRoot}reference/android/images/display_cutout/short_edge/fullscreen_top_no_letterbox.png"
* height="720"
* alt="Screenshot of a fullscreen activity on a display with a cutout at the top edge in
* portrait, no letterbox is applied."/>
*
* <img src="{@docRoot}reference/android/images/display_cutout/short_edge/landscape_top_no_letterbox.png"
* width="720"
* alt="Screenshot of an activity on a display with a cutout at the top edge in landscape,
* no letterbox is applied."/>
*
* <p>
* A cutout in the corner is considered to be on the short edge: <br/>
* <img src="{@docRoot}reference/android/images/display_cutout/short_edge/fullscreen_corner_no_letterbox.png"
* height="720"
* alt="Screenshot of a fullscreen activity on a display with a cutout in the corner in
* portrait, no letterbox is applied."/>
*
* <p>
* On the other hand, should the cutout be on the long edge of the display, a letterbox will
* be applied such that the window does not extend into the cutout on either long edge:
* <br/>
* <img src="{@docRoot}reference/android/images/display_cutout/short_edge/portrait_side_letterbox.png"
* height="720"
* alt="Screenshot of an activity on a display with a cutout on the long edge in portrait,
* letterbox is applied."/>
*
* @see DisplayCutout
* @see WindowInsets#getDisplayCutout()
*/

Binary file not shown.

After

Width:  |  Height:  |  Size: 67 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 89 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 88 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 78 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 76 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 89 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 78 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 66 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 67 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 67 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 88 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 90 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 89 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 78 KiB