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

Commit 25370f02 authored by Austin Tankiang's avatar Austin Tankiang
Browse files

Add expand/collapse functionality to progress items 

The expanded state of the item needs to be tracked in the list managed
by the recycler view because that state needs to be preserved even after
view holders get recycled.

Bug: 400352342
Test: atest -c 'DocumentsUIGoogleTests:com.android.documentsui.JobPanelUiTest'
Flag: com.android.documentsui.flags.visual_signals_ro

Change-Id: Ie149346122862ba85589a7c003eb997b89704054
parent 53782538

res/flag(com.android.documentsui.flags.use_material3)/drawable/ic_job_progress_collapse.xml

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

<!--

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

  -->

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

    android:width="20dp"

    android:height="20dp"

    android:viewportWidth="960"

    android:viewportHeight="960">

    <path

        android:fillColor="@android:color/white"

        android:pathData="M480,453.09L291,642.09L221.91,573L480,314.91L738.09,573L669,642.09L480,453.09Z"/>

</vector>

res/flag(com.android.documentsui.flags.use_material3)/drawable/ic_job_progress_expand.xml

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

<!--

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

  -->

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

    android:width="20dp"

    android:height="20dp"

    android:viewportWidth="960"

    android:viewportHeight="960">

    <path

        android:fillColor="@android:color/white"

        android:pathData="M480,645.09L221.91,387L291,317.91L480,506.91L669,317.91L738.09,387L480,645.09Z"/>

</vector>

res/flag(com.android.documentsui.flags.use_material3)/layout/job_progress_item.xml

+5 −3
Original line number Diff line number Diff line
@@ -53,12 +53,14 @@ 


        <com.google.android.material.progressindicator.LinearProgressIndicator

            android:id="@+id/job_progress_item_progress"

            style="@style/JobProgressItemProgressStyle"

            android:layout_width="0dp"

            android:layout_height="wrap_content"

            android:layout_marginTop="@dimen/job_progress_item_progress_margin_top"

            app:layout_constraintStart_toStartOf="@id/job_progress_item_title"

            app:layout_constraintEnd_toEndOf="@id/job_progress_item_expand"

            app:layout_constraintTop_toBottomOf="@id/job_progress_item_header_barrier" />

            app:layout_constraintTop_toBottomOf="@id/job_progress_item_header_barrier"

            app:layout_constraintHorizontal_bias="0" />

        <com.google.android.material.textview.MaterialTextView

            android:id="@+id/job_progress_item_primary_status"

            android:layout_width="wrap_content"
@@ -89,14 +91,14 @@ 
            android:layout_width="wrap_content"

            android:layout_height="@dimen/job_progress_item_padding"

            app:layout_constraintStart_toStartOf="parent"

            app:layout_constraintTop_toBottomOf="@id/job_progress_item_secondary_status" />

            app:layout_constraintTop_toBottomOf="@id/job_progress_item_primary_status" />

        <!-- Used to provide a consistent margin regardless of which button is displayed. -->

        <Space

            android:id="@+id/job_progress_item_button_margin"

            android:layout_width="@dimen/job_progress_item_buttons_margin_start"

            android:layout_height="@dimen/job_progress_item_buttons_margin_top"

            app:layout_constraintStart_toStartOf="parent"

            app:layout_constraintTop_toBottomOf="@id/job_progress_item_secondary_status" />

            app:layout_constraintTop_toBottomOf="@id/job_progress_item_primary_status" />

        <com.google.android.material.button.MaterialButton

            android:id="@+id/job_progress_item_cancel"

            style="@style/JobProgressItemActionButtonStyle"

res/flag(com.android.documentsui.flags.use_material3)/values/styles.xml

+5 −0
Original line number Diff line number Diff line
@@ -246,6 +246,7 @@ 
        <item name="android:paddingHorizontal">6dp</item>

        <item name="android:paddingVertical">1dp</item>

        <item name="backgroundTint">?attr/colorSurfaceBright</item>

        <item name="icon">@drawable/ic_job_progress_expand</item>

        <item name="iconSize">16dp</item>

        <item name="iconTint">?attr/colorOnSurface</item>

        <item name="shapeAppearance">@style/ShapeAppearance.Material3.Corner.Full</item>
