blob: 87ec7b8be85938c6952643e1bedda12fa09ba5d2 [file] [log] [blame] [view]
Trevor Johnse904b622014-08-27 18:30:35 -07001Android BasicImmersiveMode Sample
Jan-Felix Schmakeit4f997182014-12-16 15:08:37 +11002===================================
Trevor Johnse904b622014-08-27 18:30:35 -07003
Jan-Felix Schmakeit4f997182014-12-16 15:08:37 +11004Sample demonstrating the use of immersive mode to hide the system and navigation bars for
5full screen applications.
6
7Introduction
8------------
9
10'Immersive Mode' is a new UI mode which improves 'hide full screen' and 'hide nav bar'
11modes, by letting users swipe the bars in and out.
12
13This sample demonstrates how to enable and disable immersive mode programmatically.
14
15Immersive mode was introduced in Android 4.4 (Api Level 19). It is toggled using the
16SYSTEM_UI_FLAG_IMMERSIVE system ui flag. When combined with the SYSTEM_UI_FLAG_HIDE_NAVIGATION and SYSTEM_UI_FLAG_FULLSCREEN flags, hides the navigation and status bars and lets your app capture all touch events on the screen.
Trevor Johnse904b622014-08-27 18:30:35 -070017
18Pre-requisites
19--------------
20
Jan-Felix Schmakeit4f997182014-12-16 15:08:37 +110021- Android SDK v21
22- Android Build Tools v21.1.1
Trevor Johnse904b622014-08-27 18:30:35 -070023- Android Support Repository
24
Jan-Felix Schmakeit4f997182014-12-16 15:08:37 +110025Screenshots
26-------------
27
28<img src="screenshots/1-activity.png" height="400" alt="Screenshot"/> <img src="screenshots/2-immersive.png" height="400" alt="Screenshot"/>
29
Trevor Johnse904b622014-08-27 18:30:35 -070030Getting Started
31---------------
32
33This sample uses the Gradle build system. To build this project, use the
34"gradlew build" command or use "Import Project" in Android Studio.
35
36Support
37-------
38
39- Google+ Community: https://plus.google.com/communities/105153134372062985968
40- Stack Overflow: http://stackoverflow.com/questions/tagged/android
41
42If you've found an error in this sample, please file an issue:
43https://github.com/googlesamples/android-BasicImmersiveMode
44
45Patches are encouraged, and may be submitted by forking this project and
46submitting a pull request through GitHub. Please see CONTRIBUTING.md for more details.
47
48License
49-------
50
51Copyright 2014 The Android Open Source Project, Inc.
52
53Licensed to the Apache Software Foundation (ASF) under one or more contributor
54license agreements. See the NOTICE file distributed with this work for
55additional information regarding copyright ownership. The ASF licenses this
56file to you under the Apache License, Version 2.0 (the "License"); you may not
57use this file except in compliance with the License. You may obtain a copy of
58the License at
59
Jan-Felix Schmakeit4f997182014-12-16 15:08:37 +110060http://www.apache.org/licenses/LICENSE-2.0
Trevor Johnse904b622014-08-27 18:30:35 -070061
62Unless required by applicable law or agreed to in writing, software
63distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
64WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
65License for the specific language governing permissions and limitations under
66the License.