• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 
17 package com.android.settings.notification;
18 
19 import android.content.Context;
20 
21 import androidx.annotation.VisibleForTesting;
22 import androidx.lifecycle.LifecycleObserver;
23 import androidx.lifecycle.OnLifecycleEvent;
24 import androidx.preference.PreferenceScreen;
25 
26 import com.android.settings.R;
27 import com.android.settings.notification.VolumeSeekBarPreference.Callback;
28 import com.android.settingslib.core.lifecycle.Lifecycle;
29 
30 /**
31  * Base class for preference controller that handles VolumeSeekBarPreference
32  */
33 public abstract class VolumeSeekBarPreferenceController extends
34         AdjustVolumeRestrictedPreferenceController implements LifecycleObserver {
35 
36     protected VolumeSeekBarPreference mPreference;
37     protected VolumeSeekBarPreference.Callback mVolumePreferenceCallback;
38     protected AudioHelper mHelper;
39 
VolumeSeekBarPreferenceController(Context context, String key)40     public VolumeSeekBarPreferenceController(Context context, String key) {
41         super(context, key);
42         setAudioHelper(new AudioHelper(context));
43     }
44 
45     @VisibleForTesting
setAudioHelper(AudioHelper helper)46     void setAudioHelper(AudioHelper helper) {
47         mHelper = helper;
48     }
49 
setCallback(Callback callback)50     public void setCallback(Callback callback) {
51         mVolumePreferenceCallback = callback;
52     }
53 
54     @Override
displayPreference(PreferenceScreen screen)55     public void displayPreference(PreferenceScreen screen) {
56         super.displayPreference(screen);
57         if (isAvailable()) {
58             setupVolPreference(screen);
59         }
60     }
61 
setupVolPreference(PreferenceScreen screen)62     protected void setupVolPreference(PreferenceScreen screen) {
63         mPreference = screen.findPreference(getPreferenceKey());
64         mPreference.setCallback(mVolumePreferenceCallback);
65         mPreference.setStream(getAudioStream());
66         mPreference.setMuteIcon(getMuteIcon());
67     }
68 
69     @OnLifecycleEvent(Lifecycle.Event.ON_RESUME)
onResume()70     public void onResume() {
71         if (mPreference != null) {
72             mPreference.onActivityResume();
73         }
74     }
75 
76     @OnLifecycleEvent(Lifecycle.Event.ON_PAUSE)
onPause()77     public void onPause() {
78         if (mPreference != null) {
79             mPreference.onActivityPause();
80         }
81     }
82 
83     @Override
getSliceHighlightMenuRes()84     public int getSliceHighlightMenuRes() {
85         return R.string.menu_key_sound;
86     }
87 
88     @Override
getSliderPosition()89     public int getSliderPosition() {
90         if (mPreference != null) {
91             return mPreference.getProgress();
92         }
93         return mHelper.getStreamVolume(getAudioStream());
94     }
95 
96     @Override
setSliderPosition(int position)97     public boolean setSliderPosition(int position) {
98         if (mPreference != null) {
99             mPreference.setProgress(position);
100         }
101         return mHelper.setStreamVolume(getAudioStream(), position);
102     }
103 
104     @Override
getMax()105     public int getMax() {
106         if (mPreference != null) {
107             return mPreference.getMax();
108         }
109         return mHelper.getMaxVolume(getAudioStream());
110     }
111 
112     @Override
getMin()113     public int getMin() {
114         if (mPreference != null) {
115             return mPreference.getMin();
116         }
117         return mHelper.getMinVolume(getAudioStream());
118     }
119 
120     /**
121      * @return the audio stream type
122      */
getAudioStream()123     public abstract int getAudioStream();
124 
getMuteIcon()125     protected abstract int getMuteIcon();
126 
127 }
128