Home | History | Annotate | Download | only in lifecycle 
      1 /*
      2  * Copyright (C) 2016 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.android.settingslib.core.lifecycle;
     17 
     18 
     19 import static android.arch.lifecycle.Lifecycle.Event.ON_CREATE;
     20 import static android.arch.lifecycle.Lifecycle.Event.ON_DESTROY;
     21 import static android.arch.lifecycle.Lifecycle.Event.ON_PAUSE;
     22 import static android.arch.lifecycle.Lifecycle.Event.ON_RESUME;
     23 import static android.arch.lifecycle.Lifecycle.Event.ON_START;
     24 import static android.arch.lifecycle.Lifecycle.Event.ON_STOP;
     25 
     26 import android.annotation.CallSuper;
     27 import android.arch.lifecycle.LifecycleOwner;
     28 import android.content.Context;
     29 import android.os.Bundle;
     30 import android.support.v14.preference.PreferenceFragment;
     31 import android.support.v7.preference.PreferenceScreen;
     32 import android.view.Menu;
     33 import android.view.MenuInflater;
     34 import android.view.MenuItem;
     35 
     36 /**
     37  * {@link PreferenceFragment} that has hooks to observe fragment lifecycle events.
     38  */
     39 public abstract class ObservablePreferenceFragment extends PreferenceFragment
     40         implements LifecycleOwner {
     41 
     42     private final Lifecycle mLifecycle = new Lifecycle(this);
     43 
     44     public Lifecycle getLifecycle() {
     45         return mLifecycle;
     46     }
     47 
     48     @CallSuper
     49     @Override
     50     public void onAttach(Context context) {
     51         super.onAttach(context);
     52         mLifecycle.onAttach(context);
     53     }
     54 
     55     @CallSuper
     56     @Override
     57     public void onCreate(Bundle savedInstanceState) {
     58         mLifecycle.onCreate(savedInstanceState);
     59         mLifecycle.handleLifecycleEvent(ON_CREATE);
     60         super.onCreate(savedInstanceState);
     61     }
     62 
     63     @Override
     64     public void setPreferenceScreen(PreferenceScreen preferenceScreen) {
     65         mLifecycle.setPreferenceScreen(preferenceScreen);
     66         super.setPreferenceScreen(preferenceScreen);
     67     }
     68 
     69     @CallSuper
     70     @Override
     71     public void onSaveInstanceState(Bundle outState) {
     72         super.onSaveInstanceState(outState);
     73         mLifecycle.onSaveInstanceState(outState);
     74     }
     75 
     76     @CallSuper
     77     @Override
     78     public void onStart() {
     79         mLifecycle.handleLifecycleEvent(ON_START);
     80         super.onStart();
     81     }
     82 
     83     @CallSuper
     84     @Override
     85     public void onResume() {
     86         mLifecycle.handleLifecycleEvent(ON_RESUME);
     87         super.onResume();
     88     }
     89 
     90     @CallSuper
     91     @Override
     92     public void onPause() {
     93         mLifecycle.handleLifecycleEvent(ON_PAUSE);
     94         super.onPause();
     95     }
     96 
     97     @CallSuper
     98     @Override
     99     public void onStop() {
    100         mLifecycle.handleLifecycleEvent(ON_STOP);
    101         super.onStop();
    102     }
    103 
    104     @CallSuper
    105     @Override
    106     public void onDestroy() {
    107         mLifecycle.handleLifecycleEvent(ON_DESTROY);
    108         super.onDestroy();
    109     }
    110 
    111     @CallSuper
    112     @Override
    113     public void onCreateOptionsMenu(final Menu menu, final MenuInflater inflater) {
    114         mLifecycle.onCreateOptionsMenu(menu, inflater);
    115         super.onCreateOptionsMenu(menu, inflater);
    116     }
    117 
    118     @CallSuper
    119     @Override
    120     public void onPrepareOptionsMenu(final Menu menu) {
    121         mLifecycle.onPrepareOptionsMenu(menu);
    122         super.onPrepareOptionsMenu(menu);
    123     }
    124 
    125     @CallSuper
    126     @Override
    127     public boolean onOptionsItemSelected(final MenuItem menuItem) {
    128         boolean lifecycleHandled = mLifecycle.onOptionsItemSelected(menuItem);
    129         if (!lifecycleHandled) {
    130             return super.onOptionsItemSelected(menuItem);
    131         }
    132         return lifecycleHandled;
    133     }
    134 }
    135