Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit a881d3e3 authored by Edgar Wang's avatar Edgar Wang Committed by Android (Google) Code Review
Browse files

Merge "Cleanup unused PrimaryCheckBoxPreference" into main

parents 98dfdabe b39aab08

res/layout/preference_widget_primary_checkbox.xml

deleted100644 → 0
+0 −26
Original line number Diff line number Diff line 
<?xml version="1.0" encoding="utf-8"?>

<!--

  Copyright (C) 2018 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.

  -->



<CheckBox

    xmlns:android="http://schemas.android.com/apk/res/android"

    android:id="@+id/checkboxWidget"

    android:layout_width="match_parent"

    android:layout_height="match_parent"

    android:gravity="center"

    android:layout_marginStart="?android:attr/listPreferredItemPaddingEnd"

    android:layout_marginEnd="?android:attr/listPreferredItemPaddingEnd"

    android:clickable="false" />

src/com/android/settings/widget/PrimaryCheckBoxPreference.java

deleted100644 → 0
+0 −126
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2018 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 android.content.Context;

import android.util.AttributeSet;

import android.view.View;

import android.view.View.OnClickListener;

import android.widget.CheckBox;



import androidx.preference.PreferenceViewHolder;



import com.android.settings.R;

import com.android.settingslib.widget.TwoTargetPreference;



/**

 * A custom preference that provides inline checkbox. It has a mandatory field for title, and

 * optional fields for icon and sub-text.

 */

public class PrimaryCheckBoxPreference extends TwoTargetPreference {



    private CheckBox mCheckBox;

    private boolean mChecked;

    private boolean mEnableCheckBox = true;



    public PrimaryCheckBoxPreference(Context context, AttributeSet attrs,

            int defStyleAttr, int defStyleRes) {

        super(context, attrs, defStyleAttr, defStyleRes);

    }



    public PrimaryCheckBoxPreference(Context context, AttributeSet attrs, int defStyleAttr) {

        super(context, attrs, defStyleAttr);

    }



    public PrimaryCheckBoxPreference(Context context, AttributeSet attrs) {

        super(context, attrs);

    }



    public PrimaryCheckBoxPreference(Context context) {

        super(context);

    }



    @Override

    protected int getSecondTargetResId() {

        return R.layout.preference_widget_primary_checkbox;

    }



    @Override

    public void onBindViewHolder(PreferenceViewHolder holder) {

        super.onBindViewHolder(holder);

        final View widgetView = holder.findViewById(android.R.id.widget_frame);

        if (widgetView != null) {

            widgetView.setOnClickListener(new OnClickListener() {

                @Override

                public void onClick(View v) {

                    if (mCheckBox != null && !mCheckBox.isEnabled()) {

                        return;

                    }

                    setChecked(!mChecked);

                    if (!callChangeListener(mChecked)) {

                        setChecked(!mChecked);

                    } else {

                        persistBoolean(mChecked);

                    }

                }

            });

        }



        mCheckBox = (CheckBox) holder.findViewById(R.id.checkboxWidget);

        if (mCheckBox != null) {

            mCheckBox.setContentDescription(getTitle());

            mCheckBox.setChecked(mChecked);

            mCheckBox.setEnabled(mEnableCheckBox);

        }

    }



    @Override

    public void setEnabled(boolean enabled) {

        super.setEnabled(enabled);

        setCheckBoxEnabled(enabled);

    }



    public boolean isChecked() {

        return mCheckBox != null && mChecked;

    }



    /**

     * Set the check status of checkbox

     * @param checked

     */

    public void setChecked(boolean checked) {

        mChecked = checked;

        if (mCheckBox != null) {

            mCheckBox.setChecked(checked);

        }

    }



    /**

     * Set the enabled status of CheckBox

     * @param enabled

     */

    public void setCheckBoxEnabled(boolean enabled) {

        mEnableCheckBox = enabled;

        if (mCheckBox != null) {

            mCheckBox.setEnabled(enabled);

        }

    }



    public CheckBox getCheckBox() {

        return mCheckBox;

    }

}

tests/robotests/src/com/android/settings/widget/PrimaryCheckBoxPreferenceTest.java

deleted100644 → 0
+0 −194
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2018 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 static com.google.common.truth.Truth.assertThat;



import static org.mockito.Mockito.mock;

import static org.mockito.Mockito.verify;



import android.content.Context;

import android.view.LayoutInflater;

import android.view.View;

import android.widget.CheckBox;

import android.widget.LinearLayout;



import androidx.preference.Preference.OnPreferenceChangeListener;

import androidx.preference.PreferenceViewHolder;



import com.android.settings.R;



import org.junit.Before;

import org.junit.Test;

import org.junit.runner.RunWith;

import org.robolectric.RobolectricTestRunner;

import org.robolectric.RuntimeEnvironment;



@RunWith(RobolectricTestRunner.class)

public class PrimaryCheckBoxPreferenceTest {



    private Context mContext;

    private PrimaryCheckBoxPreference mPreference;



    @Before

    public void setUp() {

        mContext = RuntimeEnvironment.application;

        mPreference = new PrimaryCheckBoxPreference(mContext);

    }



    @Test

    public void createNewPreference_shouldSetLayout() {

        assertThat(mPreference.getWidgetLayoutResource())

                .isEqualTo(R.layout.preference_widget_primary_checkbox);

    }



    @Test

    public void setChecked_shouldUpdateCheckBoxCheckedState() {

        final PreferenceViewHolder holder = PreferenceViewHolder.createInstanceForTests(

                LayoutInflater.from(mContext).inflate(

                  R.layout.preference_widget_primary_checkbox, null));

        final CheckBox checkBox = (CheckBox) holder.findViewById(R.id.checkboxWidget);

        mPreference.onBindViewHolder(holder);



        mPreference.setChecked(true);

        assertThat(checkBox.isChecked()).isTrue();



        mPreference.setChecked(false);

        assertThat(checkBox.isChecked()).isFalse();

    }



