blob: 431af60a08b55df214958ad27576bbc4aa384990 [file] [log] [blame] [view]
Trevor Johns89d2da02015-08-13 18:28:15 -07001
Trevor Johnse904b622014-08-27 18:30:35 -07002Android AdvancedImmersiveMode Sample
Trevor Johns89d2da02015-08-13 18:28:15 -07003===================================
Trevor Johnse904b622014-08-27 18:30:35 -07004
Trevor Johns89d2da02015-08-13 18:28:15 -07005Immersive Mode, added in Android 4.4, improves the "hide full screen" and
6"hide nav bar" modes by letting users swipe the bars in and out. This sample
Trevor Johnse904b622014-08-27 18:30:35 -07007lets the user experiment with immersive mode by seeing how it interacts
8with some of the other UI flags related to full-screen apps.
9
Trevor Johns89d2da02015-08-13 18:28:15 -070010Introduction
11------------
12
13Android 4.4 (API Level 19) introduces a new `SYSTEM_UI_FLAG_IMMERSIVE`
14flag for [setSystemUiVisibility()][1] that lets your app go truly "full
15screen." This flag, when combined with the `SYSTEM_UI_FLAG_HIDE_NAVIGATION` and
16`SYSTEM_UI_FLAG_FULLSCREEN` flags, hides the navigation and status bars
17and lets your app capture all touch events on the screen.
18
19When immersive full-screen mode is enabled, your activity continues
20to receive all touch events. The user can reveal the system bars with
21an inward swipe along the region where the system bars normally
22appear.
23
24[1]: http://developer.android.com/reference/android/view/View.html#setSystemUiVisibility(int)
25
Trevor Johnse904b622014-08-27 18:30:35 -070026Pre-requisites
27--------------
28
Yuichi Arakif302c132019-01-11 17:19:47 +090029- Android SDK 28
30- Android Build Tools v28.0.3
Trevor Johnse904b622014-08-27 18:30:35 -070031- Android Support Repository
32
Trevor Johns89d2da02015-08-13 18:28:15 -070033Screenshots
34-------------
35
36<img src="screenshots/immersion.png" height="400" alt="Screenshot"/> <img src="screenshots/leanback.png" height="400" alt="Screenshot"/>
37
Trevor Johnse904b622014-08-27 18:30:35 -070038Getting Started
39---------------
40
41This sample uses the Gradle build system. To build this project, use the
42"gradlew build" command or use "Import Project" in Android Studio.
43
44Support
45-------
46
47- Google+ Community: https://plus.google.com/communities/105153134372062985968
48- Stack Overflow: http://stackoverflow.com/questions/tagged/android
49
50If you've found an error in this sample, please file an issue:
51https://github.com/googlesamples/android-AdvancedImmersiveMode
52
53Patches are encouraged, and may be submitted by forking this project and
54submitting a pull request through GitHub. Please see CONTRIBUTING.md for more details.
55
56License
57-------
58
Yuichi Arakif302c132019-01-11 17:19:47 +090059Copyright 2019 The Android Open Source Project, Inc.
Trevor Johnse904b622014-08-27 18:30:35 -070060
61Licensed to the Apache Software Foundation (ASF) under one or more contributor
62license agreements. See the NOTICE file distributed with this work for
63additional information regarding copyright ownership. The ASF licenses this
64file to you under the Apache License, Version 2.0 (the "License"); you may not
65use this file except in compliance with the License. You may obtain a copy of
66the License at
67
Trevor Johns89d2da02015-08-13 18:28:15 -070068http://www.apache.org/licenses/LICENSE-2.0
Trevor Johnse904b622014-08-27 18:30:35 -070069
70Unless required by applicable law or agreed to in writing, software
71distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
72WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
73License for the specific language governing permissions and limitations under
74the License.