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

Commit 6dc0e30b authored by jasonwshsu's avatar jasonwshsu Committed by Jason Hsu
Browse files

Provides BackgroundPreference that can set background statically or dynamically 

Bug: 320709814
Test: atest BackgroundPreferenceTest
Change-Id: I73e62733e6afd032ce980a4d6db0f4ca4573e770
parent be3a609c

res/layout/preference_background.xml

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



<!--

  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.

  -->



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

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

    android:layout_height="wrap_content"

    android:layout_width="match_parent"

    android:minHeight="?android:attr/listPreferredItemHeight"

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

    android:paddingStart="?android:attr/listPreferredItemPaddingStart"

    android:paddingVertical="@dimen/settingslib_switchbar_margin"

    android:background="@android:color/transparent">



    <LinearLayout

        android:id="@+id/background"

        android:layout_height="wrap_content"

        android:layout_width="match_parent"

        android:paddingStart="@dimen/settingslib_switchbar_padding_left"

        android:paddingEnd="@dimen/settingslib_switchbar_padding_right"

        android:orientation="horizontal"

        android:gravity="start|center_vertical"

        android:baselineAligned="false">



        <FrameLayout

            android:id="@+id/icon_frame"

            android:layout_width="wrap_content"

            android:layout_height="wrap_content"

            android:layout_marginEnd="15dip"

            android:layout_marginRight="15dip">

            <androidx.preference.internal.PreferenceImageView

                android:id="@android:id/icon"

                android:layout_width="wrap_content"

                android:layout_height="wrap_content"

                app:maxWidth="48dp"

                app:maxHeight="48dp" />

        </FrameLayout>



        <RelativeLayout

            android:layout_width="0dp"

            android:layout_height="wrap_content"

            android:layout_marginEnd="6dip"

            android:layout_marginRight="6dip"

            android:layout_marginTop="@dimen/settingslib_switch_title_margin"

            android:layout_marginBottom="@dimen/settingslib_switch_title_margin"

            android:layout_weight="1">



            <TextView android:id="@android:id/title"

                android:layout_width="wrap_content"

                android:layout_height="wrap_content"

                android:singleLine="true"

                android:textAppearance="?android:attr/textAppearanceListItem"

                android:textColor="?android:attr/textColorPrimary"

                android:ellipsize="marquee"

                android:fadingEdge="horizontal"

                android:hyphenationFrequency="normalFast"

                android:lineBreakWordStyle="phrase" />



            <TextView android:id="@android:id/summary"

                android:layout_width="wrap_content"

                android:layout_height="wrap_content"

                android:layout_below="@android:id/title"

                android:layout_alignStart="@android:id/title"

                android:layout_alignLeft="@android:id/title"

                android:textAppearance="?android:attr/textAppearanceSmall"

                android:textColor="?android:attr/textColorSecondary"

                android:hyphenationFrequency="normalFast"

                android:lineBreakWordStyle="phrase"

                android:maxLines="4"

                android:scrollbars="none"/>

        </RelativeLayout>



        <!-- Preference should place its actual preference widget here. -->

        <LinearLayout android:id="@android:id/widget_frame"

            android:layout_width="wrap_content"

            android:layout_height="match_parent"

            android:gravity="center_vertical"

            android:orientation="vertical" />

    </LinearLayout>



</FrameLayout>
 
 No newline at end of file

res/values/attrs.xml

+5 −0
Original line number Diff line number Diff line
@@ -198,4 +198,9 @@ 
    <attr name="notification_importance_button_background_color_selected" format="color" />

    <attr name="notification_importance_button_border_color_selected" format="color" />

    <attr name="notification_importance_button_foreground_color_selected" format="color" />



    <!-- For BackgroundPreference -->

    <declare-styleable name="BackgroundPreference">

        <attr name="background" format="reference" />

    </declare-styleable>

</resources>

src/com/android/settings/accessibility/BackgroundPreference.java

0 → 100644
+93 −0
Original line number Diff line number Diff line 
/*

 * 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.content.Context;

import android.content.res.TypedArray;

import android.graphics.drawable.Drawable;

import android.util.AttributeSet;

import android.widget.LinearLayout;



import androidx.annotation.DrawableRes;

import androidx.annotation.NonNull;

import androidx.annotation.Nullable;

import androidx.core.content.res.TypedArrayUtils;

import androidx.preference.Preference;

import androidx.preference.PreferenceViewHolder;



import com.android.settings.R;



/**

 * A preference with custom background.

 */

