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