36 | * For devices with displays with a width of 720dp or greater, the sample log is always visible, 37 | * on other devices it's visibility is controlled by an item on the Action Bar. 38 | */ 39 | public class MainActivity extends SampleActivityBase { 40 | 41 | public static final String TAG = "MainActivity"; 42 | 43 | // Whether the Log Fragment is currently shown 44 | private boolean mLogShown; 45 | 46 | @Override 47 | protected void onCreate(Bundle savedInstanceState) { 48 | super.onCreate(savedInstanceState); 49 | setContentView(R.layout.activity_main); 50 | 51 | if (savedInstanceState == null) { 52 | FragmentTransaction transaction = getSupportFragmentManager().beginTransaction(); 53 | AdvancedImmersiveModeFragment fragment = new AdvancedImmersiveModeFragment(); 54 | transaction.replace(R.id.sample_content_fragment, fragment); 55 | transaction.commit(); 56 | } 57 | } 58 | 59 | @Override 60 | public boolean onCreateOptionsMenu(Menu menu) { 61 | getMenuInflater().inflate(R.menu.main, menu); 62 | return true; 63 | } 64 | 65 | @Override 66 | public boolean onPrepareOptionsMenu(Menu menu) { 67 | MenuItem logToggle = menu.findItem(R.id.menu_toggle_log); 68 | logToggle.setVisible(findViewById(R.id.sample_output) instanceof ViewAnimator); 69 | logToggle.setTitle(mLogShown ? R.string.sample_hide_log : R.string.sample_show_log); 70 | 71 | return super.onPrepareOptionsMenu(menu); 72 | } 73 | 74 | @Override 75 | public boolean onOptionsItemSelected(MenuItem item) { 76 | switch(item.getItemId()) { 77 | case R.id.menu_toggle_log: 78 | mLogShown = !mLogShown; 79 | ViewAnimator output = (ViewAnimator) findViewById(R.id.sample_output); 80 | if (mLogShown) { 81 | output.setDisplayedChild(1); 82 | } else { 83 | output.setDisplayedChild(0); 84 | } 85 | supportInvalidateOptionsMenu(); 86 | return true; 87 | } 88 | return super.onOptionsItemSelected(item); 89 | } 90 | 91 | /** Create a chain of targets that will receive log data */ 92 | @Override 93 | public void initializeLogging() { 94 | // Wraps Android's native log framework. 95 | LogWrapper logWrapper = new LogWrapper(); 96 | // Using Log, front-end to the logging chain, emulates android.util.log method signatures. 97 | Log.setLogNode(logWrapper); 98 | 99 | // Filter strips out everything except the message text. 100 | MessageOnlyLogFilter msgFilter = new MessageOnlyLogFilter(); 101 | logWrapper.setNext(msgFilter); 102 | 103 | // On screen logging via a fragment with a TextView. 104 | LogFragment logFragment = (LogFragment) getSupportFragmentManager() 105 | .findFragmentById(R.id.log_fragment); 106 | msgFilter.setNext(logFragment.getLogView()); 107 | 108 | Log.i(TAG, "Ready"); 109 | } 110 | } 111 | -------------------------------------------------------------------------------- /Application/src/main/java/com/example/android/common/logger/LogView.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (C) 2013 The Android Open Source Project 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | package com.example.android.common.logger; 17 | 18 | import android.app.Activity; 19 | import android.content.Context; 20 | import android.util.*; 21 | import android.widget.TextView; 22 | 23 | /** Simple TextView which is used to output log data received through the LogNode interface. 24 | */ 25 | public class LogView extends TextView implements LogNode { 26 | 27 | public LogView(Context context) { 28 | super(context); 29 | } 30 | 31 | public LogView(Context context, AttributeSet attrs) { 32 | super(context, attrs); 33 | } 34 | 35 | public LogView(Context context, AttributeSet attrs, int defStyle) { 36 | super(context, attrs, defStyle); 37 | } 38 | 39 | /** 40 | * Formats the log data and prints it out to the LogView. 41 | * @param priority Log level of the data being logged. Verbose, Error, etc. 42 | * @param tag Tag for for the log data. Can be used to organize log statements. 43 | * @param msg The actual message to be logged. The actual message to be logged. 44 | * @param tr If an exception was thrown, this can be sent along for the logging facilities 45 | * to extract and print useful information. 46 | */ 47 | @Override 48 | public void println(int priority, String tag, String msg, Throwable tr) { 49 | 50 | 51 | String priorityStr = null; 52 | 53 | // For the purposes of this View, we want to print the priority as readable text. 54 | switch(priority) { 55 | case android.util.Log.VERBOSE: 56 | priorityStr = "VERBOSE"; 57 | break; 58 | case android.util.Log.DEBUG: 59 | priorityStr = "DEBUG"; 60 | break; 61 | case android.util.Log.INFO: 62 | priorityStr = "INFO"; 63 | break; 64 | case android.util.Log.WARN: 65 | priorityStr = "WARN"; 66 | break; 67 | case android.util.Log.ERROR: 68 | priorityStr = "ERROR"; 69 | break; 70 | case android.util.Log.ASSERT: 71 | priorityStr = "ASSERT"; 72 | break; 73 | default: 74 | break; 75 | } 76 | 77 | // Handily, the Log class has a facility for converting a stack trace into a usable string. 78 | String exceptionStr = null; 79 | if (tr != null) { 80 | exceptionStr = android.util.Log.getStackTraceString(tr); 81 | } 82 | 83 | // Take the priority, tag, message, and exception, and concatenate as necessary 84 | // into one usable line of text. 85 | final StringBuilder outputBuilder = new StringBuilder(); 86 | 87 | String delimiter = "\t"; 88 | appendIfNotNull(outputBuilder, priorityStr, delimiter); 89 | appendIfNotNull(outputBuilder, tag, delimiter); 90 | appendIfNotNull(outputBuilder, msg, delimiter); 91 | appendIfNotNull(outputBuilder, exceptionStr, delimiter); 92 | 93 | // In case this was originally called from an AsyncTask or some other off-UI thread, 94 | // make sure the update occurs within the UI thread. 95 | ((Activity) getContext()).runOnUiThread( (new Thread(new Runnable() { 96 | @Override 97 | public void run() { 98 | // Display the text we just generated within the LogView. 99 | appendToLog(outputBuilder.toString()); 100 | } 101 | }))); 102 | 103 | if (mNext != null) { 104 | mNext.println(priority, tag, msg, tr); 105 | } 106 | } 107 | 108 | public LogNode getNext() { 109 | return mNext; 110 | } 111 | 112 | public void setNext(LogNode node) { 113 | mNext = node; 114 | } 115 | 116 | /** Takes a string and adds to it, with a separator, if the bit to be added isn't null. Since 117 | * the logger takes so many arguments that might be null, this method helps cut out some of the 118 | * agonizing tedium of writing the same 3 lines over and over. 119 | * @param source StringBuilder containing the text to append to. 120 | * @param addStr The String to append 121 | * @param delimiter The String to separate the source and appended strings. A tab or comma, 122 | * for instance. 123 | * @return The fully concatenated String as a StringBuilder 124 | */ 125 | private StringBuilder appendIfNotNull(StringBuilder source, String addStr, String delimiter) { 126 | if (addStr != null) { 127 | if (addStr.length() == 0) { 128 | delimiter = ""; 129 | } 130 | 131 | return source.append(addStr).append(delimiter); 132 | } 133 | return source; 134 | } 135 | 136 | // The next LogNode in the chain. 137 | LogNode mNext; 138 | 139 | /** Outputs the string as a new line of log data in the LogView. */ 140 | public void appendToLog(String s) { 141 | append("\n" + s); 142 | } 143 | 144 | 145 | } 146 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | ############################################################################## 4 | ## 5 | ## Gradle start up script for UN*X 6 | ## 7 | ############################################################################## 8 | 9 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 10 | DEFAULT_JVM_OPTS="" 11 | 12 | APP_NAME="Gradle" 13 | APP_BASE_NAME=`basename "$0"` 14 | 15 | # Use the maximum available, or set MAX_FD != -1 to use that value. 16 | MAX_FD="maximum" 17 | 18 | warn ( ) { 19 | echo "$*" 20 | } 21 | 22 | die ( ) { 23 | echo 24 | echo "$*" 25 | echo 26 | exit 1 27 | } 28 | 29 | # OS specific support (must be 'true' or 'false'). 30 | cygwin=false 31 | msys=false 32 | darwin=false 33 | case "`uname`" in 34 | CYGWIN* ) 35 | cygwin=true 36 | ;; 37 | Darwin* ) 38 | darwin=true 39 | ;; 40 | MINGW* ) 41 | msys=true 42 | ;; 43 | esac 44 | 45 | # For Cygwin, ensure paths are in UNIX format before anything is touched. 46 | if $cygwin ; then 47 | [ -n "$JAVA_HOME" ] && JAVA_HOME=`cygpath --unix "$JAVA_HOME"` 48 | fi 49 | 50 | # Attempt to set APP_HOME 51 | # Resolve links: $0 may be a link 52 | PRG="$0" 53 | # Need this for relative symlinks. 54 | while [ -h "$PRG" ] ; do 55 | ls=`ls -ld "$PRG"` 56 | link=`expr "$ls" : '.*-> \(.*\)$'` 57 | if expr "$link" : '/.*' > /dev/null; then 58 | PRG="$link" 59 | else 60 | PRG=`dirname "$PRG"`"/$link" 61 | fi 62 | done 63 | SAVED="`pwd`" 64 | cd "`dirname \"$PRG\"`/" >&- 65 | APP_HOME="`pwd -P`" 66 | cd "$SAVED" >&- 67 | 68 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 69 | 70 | # Determine the Java command to use to start the JVM. 71 | if [ -n "$JAVA_HOME" ] ; then 72 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 73 | # IBM's JDK on AIX uses strange locations for the executables 74 | JAVACMD="$JAVA_HOME/jre/sh/java" 75 | else 76 | JAVACMD="$JAVA_HOME/bin/java" 77 | fi 78 | if [ ! -x "$JAVACMD" ] ; then 79 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 80 | 81 | Please set the JAVA_HOME variable in your environment to match the 82 | location of your Java installation." 83 | fi 84 | else 85 | JAVACMD="java" 86 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 87 | 88 | Please set the JAVA_HOME variable in your environment to match the 89 | location of your Java installation." 90 | fi 91 | 92 | # Increase the maximum file descriptors if we can. 93 | if [ "$cygwin" = "false" -a "$darwin" = "false" ] ; then 94 | MAX_FD_LIMIT=`ulimit -H -n` 95 | if [ $? -eq 0 ] ; then 96 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then 97 | MAX_FD="$MAX_FD_LIMIT" 98 | fi 99 | ulimit -n $MAX_FD 100 | if [ $? -ne 0 ] ; then 101 | warn "Could not set maximum file descriptor limit: $MAX_FD" 102 | fi 103 | else 104 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" 105 | fi 106 | fi 107 | 108 | # For Darwin, add options to specify how the application appears in the dock 109 | if $darwin; then 110 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" 111 | fi 112 | 113 | # For Cygwin, switch paths to Windows format before running java 114 | if $cygwin ; then 115 | APP_HOME=`cygpath --path --mixed "$APP_HOME"` 116 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` 117 | 118 | # We build the pattern for arguments to be converted via cygpath 119 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` 120 | SEP="" 121 | for dir in $ROOTDIRSRAW ; do 122 | ROOTDIRS="$ROOTDIRS$SEP$dir" 123 | SEP="|" 124 | done 125 | OURCYGPATTERN="(^($ROOTDIRS))" 126 | # Add a user-defined pattern to the cygpath arguments 127 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then 128 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" 129 | fi 130 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 131 | i=0 132 | for arg in "$@" ; do 133 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` 134 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option 135 | 136 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition 137 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` 138 | else 139 | eval `echo args$i`="\"$arg\"" 140 | fi 141 | i=$((i+1)) 142 | done 143 | case $i in 144 | (0) set -- ;; 145 | (1) set -- "$args0" ;; 146 | (2) set -- "$args0" "$args1" ;; 147 | (3) set -- "$args0" "$args1" "$args2" ;; 148 | (4) set -- "$args0" "$args1" "$args2" "$args3" ;; 149 | (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; 150 | (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; 151 | (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; 152 | (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; 153 | (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; 154 | esac 155 | fi 156 | 157 | # Split up the JVM_OPTS And GRADLE_OPTS values into an array, following the shell quoting and substitution rules 158 | function splitJvmOpts() { 159 | JVM_OPTS=("$@") 160 | } 161 | eval splitJvmOpts $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS 162 | JVM_OPTS[${#JVM_OPTS[*]}]="-Dorg.gradle.appname=$APP_BASE_NAME" 163 | 164 | exec "$JAVACMD" "${JVM_OPTS[@]}" -classpath "$CLASSPATH" org.gradle.wrapper.GradleWrapperMain "$@" 165 | -------------------------------------------------------------------------------- /Application/src/main/java/com/example/android/common/logger/Log.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (C) 2013 The Android Open Source Project 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | package com.example.android.common.logger; 17 | 18 | /** 19 | * Helper class for a list (or tree) of LoggerNodes. 20 | * 21 | *
When this is set as the head of the list, 22 | * an instance of it can function as a drop-in replacement for {@link android.util.Log}. 23 | * Most of the methods in this class server only to map a method call in Log to its equivalent 24 | * in LogNode.
25 | */ 26 | public class Log { 27 | // Grabbing the native values from Android's native logging facilities, 28 | // to make for easy migration and interop. 29 | public static final int NONE = -1; 30 | public static final int VERBOSE = android.util.Log.VERBOSE; 31 | public static final int DEBUG = android.util.Log.DEBUG; 32 | public static final int INFO = android.util.Log.INFO; 33 | public static final int WARN = android.util.Log.WARN; 34 | public static final int ERROR = android.util.Log.ERROR; 35 | public static final int ASSERT = android.util.Log.ASSERT; 36 | 37 | // Stores the beginning of the LogNode topology. 38 | private static LogNode mLogNode; 39 | 40 | /** 41 | * Returns the next LogNode in the linked list. 42 | */ 43 | public static LogNode getLogNode() { 44 | return mLogNode; 45 | } 46 | 47 | /** 48 | * Sets the LogNode data will be sent to. 49 | */ 50 | public static void setLogNode(LogNode node) { 51 | mLogNode = node; 52 | } 53 | 54 | /** 55 | * Instructs the LogNode to print the log data provided. Other LogNodes can 56 | * be chained to the end of the LogNode as desired. 57 | * 58 | * @param priority Log level of the data being logged. Verbose, Error, etc. 59 | * @param tag Tag for for the log data. Can be used to organize log statements. 60 | * @param msg The actual message to be logged. 61 | * @param tr If an exception was thrown, this can be sent along for the logging facilities 62 | * to extract and print useful information. 63 | */ 64 | public static void println(int priority, String tag, String msg, Throwable tr) { 65 | if (mLogNode != null) { 66 | mLogNode.println(priority, tag, msg, tr); 67 | } 68 | } 69 | 70 | /** 71 | * Instructs the LogNode to print the log data provided. Other LogNodes can 72 | * be chained to the end of the LogNode as desired. 73 | * 74 | * @param priority Log level of the data being logged. Verbose, Error, etc. 75 | * @param tag Tag for for the log data. Can be used to organize log statements. 76 | * @param msg The actual message to be logged. The actual message to be logged. 77 | */ 78 | public static void println(int priority, String tag, String msg) { 79 | println(priority, tag, msg, null); 80 | } 81 | 82 | /** 83 | * Prints a message at VERBOSE priority. 84 | * 85 | * @param tag Tag for for the log data. Can be used to organize log statements. 86 | * @param msg The actual message to be logged. 87 | * @param tr If an exception was thrown, this can be sent along for the logging facilities 88 | * to extract and print useful information. 89 | */ 90 | public static void v(String tag, String msg, Throwable tr) { 91 | println(VERBOSE, tag, msg, tr); 92 | } 93 | 94 | /** 95 | * Prints a message at VERBOSE priority. 96 | * 97 | * @param tag Tag for for the log data. Can be used to organize log statements. 98 | * @param msg The actual message to be logged. 99 | */ 100 | public static void v(String tag, String msg) { 101 | v(tag, msg, null); 102 | } 103 | 104 | 105 | /** 106 | * Prints a message at DEBUG priority. 107 | * 108 | * @param tag Tag for for the log data. Can be used to organize log statements. 109 | * @param msg The actual message to be logged. 110 | * @param tr If an exception was thrown, this can be sent along for the logging facilities 111 | * to extract and print useful information. 112 | */ 113 | public static void d(String tag, String msg, Throwable tr) { 114 | println(DEBUG, tag, msg, tr); 115 | } 116 | 117 | /** 118 | * Prints a message at DEBUG priority. 119 | * 120 | * @param tag Tag for for the log data. Can be used to organize log statements. 121 | * @param msg The actual message to be logged. 122 | */ 123 | public static void d(String tag, String msg) { 124 | d(tag, msg, null); 125 | } 126 | 127 | /** 128 | * Prints a message at INFO priority. 129 | * 130 | * @param tag Tag for for the log data. Can be used to organize log statements. 131 | * @param msg The actual message to be logged. 132 | * @param tr If an exception was thrown, this can be sent along for the logging facilities 133 | * to extract and print useful information. 134 | */ 135 | public static void i(String tag, String msg, Throwable tr) { 136 | println(INFO, tag, msg, tr); 137 | } 138 | 139 | /** 140 | * Prints a message at INFO priority. 141 | * 142 | * @param tag Tag for for the log data. Can be used to organize log statements. 143 | * @param msg The actual message to be logged. 144 | */ 145 | public static void i(String tag, String msg) { 146 | i(tag, msg, null); 147 | } 148 | 149 | /** 150 | * Prints a message at WARN priority. 151 | * 152 | * @param tag Tag for for the log data. Can be used to organize log statements. 153 | * @param msg The actual message to be logged. 154 | * @param tr If an exception was thrown, this can be sent along for the logging facilities 155 | * to extract and print useful information. 156 | */ 157 | public static void w(String tag, String msg, Throwable tr) { 158 | println(WARN, tag, msg, tr); 159 | } 160 | 161 | /** 162 | * Prints a message at WARN priority. 163 | * 164 | * @param tag Tag for for the log data. Can be used to organize log statements. 165 | * @param msg The actual message to be logged. 166 | */ 167 | public static void w(String tag, String msg) { 168 | w(tag, msg, null); 169 | } 170 | 171 | /** 172 | * Prints a message at WARN priority. 173 | * 174 | * @param tag Tag for for the log data. Can be used to organize log statements. 175 | * @param tr If an exception was thrown, this can be sent along for the logging facilities 176 | * to extract and print useful information. 177 | */ 178 | public static void w(String tag, Throwable tr) { 179 | w(tag, null, tr); 180 | } 181 | 182 | /** 183 | * Prints a message at ERROR priority. 184 | * 185 | * @param tag Tag for for the log data. Can be used to organize log statements. 186 | * @param msg The actual message to be logged. 187 | * @param tr If an exception was thrown, this can be sent along for the logging facilities 188 | * to extract and print useful information. 189 | */ 190 | public static void e(String tag, String msg, Throwable tr) { 191 | println(ERROR, tag, msg, tr); 192 | } 193 | 194 | /** 195 | * Prints a message at ERROR priority. 196 | * 197 | * @param tag Tag for for the log data. Can be used to organize log statements. 198 | * @param msg The actual message to be logged. 199 | */ 200 | public static void e(String tag, String msg) { 201 | e(tag, msg, null); 202 | } 203 | 204 | /** 205 | * Prints a message at ASSERT priority. 206 | * 207 | * @param tag Tag for for the log data. Can be used to organize log statements. 208 | * @param msg The actual message to be logged. 209 | * @param tr If an exception was thrown, this can be sent along for the logging facilities 210 | * to extract and print useful information. 211 | */ 212 | public static void wtf(String tag, String msg, Throwable tr) { 213 | println(ASSERT, tag, msg, tr); 214 | } 215 | 216 | /** 217 | * Prints a message at ASSERT priority. 218 | * 219 | * @param tag Tag for for the log data. Can be used to organize log statements. 220 | * @param msg The actual message to be logged. 221 | */ 222 | public static void wtf(String tag, String msg) { 223 | wtf(tag, msg, null); 224 | } 225 | 226 | /** 227 | * Prints a message at ASSERT priority. 228 | * 229 | * @param tag Tag for for the log data. Can be used to organize log statements. 230 | * @param tr If an exception was thrown, this can be sent along for the logging facilities 231 | * to extract and print useful information. 232 | */ 233 | public static void wtf(String tag, Throwable tr) { 234 | wtf(tag, null, tr); 235 | } 236 | } 237 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | -------------- 3 | 4 | Version 2.0, January 2004 5 | http://www.apache.org/licenses/ 6 | 7 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 8 | 9 | 1. Definitions. 10 | 11 | "License" shall mean the terms and conditions for use, reproduction, 12 | and distribution as defined by Sections 1 through 9 of this document. 13 | 14 | "Licensor" shall mean the copyright owner or entity authorized by 15 | the copyright owner that is granting the License. 16 | 17 | "Legal Entity" shall mean the union of the acting entity and all 18 | other entities that control, are controlled by, or are under common 19 | control with that entity. For the purposes of this definition, 20 | "control" means (i) the power, direct or indirect, to cause the 21 | direction or management of such entity, whether by contract or 22 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 23 | outstanding shares, or (iii) beneficial ownership of such entity. 24 | 25 | "You" (or "Your") shall mean an individual or Legal Entity 26 | exercising permissions granted by this License. 27 | 28 | "Source" form shall mean the preferred form for making modifications, 29 | including but not limited to software source code, documentation 30 | source, and configuration files. 31 | 32 | "Object" form shall mean any form resulting from mechanical 33 | transformation or translation of a Source form, including but 34 | not limited to compiled object code, generated documentation, 35 | and conversions to other media types. 36 | 37 | "Work" shall mean the work of authorship, whether in Source or 38 | Object form, made available under the License, as indicated by a 39 | copyright notice that is included in or attached to the work 40 | (an example is provided in the Appendix below). 41 | 42 | "Derivative Works" shall mean any work, whether in Source or Object 43 | form, that is based on (or derived from) the Work and for which the 44 | editorial revisions, annotations, elaborations, or other modifications 45 | represent, as a whole, an original work of authorship. For the purposes 46 | of this License, Derivative Works shall not include works that remain 47 | separable from, or merely link (or bind by name) to the interfaces of, 48 | the Work and Derivative Works thereof. 49 | 50 | "Contribution" shall mean any work of authorship, including 51 | the original version of the Work and any modifications or additions 52 | to that Work or Derivative Works thereof, that is intentionally 53 | submitted to Licensor for inclusion in the Work by the copyright owner 54 | or by an individual or Legal Entity authorized to submit on behalf of 55 | the copyright owner. For the purposes of this definition, "submitted" 56 | means any form of electronic, verbal, or written communication sent 57 | to the Licensor or its representatives, including but not limited to 58 | communication on electronic mailing lists, source code control systems, 59 | and issue tracking systems that are managed by, or on behalf of, the 60 | Licensor for the purpose of discussing and improving the Work, but 61 | excluding communication that is conspicuously marked or otherwise 62 | designated in writing by the copyright owner as "Not a Contribution." 63 | 64 | "Contributor" shall mean Licensor and any individual or Legal Entity 65 | on behalf of whom a Contribution has been received by Licensor and 66 | subsequently incorporated within the Work. 67 | 68 | 2. Grant of Copyright License. Subject to the terms and conditions of 69 | this License, each Contributor hereby grants to You a perpetual, 70 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 71 | copyright license to reproduce, prepare Derivative Works of, 72 | publicly display, publicly perform, sublicense, and distribute the 73 | Work and such Derivative Works in Source or Object form. 74 | 75 | 3. Grant of Patent License. Subject to the terms and conditions of 76 | this License, each Contributor hereby grants to You a perpetual, 77 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 78 | (except as stated in this section) patent license to make, have made, 79 | use, offer to sell, sell, import, and otherwise transfer the Work, 80 | where such license applies only to those patent claims licensable 81 | by such Contributor that are necessarily infringed by their 82 | Contribution(s) alone or by combination of their Contribution(s) 83 | with the Work to which such Contribution(s) was submitted. If You 84 | institute patent litigation against any entity (including a 85 | cross-claim or counterclaim in a lawsuit) alleging that the Work 86 | or a Contribution incorporated within the Work constitutes direct 87 | or contributory patent infringement, then any patent licenses 88 | granted to You under this License for that Work shall terminate 89 | as of the date such litigation is filed. 90 | 91 | 4. Redistribution. You may reproduce and distribute copies of the 92 | Work or Derivative Works thereof in any medium, with or without 93 | modifications, and in Source or Object form, provided that You 94 | meet the following conditions: 95 | 96 | (a) You must give any other recipients of the Work or 97 | Derivative Works a copy of this License; and 98 | 99 | (b) You must cause any modified files to carry prominent notices 100 | stating that You changed the files; and 101 | 102 | (c) You must retain, in the Source form of any Derivative Works 103 | that You distribute, all copyright, patent, trademark, and 104 | attribution notices from the Source form of the Work, 105 | excluding those notices that do not pertain to any part of 106 | the Derivative Works; and 107 | 108 | (d) If the Work includes a "NOTICE" text file as part of its 109 | distribution, then any Derivative Works that You distribute must 110 | include a readable copy of the attribution notices contained 111 | within such NOTICE file, excluding those notices that do not 112 | pertain to any part of the Derivative Works, in at least one 113 | of the following places: within a NOTICE text file distributed 114 | as part of the Derivative Works; within the Source form or 115 | documentation, if provided along with the Derivative Works; or, 116 | within a display generated by the Derivative Works, if and 117 | wherever such third-party notices normally appear. The contents 118 | of the NOTICE file are for informational purposes only and 119 | do not modify the License. You may add Your own attribution 120 | notices within Derivative Works that You distribute, alongside 121 | or as an addendum to the NOTICE text from the Work, provided 122 | that such additional attribution notices cannot be construed 123 | as modifying the License. 124 | 125 | You may add Your own copyright statement to Your modifications and 126 | may provide additional or different license terms and conditions 127 | for use, reproduction, or distribution of Your modifications, or 128 | for any such Derivative Works as a whole, provided Your use, 129 | reproduction, and distribution of the Work otherwise complies with 130 | the conditions stated in this License. 131 | 132 | 5. Submission of Contributions. Unless You explicitly state otherwise, 133 | any Contribution intentionally submitted for inclusion in the Work 134 | by You to the Licensor shall be under the terms and conditions of 135 | this License, without any additional terms or conditions. 136 | Notwithstanding the above, nothing herein shall supersede or modify 137 | the terms of any separate license agreement you may have executed 138 | with Licensor regarding such Contributions. 139 | 140 | 6. Trademarks. This License does not grant permission to use the trade 141 | names, trademarks, service marks, or product names of the Licensor, 142 | except as required for reasonable and customary use in describing the 143 | origin of the Work and reproducing the content of the NOTICE file. 144 | 145 | 7. Disclaimer of Warranty. Unless required by applicable law or 146 | agreed to in writing, Licensor provides the Work (and each 147 | Contributor provides its Contributions) on an "AS IS" BASIS, 148 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 149 | implied, including, without limitation, any warranties or conditions 150 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 151 | PARTICULAR PURPOSE. You are solely responsible for determining the 152 | appropriateness of using or redistributing the Work and assume any 153 | risks associated with Your exercise of permissions under this License. 154 | 155 | 8. Limitation of Liability. In no event and under no legal theory, 156 | whether in tort (including negligence), contract, or otherwise, 157 | unless required by applicable law (such as deliberate and grossly 158 | negligent acts) or agreed to in writing, shall any Contributor be 159 | liable to You for damages, including any direct, indirect, special, 160 | incidental, or consequential damages of any character arising as a 161 | result of this License or out of the use or inability to use the 162 | Work (including but not limited to damages for loss of goodwill, 163 | work stoppage, computer failure or malfunction, or any and all 164 | other commercial damages or losses), even if such Contributor 165 | has been advised of the possibility of such damages. 166 | 167 | 9. Accepting Warranty or Additional Liability. While redistributing 168 | the Work or Derivative Works thereof, You may choose to offer, 169 | and charge a fee for, acceptance of support, warranty, indemnity, 170 | or other liability obligations and/or rights consistent with this 171 | License. However, in accepting such obligations, You may act only 172 | on Your own behalf and on Your sole responsibility, not on behalf 173 | of any other Contributor, and only if You agree to indemnify, 174 | defend, and hold each Contributor harmless for any liability 175 | incurred by, or claims asserted against, such Contributor by reason 176 | of your accepting any such warranty or additional liability. 177 | 178 | END OF TERMS AND CONDITIONS 179 | 180 | APPENDIX: How to apply the Apache License to your work. 181 | 182 | To apply the Apache License to your work, attach the following 183 | boilerplate notice, with the fields enclosed by brackets "{}" 184 | replaced with your own identifying information. (Don't include 185 | the brackets!) The text should be enclosed in the appropriate 186 | comment syntax for the file format. We also recommend that a 187 | file or class name and description of purpose be included on the 188 | same "printed page" as the copyright notice for easier 189 | identification within third-party archives. 190 | 191 | Copyright {yyyy} {name of copyright owner} 192 | 193 | Licensed under the Apache License, Version 2.0 (the "License"); 194 | you may not use this file except in compliance with the License. 195 | You may obtain a copy of the License at 196 | 197 | http://www.apache.org/licenses/LICENSE-2.0 198 | 199 | Unless required by applicable law or agreed to in writing, software 200 | distributed under the License is distributed on an "AS IS" BASIS, 201 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 202 | See the License for the specific language governing permissions and 203 | limitations under the License. 204 | -------------------------------------------------------------------------------- /Application/src/main/java/com/example/android/advancedimmersivemode/AdvancedImmersiveModeFragment.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (C) 2012 The Android Open Source Project 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | package com.example.android.advancedimmersivemode; 17 | 18 | import android.os.Bundle; 19 | import android.support.v4.app.Fragment; 20 | import android.view.LayoutInflater; 21 | import android.view.View; 22 | import android.view.ViewGroup; 23 | import android.widget.Button; 24 | import android.widget.CheckBox; 25 | 26 | import com.example.android.common.logger.Log; 27 | 28 | /** 29 | * Demonstrates how to update the app's UI by toggling immersive mode. 30 | * Checkboxes are also made available for toggling other UI flags which can 31 | * alter the behavior of immersive mode. 32 | */ 33 | public class AdvancedImmersiveModeFragment extends Fragment { 34 | 35 | public static final String TAG = "AdvancedImmersiveModeFragment"; 36 | public CheckBox mHideNavCheckbox; 37 | public CheckBox mHideStatusBarCheckBox; 38 | public CheckBox mImmersiveModeCheckBox; 39 | public CheckBox mImmersiveModeStickyCheckBox; 40 | public CheckBox mLowProfileCheckBox; 41 | 42 | 43 | @Override 44 | public void onCreate(Bundle savedInstanceState) { 45 | super.onCreate(savedInstanceState); 46 | setHasOptionsMenu(true); 47 | } 48 | 49 | @Override 50 | public View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle state) { 51 | final View flagsView = inflater.inflate(R.layout.fragment_flags, container, false); 52 | mLowProfileCheckBox = (CheckBox) flagsView.findViewById(R.id.flag_enable_lowprof); 53 | mHideNavCheckbox = (CheckBox) flagsView.findViewById(R.id.flag_hide_navbar); 54 | mHideStatusBarCheckBox = (CheckBox) flagsView.findViewById(R.id.flag_hide_statbar); 55 | mImmersiveModeCheckBox = (CheckBox) flagsView.findViewById(R.id.flag_enable_immersive); 56 | mImmersiveModeStickyCheckBox = 57 | (CheckBox) flagsView.findViewById(R.id.flag_enable_immersive_sticky); 58 | 59 | Button toggleFlagsButton = (Button) flagsView.findViewById(R.id.btn_changeFlags); 60 | toggleFlagsButton.setOnClickListener(new View.OnClickListener() { 61 | @Override 62 | public void onClick(View view) { 63 | toggleUiFlags(); 64 | } 65 | }); 66 | 67 | Button presetsImmersiveModeButton = (Button) flagsView.findViewById(R.id.btn_immersive); 68 | presetsImmersiveModeButton.setOnClickListener(new View.OnClickListener() { 69 | @Override 70 | public void onClick(View view) { 71 | 72 | // BEGIN_INCLUDE(immersive_presets) 73 | // For immersive mode, the FULLSCREEN, HIDE_HAVIGATION and IMMERSIVE 74 | // flags should be set (you can use IMMERSIVE_STICKY instead of IMMERSIVE 75 | // as appropriate for your app). The LOW_PROFILE flag should be cleared. 76 | 77 | // Immersive mode is primarily for situations where the user will be 78 | // interacting with the screen, like games or reading books. 79 | int uiOptions = flagsView.getSystemUiVisibility(); 80 | uiOptions &= ~View.SYSTEM_UI_FLAG_LOW_PROFILE; 81 | uiOptions |= View.SYSTEM_UI_FLAG_FULLSCREEN; 82 | uiOptions |= View.SYSTEM_UI_FLAG_HIDE_NAVIGATION; 83 | uiOptions |= View.SYSTEM_UI_FLAG_IMMERSIVE; 84 | uiOptions &= ~View.SYSTEM_UI_FLAG_IMMERSIVE_STICKY; 85 | flagsView.setSystemUiVisibility(uiOptions); 86 | // END_INCLUDE(immersive_presets) 87 | 88 | dumpFlagStateToLog(uiOptions); 89 | 90 | // The below code just updates the checkboxes to reflect which flags have been set. 91 | mLowProfileCheckBox.setChecked(false); 92 | mHideNavCheckbox.setChecked(true); 93 | mHideStatusBarCheckBox.setChecked(true); 94 | mImmersiveModeCheckBox.setChecked(true); 95 | mImmersiveModeStickyCheckBox.setChecked(false); 96 | } 97 | }); 98 | 99 | 100 | Button presetsLeanbackModeButton = (Button) flagsView.findViewById(R.id.btn_leanback); 101 | presetsLeanbackModeButton.setOnClickListener(new View.OnClickListener() { 102 | @Override 103 | public void onClick(View view) { 104 | // BEGIN_INCLUDE(leanback_presets) 105 | // For leanback mode, only the HIDE_NAVE and HIDE_STATUSBAR flags 106 | // should be checked. In this case IMMERSIVE should *not* be set, 107 | // since this mode is left as soon as the user touches the screen. 108 | int uiOptions = flagsView.getSystemUiVisibility(); 109 | uiOptions &= ~View.SYSTEM_UI_FLAG_LOW_PROFILE; 110 | uiOptions |= View.SYSTEM_UI_FLAG_FULLSCREEN; 111 | uiOptions |= View.SYSTEM_UI_FLAG_HIDE_NAVIGATION; 112 | uiOptions &= ~View.SYSTEM_UI_FLAG_IMMERSIVE; 113 | uiOptions &= ~View.SYSTEM_UI_FLAG_IMMERSIVE_STICKY; 114 | flagsView.setSystemUiVisibility(uiOptions); 115 | // END_INCLUDE(leanback_presets) 116 | 117 | dumpFlagStateToLog(uiOptions); 118 | 119 | // The below code just updates the checkboxes to reflect which flags have been set. 120 | mLowProfileCheckBox.setChecked(false); 121 | mHideNavCheckbox.setChecked(true); 122 | mHideStatusBarCheckBox.setChecked(true); 123 | mImmersiveModeCheckBox.setChecked(false); 124 | mImmersiveModeStickyCheckBox.setChecked(false); 125 | } 126 | }); 127 | 128 | // Setting these flags makes the content appear under the navigation 129 | // bars, so that showing/hiding the nav bars doesn't resize the content 130 | // window, which can be jarring. 131 | int uiOptions = flagsView.getSystemUiVisibility(); 132 | uiOptions |= View.SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION; 133 | uiOptions |= View.SYSTEM_UI_FLAG_LAYOUT_STABLE; 134 | uiOptions |= View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN; 135 | flagsView.setSystemUiVisibility(uiOptions); 136 | 137 | return flagsView; 138 | } 139 | 140 | /** 141 | * Helper method to dump flag state to the log. 142 | * @param uiFlags Set of UI flags to inspect 143 | */ 144 | public void dumpFlagStateToLog(int uiFlags) { 145 | if ((uiFlags & View.SYSTEM_UI_FLAG_LOW_PROFILE) != 0) { 146 | Log.i(TAG, "SYSTEM_UI_FLAG_LOW_PROFILE is set"); 147 | } else { 148 | Log.i(TAG, "SYSTEM_UI_FLAG_LOW_PROFILE is unset"); 149 | } 150 | 151 | if ((uiFlags & View.SYSTEM_UI_FLAG_FULLSCREEN) != 0) { 152 | Log.i(TAG, "SYSTEM_UI_FLAG_FULLSCREEN is set"); 153 | } else { 154 | Log.i(TAG, "SYSTEM_UI_FLAG_FULLSCREEN is unset"); 155 | } 156 | 157 | if ((uiFlags & View.SYSTEM_UI_FLAG_HIDE_NAVIGATION) != 0) { 158 | Log.i(TAG, "SYSTEM_UI_FLAG_HIDE_NAVIGATION is set"); 159 | } else { 160 | Log.i(TAG, "SYSTEM_UI_FLAG_HIDE_NAVIGATION is unset"); 161 | } 162 | 163 | if ((uiFlags & View.SYSTEM_UI_FLAG_IMMERSIVE) != 0) { 164 | Log.i(TAG, "SYSTEM_UI_FLAG_IMMERSIVE is set"); 165 | } else { 166 | Log.i(TAG, "SYSTEM_UI_FLAG_IMMERSIVE is unset"); 167 | } 168 | 169 | if ((uiFlags & View.SYSTEM_UI_FLAG_IMMERSIVE_STICKY) != 0) { 170 | Log.i(TAG, "SYSTEM_UI_FLAG_IMMERSIVE_STICKY is set"); 171 | } else { 172 | Log.i(TAG, "SYSTEM_UI_FLAG_IMMERSIVE_STICKY is unset"); 173 | } 174 | } 175 | 176 | /** 177 | * Detects and toggles immersive mode (also known as "hidey bar" mode). 178 | */ 179 | public void toggleUiFlags() { 180 | 181 | // BEGIN_INCLUDE (get_current_ui_flags) 182 | // The "Decor View" is the parent view of the Activity. It's also conveniently the easiest 183 | // one to find from within a fragment, since there's a handy helper method to pull it, and 184 | // we don't have to bother with picking a view somewhere deeper in the hierarchy and calling 185 | // "findViewById" on it. 186 | View decorView = getActivity().getWindow().getDecorView(); 187 | int uiOptions = decorView.getSystemUiVisibility(); 188 | int newUiOptions = uiOptions; 189 | // END_INCLUDE (get_current_ui_flags) 190 | 191 | // BEGIN_INCLUDE (toggle_lowprofile_mode) 192 | // Low profile mode doesn't resize the screen at all, but it covers the nav & status bar 193 | // icons with black so they're less distracting. Unlike "full screen" and "hide nav bar," 194 | // this mode doesn't interact with immersive mode at all, but it's instructive when running 195 | // this sample to observe the differences in behavior. 196 | if (mLowProfileCheckBox.isChecked()) { 197 | newUiOptions |= View.SYSTEM_UI_FLAG_LOW_PROFILE; 198 | } else { 199 | newUiOptions &= ~View.SYSTEM_UI_FLAG_LOW_PROFILE; 200 | } 201 | // END_INCLUDE (toggle_lowprofile_mode) 202 | 203 | // BEGIN_INCLUDE (toggle_fullscreen_mode) 204 | // When enabled, this flag hides non-critical UI, such as the status bar, 205 | // which usually shows notification icons, battery life, etc 206 | // on phone-sized devices. The bar reappears when the user swipes it down. When immersive 207 | // mode is also enabled, the app-drawable area expands, and when the status bar is swiped 208 | // down, it appears semi-transparently and slides in over the app, instead of pushing it 209 | // down. 210 | if (mHideStatusBarCheckBox.isChecked()) { 211 | newUiOptions |= View.SYSTEM_UI_FLAG_FULLSCREEN; 212 | } else { 213 | newUiOptions &= ~View.SYSTEM_UI_FLAG_FULLSCREEN; 214 | } 215 | // END_INCLUDE (toggle_fullscreen_mode) 216 | 217 | // BEGIN_INCLUDE (toggle_hidenav_mode) 218 | // When enabled, this flag hides the black nav bar along the bottom, 219 | // where the home/back buttons are. The nav bar normally instantly reappears 220 | // when the user touches the screen. When immersive mode is also enabled, the nav bar 221 | // stays hidden until the user swipes it back. 222 | if (mHideNavCheckbox.isChecked()) { 223 | newUiOptions |= View.SYSTEM_UI_FLAG_HIDE_NAVIGATION; 224 | } else { 225 | newUiOptions &= ~View.SYSTEM_UI_FLAG_HIDE_NAVIGATION; 226 | } 227 | // END_INCLUDE (toggle_hidenav_mode) 228 | 229 | // BEGIN_INCLUDE (toggle_immersive_mode) 230 | // Immersive mode doesn't do anything without at least one of the previous flags 231 | // enabled. When enabled, it allows the user to swipe the status and/or nav bars 232 | // off-screen. When the user swipes the bars back onto the screen, the flags are cleared 233 | // and immersive mode is automatically disabled. 234 | if (mImmersiveModeCheckBox.isChecked()) { 235 | newUiOptions |= View.SYSTEM_UI_FLAG_IMMERSIVE; 236 | } else { 237 | newUiOptions &= ~View.SYSTEM_UI_FLAG_IMMERSIVE; 238 | } 239 | // END_INCLUDE (toggle_immersive_mode) 240 | 241 | // BEGIN_INCLUDE (toggle_immersive_mode_sticky) 242 | // There's actually two forms of immersive mode, normal and "sticky". Sticky immersive mode 243 | // is different in 2 key ways: 244 | // 245 | // * Uses semi-transparent bars for the nav and status bars 246 | // * This UI flag will *not* be cleared when the user interacts with the UI. 247 | // When the user swipes, the bars will temporarily appear for a few seconds and then 248 | // disappear again. 249 | if (mImmersiveModeStickyCheckBox.isChecked()) { 250 | newUiOptions |= View.SYSTEM_UI_FLAG_IMMERSIVE_STICKY; 251 | } else { 252 | newUiOptions &= ~View.SYSTEM_UI_FLAG_IMMERSIVE_STICKY; 253 | } 254 | // END_INCLUDE (toggle_immersive_mode_sticky) 255 | 256 | // BEGIN_INCLUDE (set_ui_flags) 257 | //Set the new UI flags. 258 | decorView.setSystemUiVisibility(newUiOptions); 259 | // END_INCLUDE (set_ui_flags) 260 | 261 | dumpFlagStateToLog(uiOptions); 262 | } 263 | } 264 | --------------------------------------------------------------------------------