Offline Pages : PageList Item Progress State

WordPress/src/main/java/org/wordpress/android/ui/pages/PageItem.kt

@@ -12,6 +12,7 @@ import org.wordpress.android.ui.pages.PageItem.Action.VIEW_PAGE
 import org.wordpress.android.ui.pages.PageItem.Type.DIVIDER
 import org.wordpress.android.ui.pages.PageItem.Type.EMPTY
 import org.wordpress.android.ui.pages.PageItem.Type.PAGE
+import org.wordpress.android.viewmodel.uistate.ProgressBarUiState
 import java.util.Date
 
 sealed class PageItem(open val type: Type) {
@@ -24,7 +25,9 @@ sealed class PageItem(open val type: Type) {
         open var imageUrl: String?,
         open val actions: Set<Action>,
         open var actionsEnabled: Boolean,
-        open val tapActionEnabled: Boolean
+        open val tapActionEnabled: Boolean,
+        open val progressBarUiState: ProgressBarUiState,
+        open val showOverlay: Boolean
     ) : PageItem(PAGE)
 
     data class PublishedPage(
@@ -34,7 +37,9 @@ sealed class PageItem(open val type: Type) {
         override val labels: List<Int> = emptyList(),
         override var indent: Int = 0,
         override var imageUrl: String? = null,
-        override var actionsEnabled: Boolean = true
+        override var actionsEnabled: Boolean = true,
+        override val progressBarUiState: ProgressBarUiState,
+        override val showOverlay: Boolean
     ) : Page(
             id = id,
             title = title,
@@ -44,7 +49,9 @@ sealed class PageItem(open val type: Type) {
             imageUrl = imageUrl,
             actions = setOf(VIEW_PAGE, SET_PARENT, MOVE_TO_DRAFT, MOVE_TO_TRASH),
             actionsEnabled = actionsEnabled,
-            tapActionEnabled = true
+            tapActionEnabled = true,
+            progressBarUiState = progressBarUiState,
+            showOverlay = showOverlay
     )
 
     data class DraftPage(
@@ -53,7 +60,9 @@ sealed class PageItem(open val type: Type) {
         override val date: Date,
         override val labels: List<Int> = emptyList(),
         override var imageUrl: String? = null,
-        override var actionsEnabled: Boolean = true
+        override var actionsEnabled: Boolean = true,
+        override val progressBarUiState: ProgressBarUiState,
+        override val showOverlay: Boolean
     ) : Page(
             id = id,
             title = title,
@@ -63,7 +72,9 @@ sealed class PageItem(open val type: Type) {
             imageUrl = imageUrl,
             actions = setOf(VIEW_PAGE, SET_PARENT, PUBLISH_NOW, MOVE_TO_TRASH),
             actionsEnabled = actionsEnabled,
-            tapActionEnabled = true
+            tapActionEnabled = true,
+            progressBarUiState = progressBarUiState,
+            showOverlay = showOverlay
     )
 
     data class ScheduledPage(
@@ -72,7 +83,9 @@ sealed class PageItem(open val type: Type) {
         override val date: Date,
         override val labels: List<Int> = emptyList(),
         override var imageUrl: String? = null,
-        override var actionsEnabled: Boolean = true
+        override var actionsEnabled: Boolean = true,
+        override val progressBarUiState: ProgressBarUiState,
+        override val showOverlay: Boolean
     ) : Page(
             id = id,
             title = title,
@@ -82,15 +95,19 @@ sealed class PageItem(open val type: Type) {
             imageUrl = imageUrl,
             actions = setOf(VIEW_PAGE, SET_PARENT, MOVE_TO_DRAFT, MOVE_TO_TRASH),
             actionsEnabled = actionsEnabled,
-            tapActionEnabled = true
+            tapActionEnabled = true,
+            progressBarUiState = progressBarUiState,
+            showOverlay = showOverlay
     )
 
     data class TrashedPage(
         override val id: Long,
         override val title: String,
         override val date: Date,
         override var imageUrl: String? = null,
-        override var actionsEnabled: Boolean = true
+        override var actionsEnabled: Boolean = true,
+        override val progressBarUiState: ProgressBarUiState,
+        override val showOverlay: Boolean
     ) : Page(
             id = id,
             title = title,
@@ -100,7 +117,9 @@ sealed class PageItem(open val type: Type) {
             imageUrl = imageUrl,
             actions = setOf(MOVE_TO_DRAFT, DELETE_PERMANENTLY),
             actionsEnabled = actionsEnabled,
-            tapActionEnabled = false
+            tapActionEnabled = false,
+            progressBarUiState = progressBarUiState,
+            showOverlay = showOverlay
     )
 
     data class ParentPage(

WordPress/src/main/java/org/wordpress/android/ui/pages/PageItemDiffUtil.kt

@@ -3,6 +3,7 @@ package org.wordpress.android.ui.pages
 import androidx.recyclerview.widget.DiffUtil.Callback
 import org.wordpress.android.ui.pages.PageItem.Page
 import org.wordpress.android.ui.pages.PageItem.ParentPage
+import org.wordpress.android.viewmodel.uistate.ProgressBarUiState.Determinate
 
 class PageItemDiffUtil(val items: List<PageItem>, val result: List<PageItem>) : Callback() {
     override fun areItemsTheSame(oldItemPosition: Int, newItemPosition: Int): Boolean {
@@ -22,4 +23,25 @@ class PageItemDiffUtil(val items: List<PageItem>, val result: List<PageItem>) :
     override fun areContentsTheSame(oldItemPosition: Int, newItemPosition: Int): Boolean {
         return items[oldItemPosition] == result[newItemPosition]
     }
+
+    override fun getChangePayload(oldItemPosition: Int, newItemPosition: Int): Any? {
+        val oldItem = items[oldItemPosition]
+        val newItem = result[newItemPosition]
+
+        if (oldItem is Page && newItem is Page) {
+            /**
+             * Suppresses the default animation if the progress has changed to prevent blinking as the upload progresses
+             *
+             * We don't need to use the payload in onBindViewHolder unless we want to. Passing a non-null value
+             * suppresses the default ItemAnimator, which is all we need in this case.
+             */
+            if (oldItem.progressBarUiState is Determinate &&
+                    newItem.progressBarUiState is Determinate &&
+                    (oldItem.progressBarUiState as Determinate).progress !=
+                    (newItem.progressBarUiState as Determinate).progress) {
+                return true
+            }
+        }
+        return super.getChangePayload(oldItemPosition, newItemPosition)
+    }
 }

WordPress/src/main/java/org/wordpress/android/ui/pages/PageItemViewHolder.kt

@@ -4,10 +4,12 @@ import android.graphics.drawable.Drawable
 import android.view.LayoutInflater
 import android.view.View
 import android.view.ViewGroup
+import android.widget.FrameLayout
 import android.widget.ImageButton
 import android.widget.ImageView
 import android.widget.ImageView.ScaleType
 import android.widget.PopupMenu
+import android.widget.ProgressBar
 import android.widget.RadioButton
 import android.widget.TextView
 import androidx.annotation.LayoutRes
@@ -20,14 +22,18 @@ import org.wordpress.android.ui.pages.PageItem.Empty
 import org.wordpress.android.ui.pages.PageItem.Page
 import org.wordpress.android.ui.pages.PageItem.ParentPage
 import org.wordpress.android.ui.reader.utils.ReaderUtils
-import org.wordpress.android.util.currentLocale
+import org.wordpress.android.ui.utils.UiHelpers
 import org.wordpress.android.util.DateTimeUtils
 import org.wordpress.android.util.DisplayUtils
 import org.wordpress.android.util.ImageUtils
 import org.wordpress.android.util.capitalizeWithLocaleWithoutLint
+import org.wordpress.android.util.currentLocale
 import org.wordpress.android.util.getDrawableFromAttribute
 import org.wordpress.android.util.image.ImageManager
 import org.wordpress.android.util.image.ImageType
+import org.wordpress.android.viewmodel.uistate.ProgressBarUiState
+import org.wordpress.android.viewmodel.uistate.ProgressBarUiState.Determinate
+import org.wordpress.android.viewmodel.uistate.ProgressBarUiState.Indeterminate
 import java.util.Date
 
 sealed class PageItemViewHolder(internal val parent: ViewGroup, @LayoutRes layout: Int) :
@@ -39,13 +45,16 @@ sealed class PageItemViewHolder(internal val parent: ViewGroup, @LayoutRes layou
         private val onMenuAction: (PageItem.Action, Page) -> Boolean,
         private val onItemTapped: (Page) -> Unit,
         private val imageManager: ImageManager? = null,
-        private val isSitePhotonCapable: Boolean = false
+        private val isSitePhotonCapable: Boolean = false,
+        private val uiHelper: UiHelpers
     ) : PageItemViewHolder(parentView, R.layout.page_list_item) {
         private val pageTitle = itemView.findViewById<TextView>(R.id.page_title)
         private val pageMore = itemView.findViewById<ImageButton>(R.id.page_more)
         private val time = itemView.findViewById<TextView>(R.id.time_posted)
         private val labels = itemView.findViewById<TextView>(R.id.labels)
         private val featuredImage = itemView.findViewById<ImageView>(R.id.featured_image)
+        private val uploadProgressBar: ProgressBar = itemView.findViewById(R.id.upload_progress)
+        private val disabledOverlay: FrameLayout = itemView.findViewById(R.id.disabled_overlay)
         private val pageItemContainer = itemView.findViewById<ViewGroup>(R.id.page_item)
         private val pageLayout = itemView.findViewById<ViewGroup>(R.id.page_layout)
         private val selectableBackground: Drawable? = parent.context.getDrawableFromAttribute(
@@ -86,6 +95,20 @@ sealed class PageItemViewHolder(internal val parent: ViewGroup, @LayoutRes layou
 
                 setBackground(page.tapActionEnabled)
                 showFeaturedImage(page.imageUrl)
+
+                uiHelper.updateVisibility(disabledOverlay, page.showOverlay)
+                updateProgressBarState(page.progressBarUiState)
+            }
+        }
+
+        private fun updateProgressBarState(progressBarUiState: ProgressBarUiState) {
+            uiHelper.updateVisibility(uploadProgressBar, progressBarUiState.visibility)
+            when (progressBarUiState) {
+                Indeterminate -> uploadProgressBar.isIndeterminate = true
+                is Determinate -> {
+                    uploadProgressBar.isIndeterminate = false
+                    uploadProgressBar.progress = progressBarUiState.progress
+                }
             }
         }
 

WordPress/src/main/java/org/wordpress/android/ui/pages/PageListAdapter.kt

@@ -7,21 +7,23 @@ import org.wordpress.android.ui.pages.PageItem.Page
 import org.wordpress.android.ui.pages.PageItemViewHolder.EmptyViewHolder
 import org.wordpress.android.ui.pages.PageItemViewHolder.PageDividerViewHolder
 import org.wordpress.android.ui.pages.PageItemViewHolder.PageViewHolder
+import org.wordpress.android.ui.utils.UiHelpers
 import org.wordpress.android.util.image.ImageManager
 
 class PageListAdapter(
     private val onMenuAction: (PageItem.Action, Page) -> Boolean,
     private val onItemTapped: (Page) -> Unit,
     private val onEmptyActionButtonTapped: () -> Unit,
     private val isSitePhotonCapable: Boolean,
-    private val imageManager: ImageManager
+    private val imageManager: ImageManager,
+    private val uiHelpers: UiHelpers
 ) : Adapter<PageItemViewHolder>() {
     private val items = mutableListOf<PageItem>()
 
     override fun onCreateViewHolder(parent: ViewGroup, viewType: Int): PageItemViewHolder {
         return when (viewType) {
             PageItem.Type.PAGE.viewType -> PageViewHolder(parent, onMenuAction, onItemTapped, imageManager,
-                    isSitePhotonCapable)
+                    isSitePhotonCapable, uiHelpers)
             PageItem.Type.DIVIDER.viewType -> PageDividerViewHolder(parent)
             PageItem.Type.EMPTY.viewType -> EmptyViewHolder(parent, onEmptyActionButtonTapped)
             else -> throw Throwable("Unexpected view type")

WordPress/src/main/java/org/wordpress/android/ui/pages/PageListFragment.kt

@@ -15,6 +15,7 @@ import androidx.recyclerview.widget.RecyclerView
 import kotlinx.android.synthetic.main.pages_list_fragment.*
 import org.wordpress.android.R
 import org.wordpress.android.WordPress
+import org.wordpress.android.ui.utils.UiHelpers
 import org.wordpress.android.util.DisplayUtils
 import org.wordpress.android.util.image.ImageManager
 import org.wordpress.android.viewmodel.pages.PageListViewModel
@@ -26,6 +27,7 @@ import javax.inject.Inject
 class PageListFragment : Fragment() {
     @Inject lateinit var viewModelFactory: ViewModelProvider.Factory
     @Inject internal lateinit var imageManager: ImageManager
+    @Inject internal lateinit var uiHelper: UiHelpers
     private lateinit var viewModel: PageListViewModel
     private var linearLayoutManager: LinearLayoutManager? = null
 
@@ -107,7 +109,8 @@ class PageListFragment : Fragment() {
                     { page -> viewModel.onItemTapped(page) },
                     { viewModel.onEmptyListNewPageButtonTapped() },
                     isSitePhotonCapable,
-                    imageManager
+                    imageManager,
+                    uiHelper
             )
             recyclerView.adapter = adapter
         } else {

WordPress/src/main/java/org/wordpress/android/ui/pages/PageSearchAdapter.kt

@@ -7,16 +7,18 @@ import org.wordpress.android.ui.pages.PageItem.Page
 import org.wordpress.android.ui.pages.PageItemViewHolder.EmptyViewHolder
 import org.wordpress.android.ui.pages.PageItemViewHolder.PageDividerViewHolder
 import org.wordpress.android.ui.pages.PageItemViewHolder.PageViewHolder
+import org.wordpress.android.ui.utils.UiHelpers
 
 class PageSearchAdapter(
     private val onMenuAction: (PageItem.Action, Page) -> Boolean,
-    private val onItemTapped: (Page) -> Unit
+    private val onItemTapped: (Page) -> Unit,
+    private val uiHelper: UiHelpers
 ) : Adapter<PageItemViewHolder>() {
     private val items = mutableListOf<PageItem>()
 
     override fun onCreateViewHolder(parent: ViewGroup, viewType: Int): PageItemViewHolder {
         return when (viewType) {
-            PageItem.Type.PAGE.viewType -> PageViewHolder(parent, onMenuAction, onItemTapped)
+            PageItem.Type.PAGE.viewType -> PageViewHolder(parent, onMenuAction, onItemTapped, uiHelper = uiHelper)
             PageItem.Type.DIVIDER.viewType -> PageDividerViewHolder(parent)
             PageItem.Type.EMPTY.viewType -> EmptyViewHolder(parent) { }
             else -> throw Throwable("Unexpected view type")

WordPress/src/main/java/org/wordpress/android/ui/pages/SearchListFragment.kt

@@ -15,6 +15,7 @@ import androidx.recyclerview.widget.RecyclerView
 import kotlinx.android.synthetic.main.pages_list_fragment.*
 import org.wordpress.android.R
 import org.wordpress.android.WordPress
+import org.wordpress.android.ui.utils.UiHelpers
 import org.wordpress.android.util.DisplayUtils
 import org.wordpress.android.viewmodel.pages.PagesViewModel
 import org.wordpress.android.viewmodel.pages.SearchListViewModel
@@ -25,6 +26,7 @@ class SearchListFragment : Fragment() {
     @Inject lateinit var viewModelFactory: ViewModelProvider.Factory
     private lateinit var viewModel: SearchListViewModel
     private var linearLayoutManager: LinearLayoutManager? = null
+    @Inject lateinit var uiHelper: UiHelpers
 
     private val listStateKey = "list_state"
 
@@ -86,8 +88,7 @@ class SearchListFragment : Fragment() {
         if (recyclerView.adapter == null) {
             adapter = PageSearchAdapter(
                     { action, page -> viewModel.onMenuAction(action, page) },
-                    { page -> viewModel.onItemTapped(page) }
-            )
+                    { page -> viewModel.onItemTapped(page) }, uiHelper)
             recyclerView.adapter = adapter
         } else {
             adapter = recyclerView.adapter as PageSearchAdapter

WordPress/src/main/java/org/wordpress/android/ui/posts/PostListItemViewHolder.kt

@@ -26,9 +26,9 @@ import org.wordpress.android.util.image.ImageType
 import org.wordpress.android.viewmodel.posts.PostListItemAction
 import org.wordpress.android.viewmodel.posts.PostListItemAction.MoreItem
 import org.wordpress.android.viewmodel.posts.PostListItemAction.SingleItem
-import org.wordpress.android.viewmodel.posts.PostListItemProgressBar
-import org.wordpress.android.viewmodel.posts.PostListItemProgressBar.Determinate
-import org.wordpress.android.viewmodel.posts.PostListItemProgressBar.Indeterminate
+import org.wordpress.android.viewmodel.uistate.ProgressBarUiState
+import org.wordpress.android.viewmodel.uistate.ProgressBarUiState.Determinate
+import org.wordpress.android.viewmodel.uistate.ProgressBarUiState.Indeterminate
 import org.wordpress.android.viewmodel.posts.PostListItemType.PostListItemUiState
 import org.wordpress.android.viewmodel.posts.PostListItemUiStateData
 import org.wordpress.android.widgets.PostListButton
@@ -123,7 +123,7 @@ sealed class PostListItemViewHolder(
         uiHelpers.updateVisibility(statusesTextView, data.statuses.isNotEmpty())
         updateStatusesLabel(statusesTextView, data.statuses, data.statusesDelimiter, data.statusesColor)
         showFeaturedImage(data.imageUrl)
-        updateProgressBarState(data.progressBarState)
+        updateProgressBarState(data.progressBarUiState)
         uiHelpers.updateVisibility(disabledOverlay, data.showOverlay)
         if (data.disableRippleEffect) {
             container.background = null
@@ -149,13 +149,13 @@ sealed class PostListItemViewHolder(
         menu.show()
     }
 
-    private fun updateProgressBarState(progressBarState: PostListItemProgressBar) {
-        uiHelpers.updateVisibility(uploadProgressBar, progressBarState.visibility)
-        when (progressBarState) {
+    private fun updateProgressBarState(progressBarUiState: ProgressBarUiState) {
+        uiHelpers.updateVisibility(uploadProgressBar, progressBarUiState.visibility)
+        when (progressBarUiState) {
             Indeterminate -> uploadProgressBar.isIndeterminate = true
             is Determinate -> {
                 uploadProgressBar.isIndeterminate = false
-                uploadProgressBar.progress = progressBarState.progress
+                uploadProgressBar.progress = progressBarUiState.progress
             }
         }
     }

WordPress/src/main/java/org/wordpress/android/ui/posts/PostListMainViewModel.kt

@@ -134,7 +134,7 @@ class PostListMainViewModel @Inject constructor(
     private val _searchQuery = MutableLiveData<String>()
     val searchQuery: LiveData<String> = _searchQuery
 
-    private val uploadStatusTracker = PostListUploadStatusTracker(
+    private val uploadStatusTracker = PostModelUploadStatusTracker(
             uploadStore = uploadStore,
             uploadActionUseCase = uploadActionUseCase
     )

WordPress/src/main/java/org/wordpress/android/ui/posts/PostListUploadStatusTracker.kt → WordPress/src/main/java/org/wordpress/android/ui/posts/PostModelUploadStatusTracker.kt

@@ -7,12 +7,13 @@ import org.wordpress.android.fluxc.store.UploadStore
 import org.wordpress.android.ui.uploads.UploadActionUseCase
 import org.wordpress.android.ui.uploads.UploadService
 import org.wordpress.android.viewmodel.posts.PostListItemUploadStatus
+import javax.inject.Inject
 
 /**
  * This is a temporary class to make the PostListViewModel more manageable. Please feel free to refactor it any way
  * you see fit.
  */
-class PostListUploadStatusTracker(
+class PostModelUploadStatusTracker @Inject constructor(
     private val uploadStore: UploadStore,
     private val uploadActionUseCase: UploadActionUseCase
 ) {

WordPress/src/main/java/org/wordpress/android/ui/posts/adapters/PostListAdapter.kt

@@ -18,7 +18,7 @@ import org.wordpress.android.ui.posts.PostListViewLayoutType.STANDARD
 import org.wordpress.android.ui.utils.UiHelpers
 import org.wordpress.android.util.image.ImageManager
 import org.wordpress.android.util.setVisible
-import org.wordpress.android.viewmodel.posts.PostListItemProgressBar
+import org.wordpress.android.viewmodel.uistate.ProgressBarUiState
 import org.wordpress.android.viewmodel.posts.PostListItemType
 import org.wordpress.android.viewmodel.posts.PostListItemType.EndListIndicatorItem
 import org.wordpress.android.viewmodel.posts.PostListItemType.LoadingItem
@@ -204,9 +204,9 @@ private val PostListDiffItemCallback = object : DiffUtil.ItemCallback<PostListIt
              * We don't need to use the payload in onBindViewHolder unless we want to. Passing a non-null value
              * suppresses the default ItemAnimator, which is all we need in this case.
              */
-            if (oldItem.data.progressBarState is PostListItemProgressBar.Determinate &&
-                    newItem.data.progressBarState is PostListItemProgressBar.Determinate &&
-                    oldItem.data.progressBarState.progress != newItem.data.progressBarState.progress) {
+            if (oldItem.data.progressBarUiState is ProgressBarUiState.Determinate &&
+                    newItem.data.progressBarUiState is ProgressBarUiState.Determinate &&
+                    oldItem.data.progressBarUiState.progress != newItem.data.progressBarUiState.progress) {
                 return true
             }
         }