1 /*
2  * Copyright (C) 2022 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.twopanelsettings.slices;
18 
19 import android.content.Context;
20 import android.text.TextUtils;
21 import android.util.AttributeSet;
22 import android.view.View;
23 
24 import androidx.preference.PreferenceViewHolder;
25 
26 import com.android.settingslib.RestrictedPreference;
27 
28 /**
29  * Restricted preference that allows external classes to set its view's content description for
30  * accessibility purposes.
31  */
32 public class CustomContentDescriptionRestrictedPreference extends RestrictedPreference implements
33         HasCustomContentDescription {
34 
35     private String mContentDescription;
36 
CustomContentDescriptionRestrictedPreference(Context context)37     public CustomContentDescriptionRestrictedPreference(Context context) {
38         super(context);
39     }
40 
CustomContentDescriptionRestrictedPreference(Context context, AttributeSet attrs)41     public CustomContentDescriptionRestrictedPreference(Context context, AttributeSet attrs) {
42         super(context, attrs);
43     }
44 
45     @Override
onBindViewHolder(PreferenceViewHolder holder)46     public void onBindViewHolder(PreferenceViewHolder holder) {
47         super.onBindViewHolder(holder);
48         if (!TextUtils.isEmpty(mContentDescription)) {
49             holder.itemView.setAccessibilityLiveRegion(View.ACCESSIBILITY_LIVE_REGION_POLITE);
50             holder.itemView.setContentDescription(mContentDescription);
51         }
52     }
53 
54     /**
55      * Sets the accessibility content description that will be read to the TalkBack users when they
56      * focus on this preference.
57      */
setContentDescription(String contentDescription)58     public void setContentDescription(String contentDescription) {
59         this.mContentDescription = contentDescription;
60     }
61 
getContentDescription()62     public String getContentDescription() {
63         return mContentDescription;
64     }
65 }
66