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

Commit 295ab7e9 authored by Edgar Wang's avatar Edgar Wang
Browse files

Clean up AddPreference and related resources

Bug: 420391483
Test: rebuild
Flag: EXEMPT clean up
Change-Id: I62b2e5d8c57abe62e779a46c6d6a3731df264f8d
parent d3b6bf5f
Loading
Loading
Loading
Loading
+0 −32
Original line number Diff line number Diff line
<?xml version="1.0" encoding="utf-8"?>
<!--
  Copyright (C) 2019 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.
  -->

<ImageView
    xmlns:android="http://schemas.android.com/apk/res/android"
    android:id="@+id/add_preference_widget"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:layout_gravity="center"
    android:minWidth="@dimen/two_target_min_width"
    android:paddingStart="?android:attr/listPreferredItemPaddingEnd"
    android:paddingEnd="?android:attr/listPreferredItemPaddingEnd"
    android:background="?android:attr/selectableItemBackground"
    android:scaleType="center"
    android:src="@drawable/ic_add_24dp"
    android:tint="?android:attr/colorAccent"
    android:contentDescription="@string/add" />
+0 −92
Original line number Diff line number Diff line
/*
 * Copyright (C) 2019 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 com.android.settings.R;
import com.android.settingslib.RestrictedPreference;

import androidx.annotation.VisibleForTesting;
import androidx.preference.PreferenceViewHolder;

/**
 * A preference with a plus button on the side representing an "add" action. The plus button will
 * only be visible when a non-null click listener is registered.
 */
public class AddPreference extends RestrictedPreference implements View.OnClickListener {

    private OnAddClickListener mListener;
    private View mWidgetFrame;
    private View mAddWidget;

    public AddPreference(Context context, AttributeSet attrs) {
        super(context, attrs);
    }

    @VisibleForTesting
    int getAddWidgetResId() {
        return R.id.add_preference_widget;
    }

    /** Sets a listener for clicks on the plus button. Passing null will cause the button to be
     * hidden. */
    public void setOnAddClickListener(OnAddClickListener listener) {
        mListener = listener;
       if (mWidgetFrame != null) {
           mWidgetFrame.setVisibility(shouldHideSecondTarget() ? View.GONE : View.VISIBLE);
       }
    }

    public void setAddWidgetEnabled(boolean enabled) {
        if (mAddWidget != null) {
            mAddWidget.setEnabled(enabled);
        }
    }

    @Override
    protected int getSecondTargetResId() {
        return R.layout.preference_widget_add;
    }

    @Override
    protected boolean shouldHideSecondTarget() {
        return mListener == null;
    }

    @Override
    public void onBindViewHolder(PreferenceViewHolder holder) {
        super.onBindViewHolder(holder);
        mWidgetFrame = holder.findViewById(android.R.id.widget_frame);
        mAddWidget = holder.findViewById(getAddWidgetResId());
        mAddWidget.setEnabled(true);
        mAddWidget.setOnClickListener(this);
    }

    @Override
    public void onClick(View view) {
        if (view.getId() == getAddWidgetResId() && mListener != null) {
            mListener.onAddClick(this);
        }
    }

