Merge pull request #1026 from square/ray/1-component-set-dialog

1/4 `fun ComponentDialog.setContent()` replaces `ScreenOverlayDialogFactory`

Author: rjrjr

samples/containers/android/src/main/java/com/squareup/sample/container/panel/PanelOverlayDialogFactory.kt

@@ -1,42 +1,39 @@
 package com.squareup.sample.container.panel
 
-import android.app.Dialog
+import android.content.Context
 import android.graphics.Rect
+import androidx.appcompat.app.AppCompatDialog
 import com.squareup.sample.container.R
 import com.squareup.workflow1.ui.Screen
-import com.squareup.workflow1.ui.ScreenViewHolder
 import com.squareup.workflow1.ui.ViewEnvironment
 import com.squareup.workflow1.ui.WorkflowUiExperimentalApi
+import com.squareup.workflow1.ui.container.OverlayDialogFactory
 import com.squareup.workflow1.ui.container.OverlayDialogHolder
-import com.squareup.workflow1.ui.container.ScreenOverlayDialogFactory
+import com.squareup.workflow1.ui.container.asDialogHolderWithContent
 import com.squareup.workflow1.ui.container.setBounds
-import com.squareup.workflow1.ui.container.setContent
-import com.squareup.workflow1.ui.show
+import kotlin.reflect.KClass
 
 /**
  * Android support for [PanelOverlay].
  */
 @OptIn(WorkflowUiExperimentalApi::class)
