1 /* 2 * Copyright (C) 2024 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 17 package com.android.settings; 18 19 import android.app.Activity; 20 import android.os.Bundle; 21 22 import androidx.annotation.NonNull; 23 import androidx.annotation.Nullable; 24 25 import com.android.settingslib.search.Indexable; 26 27 /** 28 * Base class for fragment suitable for unit testing. 29 */ 30 public abstract class SettingsPreferenceFragmentBase extends SettingsPreferenceFragment 31 implements Indexable { 32 @Override 33 @SuppressWarnings({"RequiresNullabilityAnnotation"}) onCreate(final Bundle icicle)34 public void onCreate(final Bundle icicle) { 35 super.onCreate(icicle); 36 onCreateCallback(icicle); 37 } 38 39 @Override 40 @SuppressWarnings({"RequiresNullabilityAnnotation"}) onActivityCreated(final Bundle savedInstanceState)41 public void onActivityCreated(final Bundle savedInstanceState) { 42 super.onActivityCreated(savedInstanceState); 43 onActivityCreatedCallback(savedInstanceState); 44 } 45 46 @Override onSaveInstanceState(@onNull final Bundle outState)47 public void onSaveInstanceState(@NonNull final Bundle outState) { 48 super.onSaveInstanceState(outState); 49 onSaveInstanceStateCallback(outState); 50 } 51 52 @Override onStart()53 public void onStart() { 54 super.onStart(); 55 onStartCallback(); 56 } 57 58 @Override onStop()59 public void onStop() { 60 super.onStop(); 61 onStopCallback(); 62 } 63 getCurrentActivity()64 protected Activity getCurrentActivity() { 65 return getActivity(); 66 } 67 68 /** 69 * Callback called from {@link #onCreate} 70 */ onCreateCallback(@ullable Bundle icicle)71 public abstract void onCreateCallback(@Nullable Bundle icicle); 72 73 /** 74 * Callback called from {@link #onActivityCreated} 75 */ onActivityCreatedCallback(@ullable Bundle savedInstanceState)76 public abstract void onActivityCreatedCallback(@Nullable Bundle savedInstanceState); 77 78 /** 79 * Callback called from {@link #onStart} 80 */ onStartCallback()81 public abstract void onStartCallback(); 82 83 /** 84 * Callback called from {@link #onStop} 85 */ onStopCallback()86 public abstract void onStopCallback(); 87 88 /** 89 * Callback called from {@link #onSaveInstanceState} 90 */ onSaveInstanceStateCallback(@onNull final Bundle outState)91 public void onSaveInstanceStateCallback(@NonNull final Bundle outState) { 92 // Do nothing. 93 } 94 } 95