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

Commit edb52508 authored by Peter_Liang's avatar Peter_Liang
Browse files

New feature “Text and reading options” for SetupWizard, Wallpaper, and Settings (12/n). 

- Link-up between the preview, font size, and display size preferences.
- Add the preview preference and entry.

Bug: 211503117
Test: make RunSettingsRoboTests ROBOTEST_FILTER=TextReadingPreviewControllerTest
Test: make RunSettingsRoboTests ROBOTEST_FILTER=TextReadingPreviewPreferenceTest
Change-Id: Ic6c48861a0051670fd78b13dca5488711de30cb8
parent 0eee6994

res/xml/accessibility_text_reading_options.xml

+4 −0
Original line number Diff line number Diff line
@@ -21,6 +21,10 @@ 
    android:persistent="false"

    android:title="@string/accessibility_text_reading_options_title">



    <com.android.settings.accessibility.TextReadingPreviewPreference

        android:key="preview"

        android:selectable="false"/>



    <com.android.settings.widget.LabeledSeekBarPreference

        android:key="font_size"

        android:selectable="false"

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

+15 −3
Original line number Diff line number Diff line
@@ -37,6 +37,7 @@ public class TextReadingPreferenceFragment extends DashboardFragment { 
    private static final String TAG = "TextReadingPreferenceFragment";

    private static final String FONT_SIZE_KEY = "font_size";

    private static final String DISPLAY_SIZE_KEY = "display_size";

    private static final String PREVIEW_KEY = "preview";



    @Override

    protected int getPreferenceScreenResId() {
@@ -58,9 +59,20 @@ public class TextReadingPreferenceFragment extends DashboardFragment { 
        final List<AbstractPreferenceController> controllers = new ArrayList<>();

        final FontSizeData fontSizeData = new FontSizeData(context);

        final DisplaySizeData displaySizeData = new DisplaySizeData(context);

        controllers.add(new PreviewSizeSeekBarController(context, FONT_SIZE_KEY, fontSizeData));

        controllers.add(

                new PreviewSizeSeekBarController(context, DISPLAY_SIZE_KEY, displaySizeData));



        final TextReadingPreviewController previewController = new TextReadingPreviewController(

                context, PREVIEW_KEY, fontSizeData, displaySizeData);

        controllers.add(previewController);



        final PreviewSizeSeekBarController fontSizeController = new PreviewSizeSeekBarController(

                context, FONT_SIZE_KEY, fontSizeData);

        fontSizeController.setInteractionListener(previewController);

        controllers.add(fontSizeController);



        final PreviewSizeSeekBarController displaySizeController = new PreviewSizeSeekBarController(

                context, DISPLAY_SIZE_KEY, displaySizeData);

        displaySizeController.setInteractionListener(previewController);

        controllers.add(displaySizeController);



        return controllers;

    }

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

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

 * Copyright (C) 2022 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.Configuration;

import android.os.SystemClock;

import android.view.Choreographer;

import android.view.View;



import androidx.annotation.NonNull;

import androidx.preference.PreferenceScreen;



import com.android.settings.R;

import com.android.settings.core.BasePreferenceController;

import com.android.settings.display.PreviewPagerAdapter;

import com.android.settings.widget.LabeledSeekBarPreference;



import java.util.Objects;



/**

 * A {@link BasePreferenceController} for controlling the preview pager of the text and reading

 * options.

 */

class TextReadingPreviewController extends BasePreferenceController implements

        PreviewSizeSeekBarController.ProgressInteractionListener {

    static final int[] PREVIEW_SAMPLE_RES_IDS = new int[]{

            R.layout.accessibility_text_reading_preview_app_grid,

            R.layout.screen_zoom_preview_1,

            R.layout.accessibility_text_reading_preview_mail_content};



    private static final String PREVIEW_KEY = "preview";

    private static final String FONT_SIZE_KEY = "font_size";

    private static final String DISPLAY_SIZE_KEY = "display_size";

    private static final long MIN_COMMIT_INTERVAL_MS = 800;

    private static final long CHANGE_BY_SEEKBAR_DELAY_MS = 100;

    private static final long CHANGE_BY_BUTTON_DELAY_MS = 300;

    private final FontSizeData mFontSizeData;

    private final DisplaySizeData mDisplaySizeData;

    private int mLastFontProgress;

    private int mLastDisplayProgress;

    private long mLastCommitTime;

    private TextReadingPreviewPreference mPreviewPreference;

    private LabeledSeekBarPreference mFontSizePreference;

    private LabeledSeekBarPreference mDisplaySizePreference;



    private final Choreographer.FrameCallback mCommit = f -> {

        tryCommitFontSizeConfig();

        tryCommitDisplaySizeConfig();



        mLastCommitTime = SystemClock.elapsedRealtime();

    };



    TextReadingPreviewController(Context context, String preferenceKey,

            @NonNull FontSizeData fontSizeData, @NonNull DisplaySizeData displaySizeData) {

        super(context, preferenceKey);

        mFontSizeData = fontSizeData;

        mDisplaySizeData = displaySizeData;

    }



    @Override

    public int getAvailabilityStatus() {

        return AVAILABLE;

    }



    @Override

    public void displayPreference(PreferenceScreen screen) {

        super.displayPreference(screen);



        mPreviewPreference = screen.findPreference(PREVIEW_KEY);



        mFontSizePreference = screen.findPreference(FONT_SIZE_KEY);

        mDisplaySizePreference = screen.findPreference(DISPLAY_SIZE_KEY);

        Objects.requireNonNull(mFontSizePreference,

                /* message= */ "Font size preference is null, the preview controller "

                        + "couldn't get the info");

        Objects.requireNonNull(mDisplaySizePreference,

                /* message= */ "Display size preference is null, the preview controller"

                        + " couldn't get the info");



        mLastFontProgress = mFontSizePreference.getProgress();

        mLastDisplayProgress = mDisplaySizePreference.getProgress();



        final Configuration origConfig = mContext.getResources().getConfiguration();

        final boolean isLayoutRtl =

                origConfig.getLayoutDirection() == View.LAYOUT_DIRECTION_RTL;

        final PreviewPagerAdapter pagerAdapter = new PreviewPagerAdapter(mContext, isLayoutRtl,

                PREVIEW_SAMPLE_RES_IDS, createConfig(origConfig));

        mPreviewPreference.setPreviewAdapter(pagerAdapter);

        pagerAdapter.setPreviewLayer(/* newLayerIndex= */ 0,

                /* currentLayerIndex= */ 0,

                /* currentFrameIndex= */ 0, /* animate= */ false);

    }



    @Override

    public void notifyPreferenceChanged() {

        final int displayDataSize = mDisplaySizeData.getValues().size();

        final int fontSizeProgress = mFontSizePreference.getProgress();

        final int displaySizeProgress = mDisplaySizePreference.getProgress();



        // To be consistent with the

        // {@link PreviewPagerAdapter#setPreviewLayer(int, int, int, boolean)} behavior,

        // here also needs the same design. In addition, please also refer to

        // the {@link #createConfig(Configuration)}.

        final int pagerIndex = fontSizeProgress * displayDataSize + displaySizeProgress;



        mPreviewPreference.notifyPreviewPagerChanged(pagerIndex);

    }



    @Override

    public void onProgressChanged() {

        postCommitDelayed(CHANGE_BY_BUTTON_DELAY_MS);

    }



    @Override

    public void onEndTrackingTouch() {

        postCommitDelayed(CHANGE_BY_SEEKBAR_DELAY_MS);

    }



    /**

     * Avoids the flicker when switching to the previous or next level.

     *

     * <p><br>[Flickering problem steps] commit()-> snapshot in framework(old screenshot) ->

     * app update the preview -> snapshot(old screen) fade out</p>

     *

     * <p><br>To prevent flickering problem, we make sure that we update the local preview

     * first and then we do the commit later. </p>

     *

     * <p><br><b>Note:</b> It doesn't matter that we use

     * Choreographer or main thread handler since the delay time is longer

     * than 1 frame. Use Choreographer to let developer understand it's a

     * window update.</p>

     *

     * @param commitDelayMs the interval time after a action.

     */

    void postCommitDelayed(long commitDelayMs) {

        if (SystemClock.elapsedRealtime() - mLastCommitTime < MIN_COMMIT_INTERVAL_MS) {

            commitDelayMs += MIN_COMMIT_INTERVAL_MS;

        }



        final Choreographer choreographer = Choreographer.getInstance();

        choreographer.removeFrameCallback(mCommit);

        choreographer.postFrameCallbackDelayed(mCommit, commitDelayMs);

    }



    private void tryCommitFontSizeConfig() {

        final int fontProgress = mFontSizePreference.getProgress();

        if (fontProgress != mLastFontProgress) {

            mFontSizeData.commit(fontProgress);

            mLastFontProgress = fontProgress;

        }

    }



    private void tryCommitDisplaySizeConfig() {

        final int displayProgress = mDisplaySizePreference.getProgress();

        if (displayProgress != mLastDisplayProgress) {

            mDisplaySizeData.commit(displayProgress);

            mLastDisplayProgress = displayProgress;

        }

    }



    private Configuration[] createConfig(Configuration origConfig) {

        final int fontDataSize = mFontSizeData.getValues().size();

        final int displayDataSize = mDisplaySizeData.getValues().size();

        final int totalNum = fontDataSize * displayDataSize;

        final Configuration[] configurations = new Configuration[totalNum];



        for (int i = 0; i < fontDataSize; ++i) {

            for (int j = 0; j < displayDataSize; ++j) {

                final Configuration config = new Configuration(origConfig);

                config.fontScale = mFontSizeData.getValues().get(i);

                config.densityDpi = mDisplaySizeData.getValues().get(j);



                configurations[i * displayDataSize + j] = config;

            }

        }



        return configurations;

    }

}

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

+15 −2
Original line number Diff line number Diff line
@@ -32,8 +32,9 @@ import com.android.settings.widget.DotsPageIndicator; 
/**

 * A {@link Preference} that could show the preview related to the text and reading options.

 */

final class TextReadingPreviewPreference extends Preference {

public class TextReadingPreviewPreference extends Preference {

    private int mCurrentItem;

    private int mLastLayerIndex;

    private PreviewPagerAdapter mPreviewAdapter;



    TextReadingPreviewPreference(Context context) {
@@ -41,7 +42,7 @@ final class TextReadingPreviewPreference extends Preference { 
        init();

    }



    TextReadingPreviewPreference(Context context, AttributeSet attrs) {

    public TextReadingPreviewPreference(Context context, AttributeSet attrs) {

        super(context, attrs);

        init();

    }
@@ -120,4 +121,16 @@ final class TextReadingPreviewPreference extends Preference { 
    private void init() {

        setLayoutResource(R.layout.accessibility_text_reading_preview);

    }



    void notifyPreviewPagerChanged(int pagerIndex) {

        Preconditions.checkNotNull(mPreviewAdapter,

                "Preview adapter is null, you should init the preview adapter first");



        if (pagerIndex != mLastLayerIndex) {

            mPreviewAdapter.setPreviewLayer(pagerIndex, mLastLayerIndex, getCurrentItem(),

                    /* animate= */ false);

        }



        mLastLayerIndex = pagerIndex;

    }

}

src/com/android/settings/display/PreviewPagerAdapter.java

+9 −1
Original line number Diff line number Diff line
@@ -117,7 +117,15 @@ public class PreviewPagerAdapter extends PagerAdapter { 
        mAnimationEndAction = action;

    }



    void setPreviewLayer(int newLayerIndex, int currentLayerIndex, int currentFrameIndex,

    /**

     * Switches the sample layouts for the preview pager.

     *

     * @param newLayerIndex the new layer index

     * @param currentLayerIndex the current layer index

     * @param currentFrameIndex the current frame index

     * @param animate whether to enable the animation

     */

    public void setPreviewLayer(int newLayerIndex, int currentLayerIndex, int currentFrameIndex,

            final boolean animate) {

        for (FrameLayout previewFrame : mPreviewFrames) {

            if (currentLayerIndex >= 0) {