    public interface OnAddClickListener {
        void onAddClick(AddPreference p);
    }
}
+0 −149
Original line number Diff line number Diff line
/*
 * Copyright (C) 2019 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.ArgumentMatchers.eq;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.spy;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

import android.content.Context;
import android.view.View;

import com.android.settings.R;

import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.MockitoAnnotations;
import org.robolectric.RobolectricTestRunner;
import org.robolectric.RuntimeEnvironment;

import androidx.preference.PreferenceViewHolder;

@RunWith(RobolectricTestRunner.class)
public class AddPreferenceTest {

    private Context mContext;
    private PreferenceViewHolder mViewHolder;
    private View mWidgetFrame;
    private View mAddWidget;
    private AddPreference mPreference;

    @Before
    public void setUp() {
        mContext = RuntimeEnvironment.application;
        mPreference = new AddPreference(mContext, null);

        final View view = spy(View.inflate(mContext, mPreference.getLayoutResource(), null));
        mViewHolder = PreferenceViewHolder.createInstanceForTests(view);
        mWidgetFrame = view.findViewById(android.R.id.widget_frame);
        mAddWidget = spy(View.inflate(mContext, mPreference.getSecondTargetResId(), null));
        when(mViewHolder.findViewById(mPreference.getAddWidgetResId())).thenReturn(mAddWidget);
    }

    @Test
    public void onBindViewHolder_noListener_addButtonNotVisible() {
        mPreference.onBindViewHolder(mViewHolder);
        assertThat(mPreference.shouldHideSecondTarget()).isTrue();
        assertThat(mWidgetFrame.getVisibility()).isEqualTo(View.GONE);
    }

    @Test
    public void onBindViewHolder_hasListener_addButtonVisible() {
        mPreference.setOnAddClickListener(p -> {});
        mPreference.onBindViewHolder(mViewHolder);
        assertThat(mPreference.shouldHideSecondTarget()).isFalse();
        assertThat(mWidgetFrame.getVisibility()).isEqualTo(View.VISIBLE);
    }

    @Test
    public void setOnAddClickListener_listenerAddedAfterBinding_addButtonBecomesVisible() {
        mPreference.onBindViewHolder(mViewHolder);
        assertThat(mPreference.shouldHideSecondTarget()).isTrue();
        assertThat(mWidgetFrame.getVisibility()).isEqualTo(View.GONE);

        mPreference.setOnAddClickListener(p -> {});
        assertThat(mPreference.shouldHideSecondTarget()).isFalse();
        assertThat(mWidgetFrame.getVisibility()).isEqualTo(View.VISIBLE);
    }

    @Test
    public void setOnAddClickListener_listenerRemovedAfterBinding_addButtonNotVisible() {
        mPreference.setOnAddClickListener(p -> {});

        mPreference.onBindViewHolder(mViewHolder);
        assertThat(mPreference.shouldHideSecondTarget()).isFalse();
        assertThat(mWidgetFrame.getVisibility()).isEqualTo(View.VISIBLE);

        mPreference.setOnAddClickListener(null);
        assertThat(mPreference.shouldHideSecondTarget()).isTrue();
        assertThat(mWidgetFrame.getVisibility()).isEqualTo(View.GONE);
    }

    @Test
    public void setOnAddClickListener_listenerAddedAndRemovedAfterBinding_addButtonNotVisible() {
        mPreference.onBindViewHolder(mViewHolder);
        assertThat(mPreference.shouldHideSecondTarget()).isTrue();
        assertThat(mWidgetFrame.getVisibility()).isEqualTo(View.GONE);

        mPreference.setOnAddClickListener(p -> {});
        assertThat(mPreference.shouldHideSecondTarget()).isFalse();
        assertThat(mWidgetFrame.getVisibility()).isEqualTo(View.VISIBLE);

        mPreference.setOnAddClickListener(null);
        assertThat(mPreference.shouldHideSecondTarget()).isTrue();
        assertThat(mWidgetFrame.getVisibility()).isEqualTo(View.GONE);
    }

    @Test
    public void onClick_noListener_noCrash() {
        mPreference.onBindViewHolder(mViewHolder);
        // should be no crash here
        mPreference.onClick(mAddWidget);
    }

    @Test
    public void onClick_hasListenerBeforeBind_firesCorrectly() {
        final AddPreference.OnAddClickListener listener = mock(
                AddPreference.OnAddClickListener.class);
        mPreference.setOnAddClickListener(listener);

        mPreference.onBindViewHolder(mViewHolder);
        assertThat(mWidgetFrame.getVisibility()).isEqualTo(View.VISIBLE);

        mPreference.onClick(mAddWidget);
        verify(listener).onAddClick(eq(mPreference));
    }

    @Test
    public void onClick_listenerAddedAfterBind_firesCorrectly() {
        mPreference.onBindViewHolder(mViewHolder);
        assertThat(mWidgetFrame.getVisibility()).isEqualTo(View.GONE);

        final AddPreference.OnAddClickListener listener = mock(
                AddPreference.OnAddClickListener.class);
        mPreference.setOnAddClickListener(listener);
        assertThat(mWidgetFrame.getVisibility()).isEqualTo(View.VISIBLE);

        mPreference.onClick(mAddWidget);
        verify(listener).onAddClick(eq(mPreference));
    }
}