Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 752d8029 authored by Katie McCormick's avatar Katie McCormick Committed by Android (Google) Code Review
Browse files

Merge "Doc update: minor changes to immersive lesson" into klp-docs

parents 330dfa7d 9dd04e72

docs/html/training/system-ui/immersive.jd

+6 −18
Original line number Original line Diff line number Diff line
@@ -11,8 +11,8 @@ trainingnavtop=true 
<h2>This lesson teaches you to</h2>

<h2>This lesson teaches you to</h2>

<ol>

<ol>

  <li><a href="#compare">Choose an Approach</a></li>

  <li><a href="#compare">Choose an Approach</a></li>

  <li><a href="#nonsticky">Use IMMERSIVE</a></li>

  <li><a href="#nonsticky">Use Non-Sticky Immersion</a></li>

  <li><a href="#sticky">Use IMMERSIVE_STICKY</a></li>

  <li><a href="#sticky">Use Sticky Immersion</a></li>

</ol>

</ol>
@@ -72,14 +72,6 @@ again after a few moments, you can instead use the 
shown in this mode are in a transient state.

shown in this mode are in a transient state.

</p>

</p>





 <p>When you use {@link android.view.View#SYSTEM_UI_FLAG_IMMERSIVE IMMERSIVE} or

 {@link android.view.View#SYSTEM_UI_FLAG_IMMERSIVE_STICKY IMMERSIVE_STICKY},

 the system UI stays hidden, even while users are interacting with your

app or game. You can capture touch events from anywhere across the screen, even areas that

would otherwise be occupied by the system bars. This gives you a great way to create a

larger, richer, more <a href="{@docRoot}design/patterns/fullscreen.html">

immersive</a> UI in your app or game and reduce visual distraction at the same time.</p>



<p>Figure 1 illustrates the different "immersive mode" states:</p>

<p>Figure 1 illustrates the different "immersive mode" states:</p>





 <img src="{@docRoot}images/training/imm-states.png"

 <img src="{@docRoot}images/training/imm-states.png"
@@ -137,12 +129,8 @@ if you use them in conjunction with {@link android.view.View#SYSTEM_UI_FLAG_HIDE 




 <p>The flags  {@link android.view.View#SYSTEM_UI_FLAG_IMMERSIVE} and

 <p>The flags  {@link android.view.View#SYSTEM_UI_FLAG_IMMERSIVE} and

 {@link android.view.View#SYSTEM_UI_FLAG_IMMERSIVE_STICKY} both provide an immersive

 {@link android.view.View#SYSTEM_UI_FLAG_IMMERSIVE_STICKY} both provide an immersive

 experience. But whereas the

 experience, but with the differences in behavior described above. Here are

 {@link android.view.View#SYSTEM_UI_FLAG_IMMERSIVE_STICKY IMMERSIVE_STICKY}

 examples of when you would use one flag vs. the other:</p>

 flag causes semi-transparent system bars to briefly show and then hide again in response to

 a swipe gesture, the same swipe gesture causes the system bars to reappear and remain

 visible if you instead use the {@link android.view.View#SYSTEM_UI_FLAG_IMMERSIVE IMMERSIVE}

 flag. Here are examples of when you would use one vs. the other:</p>





<ul>

<ul>

<li>If you're building a book reader, news reader, or a magazine, use

<li>If you're building a book reader, news reader, or a magazine, use
@@ -171,7 +159,7 @@ Android 4.0 (API Level 14). For this type of app, simply using 
sufficient. Don't use the "immersive" flags in this case.</li>

sufficient. Don't use the "immersive" flags in this case.</li>

</ul>

</ul>





<h2 id="nonsticky">Use IMMERSIVE</h2>

<h2 id="nonsticky">Use Non-Sticky Immersion</h2>





 <p>When you use the {@link android.view.View#SYSTEM_UI_FLAG_IMMERSIVE} flag, it hides

 <p>When you use the {@link android.view.View#SYSTEM_UI_FLAG_IMMERSIVE} flag, it hides

 the system bars based on what other UI flags you have set

 the system bars based on what other UI flags you have set
@@ -242,7 +230,7 @@ For more discussion of these topics, watch the video 
<a class ="external-link" href="http://www.youtube.com/embed/cBi8fjv90E4">DevBytes:

<a class ="external-link" href="http://www.youtube.com/embed/cBi8fjv90E4">DevBytes:

 Android 4.4 Immersive Mode</a>.</p>

 Android 4.4 Immersive Mode</a>.</p>





<h2 id="sticky">Use IMMERSIVE_STICKY</h2>

<h2 id="sticky">Use Sticky Immersion</h2>





<p>When you use the {@link android.view.View#SYSTEM_UI_FLAG_IMMERSIVE_STICKY} flag,

<p>When you use the {@link android.view.View#SYSTEM_UI_FLAG_IMMERSIVE_STICKY} flag,

an inward swipe in the system bars areas causes the bars to temporarily appear in a

an inward swipe in the system bars areas causes the bars to temporarily appear in a