public class BackgroundPreference extends Preference {



    private int mBackgroundId;



    public BackgroundPreference(@NonNull Context context,

            @Nullable AttributeSet attrs, int defStyleAttr,

            int defStyleRes) {

        super(context, attrs, defStyleAttr, defStyleRes);

        setLayoutResource(R.layout.preference_background);

        setIconSpaceReserved(false);



        final TypedArray styledAttrs = context.obtainStyledAttributes(attrs,

                R.styleable.BackgroundPreference);

        mBackgroundId = styledAttrs.getResourceId(R.styleable.BackgroundPreference_background, 0);

        styledAttrs.recycle();

    }



    public BackgroundPreference(@NonNull Context context, @Nullable AttributeSet attrs,

            int defStyleAttr) {

        this(context, attrs, defStyleAttr, 0);

    }



    public BackgroundPreference(@NonNull Context context, @Nullable AttributeSet attrs) {

        this(context, attrs, TypedArrayUtils.getAttr(context,

                androidx.preference.R.attr.preferenceStyle,

                com.android.internal.R.attr.preferenceStyle), 0);

    }



    public BackgroundPreference(@NonNull Context context) {

        this(context, null, TypedArrayUtils.getAttr(context,

                androidx.preference.R.attr.preferenceStyle,

                com.android.internal.R.attr.preferenceStyle), 0);

    }



    @Override

    public void onBindViewHolder(@NonNull PreferenceViewHolder holder) {

        super.onBindViewHolder(holder);



        final LinearLayout layout = (LinearLayout) holder.findViewById(R.id.background);

        if (mBackgroundId != 0) {

            final Drawable backgroundDrawable = getContext().getDrawable(mBackgroundId);

            layout.setBackground(backgroundDrawable);

        }

    }



    /**

     * Sets the background to a given resource. The resource should refer to a Drawable object.

     *

     * @param resId The identifier of the resource.

     */

    public void setBackground(@DrawableRes int resId) {

        if (mBackgroundId != resId) {

            mBackgroundId = resId;

            notifyChanged();

        }

    }

}

tests/robotests/src/com/android/settings/accessibility/BackgroundPreferenceTest.java

0 → 100644
+72 −0
Original line number Diff line number Diff line 
/*

 * 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 static org.mockito.ArgumentMatchers.any;

import static org.mockito.Mockito.doReturn;

import static org.mockito.Mockito.verify;



import android.content.Context;

import android.view.View;

import android.widget.LinearLayout;



import androidx.preference.PreferenceViewHolder;

import androidx.test.core.app.ApplicationProvider;



import com.android.settings.R;



import org.junit.Before;

import org.junit.Rule;

import org.junit.Test;

import org.junit.runner.RunWith;

import org.mockito.Spy;

import org.mockito.junit.MockitoJUnit;

import org.mockito.junit.MockitoRule;

import org.robolectric.RobolectricTestRunner;



/** Tests for {@link BackgroundPreference} */

@RunWith(RobolectricTestRunner.class)

public class BackgroundPreferenceTest {



    @Rule

    public final MockitoRule mMockitoRule = MockitoJUnit.rule();



    private final Context mContext = ApplicationProvider.getApplicationContext();



    private View mRootView = new View(mContext);

    @Spy

    private PreferenceViewHolder mViewHolder = PreferenceViewHolder.createInstanceForTests(

            mRootView);

    @Spy

    private LinearLayout mLinearLayout = new LinearLayout(mContext);

    private BackgroundPreference mPreference;



    @Before

    public void setUp() {

        mPreference = new BackgroundPreference(mContext);

    }



    @Test

    public void setBackground_success() {

        doReturn(mLinearLayout).when(mViewHolder).findViewById(R.id.background);



        mPreference.setBackground(android.R.drawable.screen_background_dark);

        mPreference.onBindViewHolder(mViewHolder);



        verify(mLinearLayout).setBackground(any());

    }

}