Home | History | Annotate | Download | only in settings 
      1 /*
      2  * Copyright (C) 2017 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.tv.settings;
     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.annotation.NonNull;
     31 import android.support.v17.preference.LeanbackPreferenceFragment;
     32 import android.support.v7.preference.PreferenceScreen;
     33 import android.view.Menu;
     34 import android.view.MenuInflater;
     35 import android.view.MenuItem;
     36 
     37 import com.android.settingslib.core.instrumentation.Instrumentable;
     38 import com.android.settingslib.core.instrumentation.MetricsFeatureProvider;
     39 import com.android.settingslib.core.instrumentation.VisibilityLoggerMixin;
     40 import com.android.settingslib.core.lifecycle.Lifecycle;
     41 
     42 /**
     43  * A {@link LeanbackPreferenceFragment} that has hooks to observe fragment lifecycle events
     44  * and allow for instrumentation.
     45  */
     46 public abstract class SettingsPreferenceFragment extends LeanbackPreferenceFragment
     47         implements LifecycleOwner, Instrumentable {
     48     private final Lifecycle mLifecycle = new Lifecycle(this);
     49     private final VisibilityLoggerMixin mVisibilityLoggerMixin;
     50     protected MetricsFeatureProvider mMetricsFeatureProvider;
     51 
     52     @NonNull
     53     public Lifecycle getLifecycle() {
     54         return mLifecycle;
     55     }
     56 
     57     public SettingsPreferenceFragment() {
     58         mMetricsFeatureProvider = new MetricsFeatureProvider();
     59         // Mixin that logs visibility change for activity.
     60         mVisibilityLoggerMixin = new VisibilityLoggerMixin(getMetricsCategory(),
     61                 mMetricsFeatureProvider);
     62         getLifecycle().addObserver(mVisibilityLoggerMixin);
     63     }
     64 
     65     @CallSuper
     66     @Override
     67     public void onAttach(Context context) {
     68         super.onAttach(context);
     69         mLifecycle.onAttach(context);
     70     }
     71 
     72     @CallSuper
     73     @Override
     74     public void onCreate(Bundle savedInstanceState) {
     75         mLifecycle.onCreate(savedInstanceState);
     76         mLifecycle.handleLifecycleEvent(ON_CREATE);
     77         super.onCreate(savedInstanceState);
     78     }
     79 
     80     @Override
     81     public void setPreferenceScreen(PreferenceScreen preferenceScreen) {
     82         mLifecycle.setPreferenceScreen(preferenceScreen);
     83         super.setPreferenceScreen(preferenceScreen);
     84     }
     85 
     86     @CallSuper
     87     @Override
     88     public void onSaveInstanceState(Bundle outState) {
     89         super.onSaveInstanceState(outState);
     90         mLifecycle.onSaveInstanceState(outState);
     91     }
     92 
     93     @CallSuper
     94     @Override
     95     public void onStart() {
     96         mLifecycle.handleLifecycleEvent(ON_START);
     97         super.onStart();
     98     }
     99 
    100     @CallSuper
    101     @Override
    102     public void onResume() {
    103         mVisibilityLoggerMixin.setSourceMetricsCategory(getActivity());
    104         mLifecycle.handleLifecycleEvent(ON_RESUME);
    105         super.onResume();
    106     }
    107 
    108     @CallSuper
    109     @Override
    110     public void onPause() {
    111         mLifecycle.handleLifecycleEvent(ON_PAUSE);
    112         super.onPause();
    113     }
    114 
    115     @CallSuper
    116     @Override
    117     public void onStop() {
    118         mLifecycle.handleLifecycleEvent(ON_STOP);
    119         super.onStop();
    120     }
    121 
    122     @CallSuper
    123     @Override
    124     public void onDestroy() {
    125         mLifecycle.handleLifecycleEvent(ON_DESTROY);
    126         super.onDestroy();
    127     }
    128 
    129     @CallSuper
    130     @Override
    131     public void onCreateOptionsMenu(final Menu menu, final MenuInflater inflater) {
    132         mLifecycle.onCreateOptionsMenu(menu, inflater);
    133         super.onCreateOptionsMenu(menu, inflater);
    134     }
    135 
    136     @CallSuper
    137     @Override
    138     public void onPrepareOptionsMenu(final Menu menu) {
    139         mLifecycle.onPrepareOptionsMenu(menu);
    140         super.onPrepareOptionsMenu(menu);
    141     }
    142 
    143     @CallSuper
    144     @Override
    145     public boolean onOptionsItemSelected(final MenuItem menuItem) {
    146         boolean lifecycleHandled = mLifecycle.onOptionsItemSelected(menuItem);
    147         if (!lifecycleHandled) {
    148             return super.onOptionsItemSelected(menuItem);
    149         }
    150         return lifecycleHandled;
    151     }
    152 }
    153