@@ -256,6 +257,10 @@ 
        <item name="android:textAppearance">@style/JobProgressItemActionButtonText</item>

    </style>



    <style name="JobProgressItemProgressStyle" parent="@style/Widget.Material3.LinearProgressIndicator">

        <item name="android:paddingTop">4dp</item>

        <item name="android:paddingBottom">4dp</item>

    </style>



    <style name="BannerStyle" parent="@style/Widget.Material3.CardView.Filled">

        <item name="android:layout_marginTop">16dp</item>

src/com/android/documentsui/JobPanelController.kt

+111 −51
Original line number Diff line number Diff line
@@ -30,6 +30,8 @@ import android.widget.Button 
import android.widget.PopupWindow

import android.widget.ProgressBar

import android.widget.TextView

import androidx.core.view.isGone

import androidx.core.view.isVisible

import androidx.recyclerview.widget.DiffUtil

import androidx.recyclerview.widget.LinearLayoutManager

import androidx.recyclerview.widget.ListAdapter
@@ -40,6 +42,7 @@ import com.android.documentsui.services.FileOperationService.EXTRA_PROGRESS 
import com.android.documentsui.services.Job

import com.android.documentsui.services.JobProgress

import com.android.documentsui.util.FormatUtils

import com.google.android.material.button.MaterialButton

import com.google.android.material.card.MaterialCardView

import com.google.android.material.progressindicator.LinearProgressIndicator