-internal object PanelOverlayDialogFactory :
-  ScreenOverlayDialogFactory<Screen, PanelOverlay<Screen>>(
-    type = PanelOverlay::class
-  ) {
-  /**
-   * Forks the default implementation to apply [R.style.PanelDialog] for
-   * enter and exit animation, and to customize [bounds][OverlayDialogHolder.onUpdateBounds].
-   */
-  override fun buildDialogWithContent(
+internal object PanelOverlayDialogFactory : OverlayDialogFactory<PanelOverlay<Screen>> {
+  override val type: KClass<in PanelOverlay<Screen>> = PanelOverlay::class
+
+  override fun buildDialog(
     initialRendering: PanelOverlay<Screen>,
     initialEnvironment: ViewEnvironment,
-    content: ScreenViewHolder<Screen>
+    context: Context
   ): OverlayDialogHolder<PanelOverlay<Screen>> {
-    val dialog = Dialog(content.view.context, R.style.PanelDialog)
-    dialog.setContent(content)
+    val dialog = AppCompatDialog(context, R.style.PanelDialog)
+
+    val realHolder = dialog.asDialogHolderWithContent(initialRendering, initialEnvironment)
 
-    return OverlayDialogHolder(
-      initialEnvironment = initialEnvironment,
-      dialog = dialog,
-      onUpdateBounds = { bounds ->
+    // We replace the default onUpdateBounds function with one that gives the
+    // panel a square shape on tablets. See OverlayDialogFactory for more details
+    // on the bounds mechanism.
+    return object : OverlayDialogHolder<PanelOverlay<Screen>> by realHolder {
+      override val onUpdateBounds: ((Rect) -> Unit) = { bounds ->
         val refinedBounds: Rect = if (!dialog.context.isTablet) {
           // On a phone, fill the bounds entirely.
           bounds
@@ -62,8 +59,6 @@ internal object PanelOverlayDialogFactory :
 
         dialog.setBounds(refinedBounds)
       }
-    ) { overlayRendering, environment ->
-      content.show(overlayRendering.content, environment)
     }
   }
 }

samples/containers/hello-back-button/src/androidTest/java/com/squareup/sample/hellobackbutton/HelloBackButtonEspressoTest.kt

@@ -27,6 +27,14 @@ class HelloBackButtonEspressoTest {
     .around(IdlingDispatcherRule)
 
   @Test fun wrappedTakesPrecedence() {
+    // The root workflow (AreYouSureWorkflow) wraps its child renderings
+    // (instances of HelloBackButtonScreen) in its own BackButtonScreen,
+    // which shows the "Are you sure" dialog.
+    // That should only be in effect on the Able screen, which sets no backHandler of its
+    // own. The Baker and Charlie screens set their own backHandlers,
+    // which should take precedence over the root one. Thus, we should
+    // be able to push to Charlie and pop all the way back to Able
+    // without seeing the "Are you sure" dialog.
     onView(withId(R.id.hello_message)).apply {
       check(matches(withText("Able")))
       perform(click())

samples/containers/hello-back-button/src/main/java/com/squareup/sample/hellobackbutton/AreYouSureWorkflow.kt

@@ -68,7 +68,7 @@ object AreYouSureWorkflow :
           BackButtonScreen(ableBakerCharlie) {
             // While we always provide a back button handler, by default the view code
             // associated with BackButtonScreen ignores ours if the view created for the
-            // wrapped rendering sets a handler of its own. (Set BackButtonScreen.override
+            // wrapped rendering sets a handler of its own. (Set BackButtonScreen.shadow
             // to change this precedence.)
             context.actionSink.send(maybeQuit)
           }

samples/containers/hello-back-button/src/main/java/com/squareup/sample/hellobackbutton/HelloBackButtonScreen.kt

@@ -6,7 +6,7 @@ import com.squareup.sample.hellobackbutton.databinding.HelloBackButtonLayoutBind
 import com.squareup.workflow1.ui.AndroidScreen
 import com.squareup.workflow1.ui.ScreenViewFactory
 import com.squareup.workflow1.ui.WorkflowUiExperimentalApi
-import com.squareup.workflow1.ui.backPressedHandler
+import com.squareup.workflow1.ui.setBackHandler
 
 @OptIn(WorkflowUiExperimentalApi::class)
 data class HelloBackButtonScreen(
@@ -18,6 +18,6 @@ data class HelloBackButtonScreen(
     ScreenViewFactory.fromViewBinding(HelloBackButtonLayoutBinding::inflate) { rendering, _ ->
       helloMessage.text = rendering.message
       helloMessage.setOnClickListener { rendering.onClick() }
-      helloMessage.backPressedHandler = rendering.onBackPressed
+      helloMessage.setBackHandler(rendering.onBackPressed)
     }
 }

samples/containers/poetry/src/main/java/com/squareup/sample/poetry/StanzaListScreen.kt

@@ -1,5 +1,6 @@
 package com.squareup.sample.poetry
 
+import android.annotation.SuppressLint
 import android.view.LayoutInflater
 import android.view.View
 import android.view.ViewGroup
@@ -15,9 +16,9 @@ import com.squareup.workflow1.ui.ScreenViewFactory
 import com.squareup.workflow1.ui.ScreenViewRunner
 import com.squareup.workflow1.ui.ViewEnvironment
 import com.squareup.workflow1.ui.WorkflowUiExperimentalApi
-import com.squareup.workflow1.ui.backPressedHandler
 import com.squareup.workflow1.ui.container.BackStackConfig
 import com.squareup.workflow1.ui.container.BackStackConfig.Other
+import com.squareup.workflow1.ui.setBackHandler
 
 @OptIn(WorkflowUiExperimentalApi::class)
 data class StanzaListScreen(
@@ -40,6 +41,7 @@ private class StanzaListLayoutRunner(view: View) : ScreenViewRunner<StanzaListSc
 
   private val adapter = Adapter()
 
+  @SuppressLint("NotifyDataSetChanged")
   override fun showRendering(
     rendering: StanzaListScreen,
     environment: ViewEnvironment
@@ -53,10 +55,10 @@ private class StanzaListLayoutRunner(view: View) : ScreenViewRunner<StanzaListSc
 
     if (environment[BackStackConfig] == Other) {
       toolbar.setNavigationOnClickListener { rendering.onExit() }
-      toolbar.backPressedHandler = rendering.onExit
+      toolbar.setBackHandler(rendering.onExit)
     } else {
       toolbar.navigationIcon = null
-      toolbar.backPressedHandler = null
+      toolbar.setBackHandler {}
     }
 
     if (rendering.selection >= 0) recyclerView.scrollToPosition(rendering.selection)

samples/containers/poetry/src/main/java/com/squareup/sample/poetry/StanzaScreen.kt

@@ -17,9 +17,9 @@ import com.squareup.workflow1.ui.ScreenViewFactory
 import com.squareup.workflow1.ui.ScreenViewRunner
 import com.squareup.workflow1.ui.ViewEnvironment
 import com.squareup.workflow1.ui.WorkflowUiExperimentalApi
-import com.squareup.workflow1.ui.backPressedHandler
 import com.squareup.workflow1.ui.container.BackStackConfig
 import com.squareup.workflow1.ui.container.BackStackConfig.None
+import com.squareup.workflow1.ui.setBackHandler
 
 @OptIn(WorkflowUiExperimentalApi::class)
 data class StanzaScreen(
@@ -93,8 +93,10 @@ private class StanzaLayoutRunner(private val view: View) : ScreenViewRunner<Stan
       toolbar.navigationIcon = null
     }
 
-    view.backPressedHandler = rendering.onGoBack
+    val goBackOrUp = rendering.onGoBack
       ?: rendering.onGoUp.takeIf { environment[OverviewDetailConfig] != Detail }
+
+    view.setBackHandler(goBackOrUp)
   }
 
   private fun TextView.setTabulatedText(lines: List<String>) {

samples/dungeon/timemachine-shakeable/src/main/java/com/squareup/sample/timemachine/shakeable/ShakeableTimeMachineLayoutRunner.kt

@@ -13,7 +13,7 @@ import com.squareup.workflow1.ui.ScreenViewRunner
 import com.squareup.workflow1.ui.ViewEnvironment
 import com.squareup.workflow1.ui.WorkflowUiExperimentalApi
 import com.squareup.workflow1.ui.WorkflowViewStub
-import com.squareup.workflow1.ui.backPressedHandler
+import com.squareup.workflow1.ui.setBackHandler
 import kotlin.time.Duration
 import kotlin.time.Duration.Companion.milliseconds
 import kotlin.time.ExperimentalTime
@@ -44,7 +44,7 @@ class ShakeableTimeMachineLayoutRunner(
     environment: ViewEnvironment
   ) {
     // Only handle back presses explicitly if in playback mode.
-    view.backPressedHandler = rendering.onResumeRecording.takeUnless { rendering.recording }
+    view.setBackHandler(rendering.onResumeRecording.takeUnless { rendering.recording })
 
     seek.max = rendering.totalDuration.toProgressInt()
     seek.progress = rendering.playbackPosition.toProgressInt()

samples/tictactoe/app/src/main/java/com/squareup/sample/authworkflow/LoginViewFactory.kt

@@ -4,7 +4,7 @@ import com.squareup.sample.tictactoe.databinding.LoginLayoutBinding
 import com.squareup.workflow1.ui.ScreenViewFactory
 import com.squareup.workflow1.ui.ScreenViewFactory.Companion.fromViewBinding
 import com.squareup.workflow1.ui.WorkflowUiExperimentalApi
-import com.squareup.workflow1.ui.backPressedHandler
+import com.squareup.workflow1.ui.setBackHandler
 
 @OptIn(WorkflowUiExperimentalApi::class)
 internal val LoginViewFactory: ScreenViewFactory<LoginScreen> =
@@ -15,5 +15,5 @@ internal val LoginViewFactory: ScreenViewFactory<LoginScreen> =
       rendering.onLogin(loginEmail.text.toString(), loginPassword.text.toString())
     }
 
-    root.backPressedHandler = { rendering.onCancel() }
+    root.setBackHandler(rendering.onCancel)
   }

samples/tictactoe/app/src/main/java/com/squareup/sample/authworkflow/SecondFactorViewFactory.kt

@@ -4,12 +4,12 @@ import com.squareup.sample.tictactoe.databinding.SecondFactorLayoutBinding
 import com.squareup.workflow1.ui.ScreenViewFactory
 import com.squareup.workflow1.ui.ScreenViewFactory.Companion.fromViewBinding
 import com.squareup.workflow1.ui.WorkflowUiExperimentalApi
-import com.squareup.workflow1.ui.backPressedHandler
+import com.squareup.workflow1.ui.setBackHandler
 
 @OptIn(WorkflowUiExperimentalApi::class)
 internal val SecondFactorViewFactory: ScreenViewFactory<SecondFactorScreen> =
   fromViewBinding(SecondFactorLayoutBinding::inflate) { rendering, _ ->
-    root.backPressedHandler = { rendering.onCancel() }
+    root.setBackHandler(rendering.onCancel)
     secondFactorToolbar.setNavigationOnClickListener { rendering.onCancel() }
 
     secondFactorErrorMessage.text = rendering.errorMessage

samples/tictactoe/app/src/main/java/com/squareup/sample/gameworkflow/GameOverLayoutRunner.kt

@@ -15,7 +15,7 @@ import com.squareup.workflow1.ui.ScreenViewFactory.Companion.fromViewBinding
 import com.squareup.workflow1.ui.ScreenViewRunner
 import com.squareup.workflow1.ui.ViewEnvironment
 import com.squareup.workflow1.ui.WorkflowUiExperimentalApi
-import com.squareup.workflow1.ui.backPressedHandler
+import com.squareup.workflow1.ui.setBackHandler
 
 @OptIn(WorkflowUiExperimentalApi::class)
 internal class GameOverLayoutRunner(
@@ -40,14 +40,15 @@ internal class GameOverLayoutRunner(
       rendering.onPlayAgain()
       true
     }
-    binding.root.backPressedHandler = { rendering.onExit() }
+    binding.root.setBackHandler(rendering.onExit)
 
     when (rendering.endGameState.syncState) {
       SAVING -> {
         saveItem.isEnabled = false
         saveItem.title = "saving…"
         saveItem.setOnMenuItemClickListener(null)
       }
+
       SAVE_FAILED -> {
         saveItem.isEnabled = true
         saveItem.title = "Unsaved"
@@ -56,6 +57,7 @@ internal class GameOverLayoutRunner(
           true
         }
       }
+
       SAVED -> {
         saveItem.isVisible = false
         saveItem.setOnMenuItemClickListener(null)