Merge pull request #577 from square/ray/introducing-Screen

Introduces Screen, WithEnvironment : Screen. Deprecates ViewFactory

Author: rjrjr

samples/compose-samples/src/main/java/com/squareup/sample/compose/hellocomposebinding/HelloBindingActivity.kt

@@ -1,3 +1,5 @@
+@file:Suppress("DEPRECATION")
+
 package com.squareup.sample.compose.hellocomposebinding
 
 import android.os.Bundle

samples/compose-samples/src/main/java/com/squareup/sample/compose/hellocomposeworkflow/HelloComposeWorkflowActivity.kt

@@ -1,3 +1,5 @@
+@file:Suppress("DEPRECATION")
+
 package com.squareup.sample.compose.hellocomposeworkflow
 
 import android.os.Bundle

samples/compose-samples/src/main/java/com/squareup/sample/compose/inlinerendering/InlineRenderingActivity.kt

@@ -1,3 +1,5 @@
+@file:Suppress("DEPRECATION")
+
 package com.squareup.sample.compose.inlinerendering
 
 import android.os.Bundle

samples/compose-samples/src/main/java/com/squareup/sample/compose/inlinerendering/InlineRenderingWorkflow.kt

@@ -1,3 +1,4 @@
+@file:Suppress("DEPRECATION")
 @file:OptIn(WorkflowUiExperimentalApi::class)
 
 package com.squareup.sample.compose.inlinerendering

samples/compose-samples/src/main/java/com/squareup/sample/compose/nestedrenderings/LegacyRunner.kt

@@ -1,3 +1,5 @@
+@file:Suppress("DEPRECATION")
+
 package com.squareup.sample.compose.nestedrenderings
 
 import androidx.compose.foundation.layout.fillMaxSize

samples/compose-samples/src/main/java/com/squareup/sample/compose/nestedrenderings/NestedRenderingsActivity.kt

@@ -1,3 +1,5 @@
+@file:Suppress("DEPRECATION")
+
 package com.squareup.sample.compose.nestedrenderings
 
 import android.os.Bundle

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

@@ -1,5 +1,6 @@
 package com.squareup.sample.container
 
+import com.squareup.workflow1.ui.Screen
 import com.squareup.workflow1.ui.WorkflowUiExperimentalApi
 
 /**
@@ -16,8 +17,8 @@ import com.squareup.workflow1.ui.WorkflowUiExperimentalApi
  * is pressed, or null to set no handler. Defaults to `null`.
  */
 @WorkflowUiExperimentalApi
-data class BackButtonScreen<W : Any>(
+data class BackButtonScreen<W : Screen>(
   val wrapped: W,
   val override: Boolean = false,
   val onBackPressed: (() -> Unit)? = null
-)
+) : Screen

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

@@ -1,30 +1,31 @@
 package com.squareup.sample.container
 
-import com.squareup.workflow1.ui.DecorativeViewFactory
-import com.squareup.workflow1.ui.ViewFactory
+import com.squareup.workflow1.ui.DecorativeScreenViewFactory
+import com.squareup.workflow1.ui.ScreenViewFactory
 import com.squareup.workflow1.ui.WorkflowUiExperimentalApi
 import com.squareup.workflow1.ui.backPressedHandler
 
 /**
- * [ViewFactory] that performs the work required by [BackButtonScreen].
+ * [ScreenViewFactory] that performs the work required by [BackButtonScreen].
  */
 @WorkflowUiExperimentalApi
-object BackButtonViewFactory : ViewFactory<BackButtonScreen<*>>
-by DecorativeViewFactory(
-    type = BackButtonScreen::class,
-    map = { outer -> outer.wrapped },
-    doShowRendering = { view, innerShowRendering, outerRendering, viewEnvironment ->
-      if (!outerRendering.override) {
-        // Place our handler before invoking innerShowRendering, so that
-        // its later calls to view.backPressedHandler will take precedence
-        // over ours.
-        view.backPressedHandler = outerRendering.onBackPressed
-      }
+object BackButtonViewFactory : ScreenViewFactory<BackButtonScreen<*>>
+by DecorativeScreenViewFactory(
+  type = BackButtonScreen::class,
+  map = { outer -> outer.wrapped },
+  doShowRendering = { view, innerShowRendering, outerRendering, viewEnvironment ->
+    if (!outerRendering.override) {
+      // Place our handler before invoking innerShowRendering, so that
+      // its later calls to view.backPressedHandler will take precedence
+      // over ours.
+      view.backPressedHandler = outerRendering.onBackPressed
+    }
 
-      innerShowRendering.invoke(outerRendering.wrapped, viewEnvironment)
+    innerShowRendering.invoke(outerRendering.wrapped, viewEnvironment)
 
-      if (outerRendering.override) {
-        // Place our handler after invoking innerShowRendering, so that ours wins.
-        view.backPressedHandler = outerRendering.onBackPressed
-      }
-    })
+    if (outerRendering.override) {
+      // Place our handler after invoking innerShowRendering, so that ours wins.
+      view.backPressedHandler = outerRendering.onBackPressed
+    }
+  }
+)

