app_Settings/src/com/android/settings/widget/PrimarySwitchController.java

/*
 * Copyright (C) 2020 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.widget;

import androidx.preference.Preference;

import com.android.settings.dashboard.DashboardFragment;
import com.android.settings.overlay.FeatureFactory;
import com.android.settingslib.RestrictedLockUtils.EnforcedAdmin;
import com.android.settingslib.RestrictedSwitchPreference;
import com.android.settingslib.core.instrumentation.MetricsFeatureProvider;

/**
 * The switch controller that is used to update the switch widget in the PrimarySwitchPreference
 * and RestrictedSwitchPreference layouts.
 */
// TODO(b/174022082): Modify the class name to GenericSwitchController.
public class PrimarySwitchController extends SwitchWidgetController implements
        Preference.OnPreferenceChangeListener {

    private Preference mPreference;
    private MetricsFeatureProvider mMetricsFeatureProvider;

    public PrimarySwitchController(PrimarySwitchPreference preference) {
        setPreference(preference);
    }

    public PrimarySwitchController(RestrictedSwitchPreference preference) {
        setPreference(preference);
    }

    private void setPreference(Preference preference) {
        mPreference = preference;
        mMetricsFeatureProvider =
                FeatureFactory.getFactory(preference.getContext()).getMetricsFeatureProvider();
    }

    @Override
    public void updateTitle(boolean isChecked) {
    }

    @Override
    public void startListening() {
        mPreference.setOnPreferenceChangeListener(this);
    }

    @Override
    public void stopListening() {
        mPreference.setOnPreferenceChangeListener(null);
    }

    @Override
    public void setChecked(boolean checked) {
        if (mPreference instanceof PrimarySwitchPreference) {
            ((PrimarySwitchPreference) mPreference).setChecked(checked);
        } else if (mPreference instanceof RestrictedSwitchPreference) {
            ((RestrictedSwitchPreference) mPreference).setChecked(checked);
        }
    }

    @Override
    public boolean isChecked() {
        if (mPreference instanceof PrimarySwitchPreference) {
            return ((PrimarySwitchPreference) mPreference).isChecked();
        } else if (mPreference instanceof RestrictedSwitchPreference) {
            return ((RestrictedSwitchPreference) mPreference).isChecked();
        }
        return false;
    }

    @Override
    public void setEnabled(boolean enabled) {
        if (mPreference instanceof PrimarySwitchPreference) {
            ((PrimarySwitchPreference) mPreference).setSwitchEnabled(enabled);
        } else if (mPreference instanceof RestrictedSwitchPreference) {
            ((RestrictedSwitchPreference) mPreference).setEnabled(enabled);
        }
    }

    @Override
    public boolean onPreferenceChange(Preference preference, Object newValue) {
        if (mListener != null) {
            final boolean result = mListener.onSwitchToggled((Boolean) newValue);
            if (result) {
                mMetricsFeatureProvider.logClickedPreference(preference,
                        preference.getExtras().getInt(DashboardFragment.CATEGORY));
            }
            return result;
        }
        return false;
    }

    @Override
    public void setDisabledByAdmin(EnforcedAdmin admin) {
        if (mPreference instanceof PrimarySwitchPreference) {
            ((PrimarySwitchPreference) mPreference).setDisabledByAdmin(admin);
        } else if (mPreference instanceof RestrictedSwitchPreference) {
            ((RestrictedSwitchPreference) mPreference).setDisabledByAdmin(admin);
        }
    }
}