How to detect user pressing Home Key in an Activity on Android?


This example demonstrates how do I detect user pressing home key in an activity on android.

Step 1 − Create a new project in Android Studio, go to File ⇒ New Project and fill all required details to create a new project.

Step 2 − Add the following code to res/layout/activity_main.xml.

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android = "http://schemas.android.com/apk/res/android"
   android:orientation = "vertical"
   android:layout_width = "match_parent"
   android:gravity = "center"
   android:layout_height = "match_parent">
   <TextView
      android:id = "@+id/textView"
      android:layout_width = "fill_parent"
      android:gravity = "center"
      android:textSize = "30sp"
      android:layout_height = "wrap_content"
      android:text = "Click here" />
</LinearLayout>

Step 3 − Add the following code to src/MainActivity.java

import android.support.v7.app.AppCompatActivity;
import android.os.Bundle;
import android.view.View;
import android.widget.TextView;
import android.widget.Toast;
public class MainActivity extends AppCompatActivity {
   TextView textView;
   @Override
   protected void onCreate(Bundle savedInstanceState) {
      super.onCreate(savedInstanceState);
      setContentView(R.layout.activity_main);
      textView = (TextView)findViewById(R.id.textView);
      textView.setOnClickListener(new View.OnClickListener() {
         @Override
         public void onClick(View v) {
            onUserLeaveHint();
         }
      });
   }
   @Override
   protected void onUserLeaveHint(){
      textView.setText("Home Button Pressed");
      Toast.makeText(MainActivity.this, "Home Button pressed", Toast.LENGTH_SHORT).show();
      super.onUserLeaveHint();
   }
}

Step 4 − Add the following code to androidManifest.xml

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android" package="app.com.sample">
   <application
      android:allowBackup="true"
      android:icon="@mipmap/ic_launcher"
      android:label="@string/app_name"
      android:roundIcon="@mipmap/ic_launcher_round"
      android:supportsRtl="true"
      android:theme="@style/AppTheme">
      <activity android:name=".MainActivity">
         <intent-filter>
            <action android:name="android.intent.action.MAIN" />
            <category android:name="android.intent.category.LAUNCHER" />
         </intent-filter>
      </activity>
   </application>
</manifest>

Let's try to run your application. I assume you have connected your actual Android Mobile device with your computer. To run the app from android studio, open one of your project's activity files and click Run  icon from the toolbar. Select your mobile device as an option and then check your mobile device which will display your default screen −

Click here to download the project code.

Updated on: 02-Aug-2019

311 Views

Kickstart Your Career

Get certified by completing the course

Get Started
Advertisements