import com.google.android.material.shape.ShapeAppearanceModel
@@ -72,68 +75,115 @@ class JobPanelController(private val mContext: Context) : BroadcastReceiver() { 
        private const val MAX_PROGRESS = 100

    }



    class ProgressItemHolder(val mController: JobPanelController, view: View) :

        RecyclerView.ViewHolder(view) {

    data class ProgressViewModel(val jobProgress: JobProgress, val expanded: Boolean = false)



        val mContext = view.context

    private class ProgressItemHolder(

        private val controller: JobPanelController,

        private val cardView: View,

        ) : RecyclerView.ViewHolder(cardView) {



        val mTitleView = view.findViewById<TextView>(R.id.job_progress_item_title)

        val mProgressView =

            view.findViewById<LinearProgressIndicator>(R.id.job_progress_item_progress)

        val mPrimaryStatusView = view.findViewById<TextView>(R.id.job_progress_item_primary_status)

        val mSecondaryStatusView =

            view.findViewById<TextView>(R.id.job_progress_item_secondary_status)

        private val context = cardView.context



        val mDismissButton = view.findViewById<Button>(R.id.job_progress_item_dismiss)

        // Header elements.

        private val titleView = cardView.findViewById<TextView>(R.id.job_progress_item_title)

        private val toggleExpandButton =

            cardView.findViewById<MaterialButton>(R.id.job_progress_item_expand)



        fun setJobProgress(jobProgress: JobProgress) {

            mTitleView.text = jobProgress.msg

            mProgressView.isIndeterminate = jobProgress.isIndeterminate

            if (!mProgressView.isIndeterminate) {

                mProgressView.setProgress(jobProgress.toPercent().toInt())

        // Body elements.

        private val progressView =

            cardView.findViewById<LinearProgressIndicator>(R.id.job_progress_item_progress)

        private val primaryStatusView =

            cardView.findViewById<TextView>(R.id.job_progress_item_primary_status)

        private val statusSeparator =

            cardView.findViewById<TextView>(R.id.job_progress_item_status_separator)

        private val secondaryStatusView =

            cardView.findViewById<TextView>(R.id.job_progress_item_secondary_status)



        // Buttons

        private val cancelButton = cardView.findViewById<Button>(R.id.job_progress_item_cancel)

        private val showInFolderButton =

            cardView.findViewById<Button>(R.id.job_progress_item_show_in_folder)

        private val dismissButton = cardView.findViewById<Button>(R.id.job_progress_item_dismiss)



        fun setJobProgress(jobProgress: JobProgress, expanded: Boolean) {

            titleView.text = jobProgress.msg

            toggleExpandButton.icon = context.getDrawable(when (expanded) {

                true -> R.drawable.ic_job_progress_collapse

                false -> R.drawable.ic_job_progress_expand

            })



            updateProgressBar(jobProgress)

            setStatusText(jobProgress, expanded)



            cardView.setOnClickListener { controller.toggleExpanded(jobProgress.id) }

            toggleExpandButton.setOnClickListener { controller.toggleExpanded(jobProgress.id) }



            cancelButton.isVisible = expanded && !jobProgress.isFinal

            showInFolderButton.isVisible = expanded && jobProgress.isFinal

            dismissButton.isVisible = expanded && jobProgress.isFinal

            dismissButton.setOnClickListener { controller.dismissProgress(jobProgress.id) }

        }



        private fun updateProgressBar(jobProgress: JobProgress) {

            progressView.let {

                it.isGone = jobProgress.isFinal

                it.isIndeterminate = jobProgress.isIndeterminate

                if (!it.isIndeterminate) {

                    it.progress = jobProgress.toPercent().toInt()

                }

            }

        }



        private fun setStatusText(jobProgress: JobProgress, expanded: Boolean) {

            primaryStatusView.isGone = false

            secondaryStatusView.isGone = false

            if (jobProgress.state == Job.STATE_COMPLETED) {

                if (jobProgress.hasFailures) {

                    mPrimaryStatusView.setTextAppearance(R.style.JobProgressItemStatusText_Failure)

                    mPrimaryStatusView.text = mContext.getString(R.string.job_progress_item_failed)

                    mSecondaryStatusView.text =

                        mContext.getString(R.string.job_progress_item_see_details)

                } else {

                    mPrimaryStatusView.setTextAppearance(R.style.JobProgressItemStatusText_Success)

                    mPrimaryStatusView.text =

                        mContext.getString(R.string.job_progress_item_completed)

                    mSecondaryStatusView.text = getCompletionStatusString(jobProgress.operationType)

                }

                    primaryStatusView.setTextAppearance(R.style.JobProgressItemStatusText_Failure)

                    primaryStatusView.text = context.getString(R.string.job_progress_item_failed)

                    secondaryStatusView.isGone = expanded

                    secondaryStatusView.text =

                        context.getString(R.string.job_progress_item_see_details)

                } else {

                mPrimaryStatusView.setTextAppearance(R.style.JobProgressItemStatusText)

                mPrimaryStatusView.text = mContext.getString(

                    primaryStatusView.setTextAppearance(R.style.JobProgressItemStatusText_Success)

                    primaryStatusView.text =

                        context.getString(R.string.job_progress_item_completed)

                    secondaryStatusView.text = getCompletionStatusString(jobProgress.operationType)

                }

            } else if (expanded && jobProgress.state == Job.STATE_SET_UP &&

                !jobProgress.isIndeterminate) {

                primaryStatusView.setTextAppearance(R.style.JobProgressItemStatusText)

                primaryStatusView.text = context.getString(

                    R.string.job_progress_item_byte_progress,

                    Formatter.formatFileSize(mContext, jobProgress.currentBytes),

                    Formatter.formatFileSize(mContext, jobProgress.requiredBytes),

                    Formatter.formatFileSize(context, jobProgress.currentBytes),

                    Formatter.formatFileSize(context, jobProgress.requiredBytes),

                )

                mSecondaryStatusView.text = mContext.getString(R.string.copy_remaining,

                secondaryStatusView.text = context.getString(R.string.copy_remaining,

                    FormatUtils.formatDuration(jobProgress.msRemaining))

            } else {

                primaryStatusView.isGone = true

                secondaryStatusView.isGone = true

            }

            mDismissButton.setOnClickListener { mController.dismissProgress(jobProgress.id) }

            statusSeparator.isGone = primaryStatusView.isGone || secondaryStatusView.isGone

        }



        private fun getCompletionStatusString(@FileOperationService.OpType opType: Int): String {

            return when (opType) {

                FileOperationService.OPERATION_COPY -> mContext.getString(R.string.copy_completed)

                FileOperationService.OPERATION_MOVE -> mContext.getString(R.string.move_completed)

                FileOperationService.OPERATION_COPY -> context.getString(R.string.copy_completed)

                FileOperationService.OPERATION_MOVE -> context.getString(R.string.move_completed)

                FileOperationService.OPERATION_DELETE ->

                    mContext.getString(R.string.delete_completed)

                    context.getString(R.string.delete_completed)

                FileOperationService.OPERATION_COMPRESS ->

                    mContext.getString(R.string.compress_completed)

                    context.getString(R.string.compress_completed)

                FileOperationService.OPERATION_EXTRACT ->

                    mContext.getString(R.string.extract_completed)

                    context.getString(R.string.extract_completed)

                else -> ""

            }

        }

    }



    class ProgressListAdapter(val mController: JobPanelController) :

        ListAdapter<JobProgress, ProgressItemHolder>(JobDiffCallback) {

    private class ProgressListAdapter(private val controller: JobPanelController) :

        ListAdapter<ProgressViewModel, ProgressItemHolder>(JobDiffCallback) {



        companion object {

            // Constants for the different view types created by this adapter. The type depends on
@@ -171,21 +221,22 @@ class JobPanelController(private val mContext: Context) : BroadcastReceiver() { 
                        }

                    }.build()

            }

            return ProgressItemHolder(mController, view)

            return ProgressItemHolder(controller, view)

        }



        override fun onBindViewHolder(holder: ProgressItemHolder, position: Int) {

            holder.setJobProgress(getItem(position))

            val (jobProgress, expanded) = getItem(position)

            holder.setJobProgress(jobProgress, expanded)

        }



        object JobDiffCallback : DiffUtil.ItemCallback<JobProgress>() {

            override fun areItemsTheSame(oldJobProgress: JobProgress, newJobProgress: JobProgress) =

                oldJobProgress.id == newJobProgress.id

        object JobDiffCallback : DiffUtil.ItemCallback<ProgressViewModel>() {

            override fun areItemsTheSame(oldModel: ProgressViewModel, newModel: ProgressViewModel) =

                oldModel.jobProgress.id == newModel.jobProgress.id



            override fun areContentsTheSame(

                oldJobProgress: JobProgress,

                newJobProgress: JobProgress

            ) = oldJobProgress == newJobProgress

                oldModel: ProgressViewModel,

                newModel: ProgressViewModel

            ) = oldModel == newModel

        }

    }
@@ -200,7 +251,7 @@ class JobPanelController(private val mContext: Context) : BroadcastReceiver() { 
    private var mTotalProgress = 0



    /** List of jobs currently tracked by this class. */

    private val mCurrentJobs = LinkedHashMap<String, JobProgress>()

    private val mCurrentJobs = LinkedHashMap<String, ProgressViewModel>()



    /** Current menu item being controlled by this class. */

    private var mMenuItem: MenuItem? = null
@@ -293,9 +344,11 @@ class JobPanelController(private val mContext: Context) : BroadcastReceiver() { 


        for (jobProgress in progresses) {

            Log.d(TAG, "Received $jobProgress")

            mCurrentJobs.put(jobProgress.id, jobProgress)

            mCurrentJobs.merge(jobProgress.id, ProgressViewModel(jobProgress)) {

                old, new -> ProgressViewModel(new.jobProgress, old.expanded)

            }

        }

        for (jobProgress in mCurrentJobs.values) {

        for ((jobProgress, _) in mCurrentJobs.values) {

            if (jobProgress.state != Job.STATE_COMPLETED) {

                allFinished = false

            }
@@ -324,4 +377,11 @@ class JobPanelController(private val mContext: Context) : BroadcastReceiver() { 
        mCurrentJobs.remove(id)

        updateProgress(emptyList())

    }



    private fun toggleExpanded(id: String) {

        mCurrentJobs.computeIfPresent(id) { _, (jobProgress, expanded) ->

            ProgressViewModel(jobProgress, !expanded)

        }

        mProgressListAdapter?.submitList(ArrayList(mCurrentJobs.values))

    }

}