    @Test

    public void setEnabled_shouldUpdateCheckBoxEnabledState() {

        final PreferenceViewHolder holder = PreferenceViewHolder.createInstanceForTests(

                LayoutInflater.from(mContext).inflate(

                  R.layout.preference_widget_primary_checkbox, null));

        final CheckBox checkBox = (CheckBox) holder.findViewById(R.id.checkboxWidget);

        mPreference.onBindViewHolder(holder);



        mPreference.setEnabled(true);

        assertThat(checkBox.isEnabled()).isTrue();



        mPreference.setEnabled(false);

        assertThat(checkBox.isEnabled()).isFalse();

    }



    @Test

    public void setCheckboxEnabled_shouldOnlyUpdateCheckBoxEnabledState() {

        final PreferenceViewHolder holder = PreferenceViewHolder.createInstanceForTests(

                LayoutInflater.from(mContext).inflate(

                        R.layout.preference_widget_primary_checkbox, null));

        final CheckBox checkBox = (CheckBox) holder.findViewById(R.id.checkboxWidget);

        mPreference.onBindViewHolder(holder);



        mPreference.setCheckBoxEnabled(false);

        assertThat(mPreference.isEnabled()).isTrue();

        assertThat(checkBox.isEnabled()).isFalse();



        mPreference.setCheckBoxEnabled(true);

        assertThat(mPreference.isEnabled()).isTrue();

        assertThat(checkBox.isEnabled()).isTrue();

    }



    @Test

    public void onBindViewHolder_shouldSetCheckboxEnabledState() {

        final PreferenceViewHolder holder = PreferenceViewHolder.createInstanceForTests(

                LayoutInflater.from(mContext).inflate(

                        R.layout.preference_widget_primary_checkbox, null));

        final CheckBox checkBox = (CheckBox) holder.findViewById(R.id.checkboxWidget);



        mPreference.setCheckBoxEnabled(false);

        mPreference.onBindViewHolder(holder);



        assertThat(mPreference.isEnabled()).isTrue();

        assertThat(checkBox.isEnabled()).isFalse();



        mPreference.setCheckBoxEnabled(true);

        assertThat(mPreference.isEnabled()).isTrue();

        assertThat(checkBox.isEnabled()).isTrue();

    }



    @Test

    public void clickWidgetView_shouldToggleCheckBox() {

        final LayoutInflater inflater = LayoutInflater.from(mContext);

        final PreferenceViewHolder holder = PreferenceViewHolder.createInstanceForTests(

                inflater.inflate(

                        com.android.settingslib.widget.preference.twotarget.R.layout.preference_two_target, null));

        final LinearLayout widgetView = holder.itemView.findViewById(android.R.id.widget_frame);

        assertThat(widgetView).isNotNull();



        inflater.inflate(R.layout.preference_widget_primary_checkbox, widgetView, true);

        final CheckBox checkBox = (CheckBox) holder.findViewById(R.id.checkboxWidget);

        mPreference.onBindViewHolder(holder);



        widgetView.performClick();

        assertThat(checkBox.isChecked()).isTrue();



        widgetView.performClick();

        assertThat(checkBox.isChecked()).isFalse();

    }



    @Test

    public void clickWidgetView_shouldNotToggleCheckBoxIfDisabled() {

        final LayoutInflater inflater = LayoutInflater.from(mContext);

        final PreferenceViewHolder holder = PreferenceViewHolder.createInstanceForTests(

                inflater.inflate(

                        com.android.settingslib.widget.preference.twotarget.R.layout.preference_two_target, null));

        final LinearLayout widgetView = holder.itemView.findViewById(android.R.id.widget_frame);

        assertThat(widgetView).isNotNull();



        inflater.inflate(R.layout.preference_widget_primary_checkbox, widgetView, true);

        final CheckBox checkBox = (CheckBox) holder.findViewById(R.id.checkboxWidget);

        mPreference.onBindViewHolder(holder);

        mPreference.setEnabled(false);



        widgetView.performClick();

        assertThat(checkBox.isChecked()).isFalse();

    }



    @Test

    public void clickWidgetView_shouldNotifyPreferenceChanged() {

        final PreferenceViewHolder holder = PreferenceViewHolder.createInstanceForTests(

                LayoutInflater.from(mContext).inflate(

                        com.android.settingslib.widget.preference.twotarget.R.layout.preference_two_target, null));

        final View widgetView = holder.findViewById(android.R.id.widget_frame);

        final OnPreferenceChangeListener listener = mock(OnPreferenceChangeListener.class);

        mPreference.setOnPreferenceChangeListener(listener);

        mPreference.onBindViewHolder(holder);



        mPreference.setChecked(false);

        widgetView.performClick();

        verify(listener).onPreferenceChange(mPreference, true);



        mPreference.setChecked(true);

        widgetView.performClick();

        verify(listener).onPreferenceChange(mPreference, false);

    }



    @Test

    public void onBindViewHolder_checkBoxShouldHaveContentDescription() {

        final PreferenceViewHolder holder = PreferenceViewHolder.createInstanceForTests(

                LayoutInflater.from(mContext).inflate(R.layout.preference_widget_primary_checkbox,

                        null));

        final CheckBox checkBox = (CheckBox) holder.findViewById(R.id.checkboxWidget);

        final String label = "TestButton";

        mPreference.setTitle(label);



        mPreference.onBindViewHolder(holder);



        assertThat(checkBox.getContentDescription()).isEqualTo(label);

    }

}