samples/containers/android/src/main/java/com/squareup/sample/container/overviewdetail/OverviewDetailContainer.kt

@@ -7,13 +7,13 @@ import com.squareup.sample.container.R
 import com.squareup.sample.container.overviewdetail.OverviewDetailConfig.Detail
 import com.squareup.sample.container.overviewdetail.OverviewDetailConfig.Overview
 import com.squareup.sample.container.overviewdetail.OverviewDetailConfig.Single
-import com.squareup.workflow1.ui.LayoutRunner
+import com.squareup.workflow1.ui.ScreenViewFactory
+import com.squareup.workflow1.ui.ScreenViewRunner
 import com.squareup.workflow1.ui.ViewEnvironment
-import com.squareup.workflow1.ui.ViewFactory
 import com.squareup.workflow1.ui.WorkflowUiExperimentalApi
 import com.squareup.workflow1.ui.WorkflowViewStub
-import com.squareup.workflow1.ui.backstack.BackStackScreen
-import com.squareup.workflow1.ui.backstack.withBackStackStateKeyPrefix
+import com.squareup.workflow1.ui.container.BackStackScreen
+import com.squareup.workflow1.ui.container.withBackStackStateKeyPrefix
 
 /**
  * Displays [OverviewDetailScreen] renderings in either split pane or single pane
@@ -25,7 +25,7 @@ import com.squareup.workflow1.ui.backstack.withBackStackStateKeyPrefix
  * with [OverviewDetailScreen.overviewRendering] as the base of the stack.
  */
 @OptIn(WorkflowUiExperimentalApi::class)
-class OverviewDetailContainer(view: View) : LayoutRunner<OverviewDetailScreen> {
+class OverviewDetailContainer(view: View) : ScreenViewRunner<OverviewDetailScreen> {
 
   private val overviewStub: WorkflowViewStub? = view.findViewById(R.id.overview_stub)
   private val detailStub: WorkflowViewStub? = view.findViewById(R.id.detail_stub)
@@ -53,15 +53,15 @@ class OverviewDetailContainer(view: View) : LayoutRunner<OverviewDetailScreen> {
     if (rendering.detailRendering == null && rendering.selectDefault != null) {
       rendering.selectDefault!!.invoke()
     } else {
-      // Since we have two sibling backstacks, we need to give them each different
+      // Since we have two sibling back stacks, we need to give them each different
       // SavedStateRegistry key prefixes.
       val overviewViewEnvironment = viewEnvironment
         .withBackStackStateKeyPrefix(OverviewBackStackKey) + (OverviewDetailConfig to Overview)
-      overviewStub!!.update(rendering.overviewRendering, overviewViewEnvironment)
+      overviewStub!!.show(rendering.overviewRendering, overviewViewEnvironment)
       rendering.detailRendering
         ?.let { detail ->
           detailStub!!.actual.visibility = VISIBLE
-          detailStub.update(
+          detailStub.show(
             detail,
             viewEnvironment + (OverviewDetailConfig to Detail)
           )
@@ -81,10 +81,10 @@ class OverviewDetailContainer(view: View) : LayoutRunner<OverviewDetailScreen> {
       ?.let { rendering.overviewRendering + it }
       ?: rendering.overviewRendering
 
-    stub.update(combined, viewEnvironment + (OverviewDetailConfig to Single))
+    stub.show(combined, viewEnvironment + (OverviewDetailConfig to Single))
   }
 
-  companion object : ViewFactory<OverviewDetailScreen> by LayoutRunner.bind(
+  companion object : ScreenViewFactory<OverviewDetailScreen> by ScreenViewRunner.bind(
     layoutId = R.layout.overview_detail,
     constructor = ::OverviewDetailContainer
   ) {

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

@@ -10,8 +10,8 @@ import android.view.View
 import android.view.ViewGroup
 import android.view.ViewGroup.LayoutParams.MATCH_PARENT
 import com.squareup.sample.container.R
-import com.squareup.workflow1.ui.BuilderViewFactory
-import com.squareup.workflow1.ui.ViewFactory
+import com.squareup.workflow1.ui.ManualScreenViewFactory
+import com.squareup.workflow1.ui.ScreenViewFactory
 import com.squareup.workflow1.ui.WorkflowUiExperimentalApi
 import com.squareup.workflow1.ui.bindShowRendering
 import com.squareup.workflow1.ui.modal.ModalViewContainer
@@ -59,7 +59,7 @@ class PanelContainer @JvmOverloads constructor(
     }
   }
 
-  companion object : ViewFactory<PanelContainerScreen<*, *>> by BuilderViewFactory(
+  companion object : ScreenViewFactory<PanelContainerScreen<*, *>> by ManualScreenViewFactory(
       type = PanelContainerScreen::class,
       viewConstructor = { initialRendering, initialEnv, contextForNewView, _ ->
         PanelContainer(contextForNewView).apply {