src/com/android/settings/accessibility/VibrationIntensityScreen.kt

/*
 * Copyright (C) 2024 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.android.settings.accessibility

import android.app.settings.SettingsEnums
import android.content.Context
import android.provider.Settings.System.APPLY_RAMPING_RINGER
import android.provider.Settings.System.KEYBOARD_VIBRATION_ENABLED
import android.provider.Settings.System.RING_VIBRATION_INTENSITY
import android.provider.Settings.System.VIBRATE_ON
import androidx.fragment.app.Fragment
import com.android.settings.R
import com.android.settings.Settings.VibrationIntensitySettingsActivity
import com.android.settings.core.PreferenceScreenMixin
import com.android.settings.utils.makeLaunchIntent
import com.android.settingslib.metadata.PreferenceAvailabilityProvider
import com.android.settingslib.metadata.preferencesapi.preconditions.PreconditionStability
import com.android.settingslib.metadata.PreferenceMetadata
import com.android.settingslib.metadata.ProvidePreferenceScreen
import com.android.settingslib.metadata.preferenceHierarchy
import kotlinx.coroutines.CoroutineScope
import com.android.settings.appfunctions.DeviceStateAppFunctionType
import com.android.settingslib.metadata.preferencesapi.PreferencesApiScreen.Companion.APP_FUNCTION_UNCATEGORIZED

/** Accessibility settings for vibration intensities. */
// TODO(b/368360218): investigate if we still need this screen once we finish the migration.
//  We might be able to consolidate this into VibrationScreen with PreferenceHierarchy choosing
//  between toggle or slider preferences based on device config, depending on how overlays are done.
// LINT.IfChange
@ProvidePreferenceScreen(VibrationIntensityScreen.KEY)
open class VibrationIntensityScreen : PreferenceScreenMixin, PreferenceAvailabilityProvider {
    override fun tags(context: Context) = arrayOf(APP_FUNCTION_UNCATEGORIZED)

    override val key: String
        get() = KEY

    override val purpose: Int
        get() = R.string.vibration_intensity_screen_purpose

    override val title: Int
        get() = R.string.accessibility_vibration_settings_title

    override val keywords: Int
        get() = R.string.keywords_vibration

    override fun getMetricsCategory() = SettingsEnums.ACCESSIBILITY_VIBRATION

    override val availabilityDescription =
        "The device must have a vibrator and support at least two vibration intensity levels."

    override fun getAvailabilityStability() = PreconditionStability.STABLE_UNTIL_APK_UPDATE

    override fun isAvailable(context: Context) =
        context.hasVibrator && context.getSupportedVibrationIntensityLevels() > 1

    override val highlightMenuKey
        get() = R.string.menu_key_accessibility

    override fun hasCompleteHierarchy() = false

    override fun fragmentClass(): Class<out Fragment>? =
        VibrationIntensitySettingsFragment::class.java

    override fun getPreferenceHierarchy(context: Context, coroutineScope: CoroutineScope) =
        preferenceHierarchy(context) {
            +VibrationMainSwitchPreference(VIBRATE_ON, purpose = R.string.vibrate_on_purpose)
            +CallVibrationPreferenceCategory() += {
                +RingVibrationIntensitySliderPreference(context)
                +RampingRingerVibrationSwitchPreference(
                    context,
                    key = APPLY_RAMPING_RINGER,
                    purpose = R.string.apply_ramping_ringer_purpose,
                    ringPreferenceKey = RING_VIBRATION_INTENSITY,
                )
            }
            +NotificationAlarmVibrationPreferenceCategory() += {
                +NotificationVibrationIntensitySliderPreference(context)
                +AlarmVibrationIntensitySliderPreference(context)
            }
            +InteractiveHapticsPreferenceCategory() += {
                +TouchVibrationIntensitySliderPreference(context)
                +MediaVibrationIntensitySliderPreference(context)
                +KeyboardVibrationSwitchPreference(
                    context,
                    KEYBOARD_VIBRATION_ENABLED,
                    R.string.keyboard_vibration_enabled_purpose,
                )
                +KeyboardVibrationIntensitySliderPreference(context)
            }
        }

    override fun getLaunchIntent(context: Context, metadata: PreferenceMetadata?) =
        makeLaunchIntent(context, VibrationIntensitySettingsActivity::class.java, metadata?.key)

    companion object {
        const val KEY = "vibration_intensity_screen"
    }
}
// LINT.ThenChange(VibrationPreferenceController.java)