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.settingslib.preference 18 19 import androidx.preference.Preference 20 import com.android.settingslib.metadata.MainSwitchPreference 21 import com.android.settingslib.metadata.PreferenceCategory 22 import com.android.settingslib.metadata.PreferenceHierarchyNode 23 import com.android.settingslib.metadata.PreferenceMetadata 24 import com.android.settingslib.metadata.SwitchPreference 25 26 /** Factory to map [PreferenceMetadata] to [PreferenceBinding]. */ 27 interface PreferenceBindingFactory { 28 29 /** 30 * Binds [Preference] and its associated [PreferenceMetadata] with given [PreferenceBinding] 31 * (`getPreferenceBinding(metadata)` is used if [preferenceBinding] is `null`). 32 * 33 * Subclass could override this callback to handle common binding logic. For instance, 34 * restricted preference with policy transparency. 35 */ bindnull36 fun bind( 37 preference: Preference, 38 node: PreferenceHierarchyNode, 39 preferenceBinding: PreferenceBinding? = null, 40 ) { 41 val binding = (preferenceBinding ?: getPreferenceBinding(node.metadata)) ?: return 42 binding.bind(preference, node.metadata) 43 node.order?.let { preference.order = it } 44 } 45 46 /** Returns the [PreferenceBinding] associated with the [PreferenceMetadata]. */ getPreferenceBindingnull47 fun getPreferenceBinding(metadata: PreferenceMetadata): PreferenceBinding? 48 49 companion object { 50 /** Default preference binding factory. */ 51 @JvmStatic var defaultFactory: PreferenceBindingFactory = DefaultPreferenceBindingFactory() 52 } 53 } 54 55 /** Default [PreferenceBindingFactory]. */ 56 open class DefaultPreferenceBindingFactory : PreferenceBindingFactory { 57 getPreferenceBindingnull58 override fun getPreferenceBinding(metadata: PreferenceMetadata) = 59 metadata as? PreferenceBinding 60 ?: when (metadata) { 61 is SwitchPreference -> SwitchPreferenceBinding.INSTANCE 62 is PreferenceCategory -> PreferenceCategoryBinding.INSTANCE 63 is MainSwitchPreference -> MainSwitchPreferenceBinding.INSTANCE 64 else -> DefaultPreferenceBinding 65 } 66 } 67 68 /** A preference key based binding factory. */ 69 class KeyedPreferenceBindingFactory(private val bindings: Map<String, PreferenceBinding>) : 70 PreferenceBindingFactory { 71 getPreferenceBindingnull72 override fun getPreferenceBinding(metadata: PreferenceMetadata) = 73 bindings[metadata.key] 74 ?: PreferenceBindingFactory.defaultFactory.getPreferenceBinding(metadata) 75 } 76