Skip to content

Commit a536ef3

Browse files
Rename all occurences of Master/Detail to Overview/Detail.
Fixes the kotlin half of #1188.
1 parent 8197f95 commit a536ef3

File tree

19 files changed

+166
-166
lines changed

19 files changed

+166
-166
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,11 @@
1515
*/
1616
package com.squareup.sample.container
1717

18-
import com.squareup.sample.container.masterdetail.MasterDetailContainer
18+
import com.squareup.sample.container.overviewdetail.OverviewDetailContainer
1919
import com.squareup.sample.container.panel.PanelContainer
2020
import com.squareup.sample.container.panel.ScrimContainer
2121
import com.squareup.workflow.ui.ViewRegistry
2222

2323
val SampleContainers = ViewRegistry(
24-
BackButtonScreen.Binding, MasterDetailContainer, PanelContainer, ScrimContainer
24+
BackButtonScreen.Binding, OverviewDetailContainer, PanelContainer, ScrimContainer
2525
)
Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,28 +13,28 @@
1313
* See the License for the specific language governing permissions and
1414
* limitations under the License.
1515
*/
16-
package com.squareup.sample.container.masterdetail
16+
package com.squareup.sample.container.overviewdetail
1717

1818
import com.squareup.workflow.ui.ViewEnvironmentKey
1919

2020
/**
2121
* [com.squareup.workflow.ui.ViewEnvironment] value that informs views
22-
* whether they're children of a [MasterDetailContainer], and if so
22+
* whether they're children of a [OverviewDetailContainer], and if so
2323
* in what configuration.
2424
*/
25-
enum class MasterDetailConfig {
25+
enum class OverviewDetailConfig {
2626
/**
27-
* There is no [MasterDetailContainer] above here.
27+
* There is no [OverviewDetailContainer] above here.
2828
*/
2929
None,
3030

3131
/**
32-
* Drawing on the master side of a master / detail split screen.
32+
* Drawing on the overview side of a overview / detail split screen.
3333
*/
34-
Master,
34+
Overview,
3535

3636
/**
37-
* Drawing on the detail side of a master / detail split screen.
37+
* Drawing on the detail side of a overview / detail split screen.
3838
*/
3939
Detail,
4040

@@ -43,7 +43,7 @@ enum class MasterDetailConfig {
4343
*/
4444
Single;
4545

46-
companion object : ViewEnvironmentKey<MasterDetailConfig>(MasterDetailConfig::class) {
46+
companion object : ViewEnvironmentKey<OverviewDetailConfig>(OverviewDetailConfig::class) {
4747
override val default = None
4848
}
4949
}
Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -13,68 +13,68 @@
1313
* See the License for the specific language governing permissions and
1414
* limitations under the License.
1515
*/
16-
package com.squareup.sample.container.masterdetail
16+
package com.squareup.sample.container.overviewdetail
1717

1818
import android.view.View
1919
import android.view.View.INVISIBLE
2020
import android.view.View.VISIBLE
2121
import com.squareup.sample.container.R
22-
import com.squareup.sample.container.masterdetail.MasterDetailConfig.Detail
23-
import com.squareup.sample.container.masterdetail.MasterDetailConfig.Master
24-
import com.squareup.sample.container.masterdetail.MasterDetailConfig.Single
22+
import com.squareup.sample.container.overviewdetail.OverviewDetailConfig.Detail
23+
import com.squareup.sample.container.overviewdetail.OverviewDetailConfig.Overview
24+
import com.squareup.sample.container.overviewdetail.OverviewDetailConfig.Single
2525
import com.squareup.workflow.ui.LayoutRunner
2626
import com.squareup.workflow.ui.ViewFactory
2727
import com.squareup.workflow.ui.ViewEnvironment
2828
import com.squareup.workflow.ui.WorkflowViewStub
2929
import com.squareup.workflow.ui.backstack.BackStackScreen
3030

3131
/**
32-
* Displays [MasterDetailScreen] renderings in either split pane or single pane
32+
* Displays [OverviewDetailScreen] renderings in either split pane or single pane
3333
* treatment, depending on the setup of the given [View]. The view must provide
34-
* either a single [WorkflowViewStub] with id [R.id.master_detail_single_stub],
35-
* or else two with ids [R.id.master_stub] and [R.id.detail_stub].
34+
* either a single [WorkflowViewStub] with id [R.id.overview_detail_single_stub],
35+
* or else two with ids [R.id.overview_stub] and [R.id.detail_stub].
3636
*
37-
* For single pane layouts, [MasterDetailScreen] is repackaged as a [BackStackScreen]
38-
* with [MasterDetailScreen.masterRendering] as the base of the stack.
37+
* For single pane layouts, [OverviewDetailScreen] is repackaged as a [BackStackScreen]
38+
* with [OverviewDetailScreen.overviewRendering] as the base of the stack.
3939
*/
40-
class MasterDetailContainer(view: View) : LayoutRunner<MasterDetailScreen> {
40+
class OverviewDetailContainer(view: View) : LayoutRunner<OverviewDetailScreen> {
4141

42-
private val masterStub: WorkflowViewStub? = view.findViewById(R.id.master_stub)
42+
private val overviewStub: WorkflowViewStub? = view.findViewById(R.id.overview_stub)
4343
private val detailStub: WorkflowViewStub? = view.findViewById(R.id.detail_stub)
44-
private val singleStub: WorkflowViewStub? = view.findViewById(R.id.master_detail_single_stub)
44+
private val singleStub: WorkflowViewStub? = view.findViewById(R.id.overview_detail_single_stub)
4545

4646
init {
47-
check((singleStub == null) xor (masterStub == null && detailStub == null)) {
48-
"Layout must define only R.id.master_detail_single_stub, " +
49-
"or else both R.id.master_stub and R.id.detail_stub"
47+
check((singleStub == null) xor (overviewStub == null && detailStub == null)) {
48+
"Layout must define only R.id.overview_detail_single_stub, " +
49+
"or else both R.id.overview_stub and R.id.detail_stub"
5050
}
5151
}
5252

5353
override fun showRendering(
54-
rendering: MasterDetailScreen,
54+
rendering: OverviewDetailScreen,
5555
viewEnvironment: ViewEnvironment
5656
) {
5757
if (singleStub == null) renderSplitView(rendering, viewEnvironment)
5858
else renderSingleView(rendering, viewEnvironment, singleStub)
5959
}
6060

6161
private fun renderSplitView(
62-
rendering: MasterDetailScreen,
62+
rendering: OverviewDetailScreen,
6363
viewEnvironment: ViewEnvironment
6464
) {
6565
if (rendering.detailRendering == null && rendering.selectDefault != null) {
6666
rendering.selectDefault!!.invoke()
6767
} else {
68-
masterStub!!.update(
69-
rendering.masterRendering,
70-
viewEnvironment + (MasterDetailConfig to Master)
68+
overviewStub!!.update(
69+
rendering.overviewRendering,
70+
viewEnvironment + (OverviewDetailConfig to Overview)
7171
)
7272
rendering.detailRendering
7373
?.let { detail ->
7474
detailStub!!.actual.visibility = VISIBLE
7575
detailStub.update(
7676
detail,
77-
viewEnvironment + (MasterDetailConfig to Detail)
77+
viewEnvironment + (OverviewDetailConfig to Detail)
7878
)
7979
}
8080
?: run {
@@ -84,20 +84,20 @@ class MasterDetailContainer(view: View) : LayoutRunner<MasterDetailScreen> {
8484
}
8585

8686
private fun renderSingleView(
87-
rendering: MasterDetailScreen,
87+
rendering: OverviewDetailScreen,
8888
viewEnvironment: ViewEnvironment,
8989
stub: WorkflowViewStub
9090
) {
9191
val combined: BackStackScreen<*> = rendering.detailRendering
92-
?.let { rendering.masterRendering + it }
93-
?: rendering.masterRendering
92+
?.let { rendering.overviewRendering + it }
93+
?: rendering.overviewRendering
9494

95-
stub.update(combined, viewEnvironment + (MasterDetailConfig to Single))
95+
stub.update(combined, viewEnvironment + (OverviewDetailConfig to Single))
9696
}
9797

98-
companion object : ViewFactory<MasterDetailScreen> by LayoutRunner.Binding(
99-
type = MasterDetailScreen::class,
100-
layoutId = R.layout.master_detail,
101-
runnerConstructor = ::MasterDetailContainer
98+
companion object : ViewFactory<OverviewDetailScreen> by LayoutRunner.Binding(
99+
type = OverviewDetailScreen::class,
100+
layoutId = R.layout.overview_detail,
101+
runnerConstructor = ::OverviewDetailContainer
102102
)
103103
}

kotlin/samples/containers/android/src/main/res/layout/master_detail_split.xml renamed to kotlin/samples/containers/android/src/main/res/layout-ldrtl/overview_detail_split.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,10 @@
2121
>
2222

2323
<com.squareup.workflow.ui.WorkflowViewStub
24-
android:id="@+id/master_stub"
24+
android:id="@+id/detail_stub"
2525
android:layout_width="0dp"
2626
android:layout_height="match_parent"
27-
android:layout_weight="30"
27+
android:layout_weight="70"
2828
/>
2929

3030
<View
@@ -34,10 +34,10 @@
3434
/>
3535

3636
<com.squareup.workflow.ui.WorkflowViewStub
37-
android:id="@+id/detail_stub"
37+
android:id="@+id/overview_stub"
3838
android:layout_width="0dp"
3939
android:layout_height="match_parent"
40-
android:layout_weight="70"
40+
android:layout_weight="30"
4141
/>
4242

4343
</LinearLayout>

kotlin/samples/containers/android/src/main/res/layout/master_detail_single.xml renamed to kotlin/samples/containers/android/src/main/res/layout/overview_detail_single.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
android:layout_width="match_parent" android:layout_height="match_parent">
1919

2020
<com.squareup.workflow.ui.WorkflowViewStub
21-
android:id="@+id/master_detail_single_stub"
21+
android:id="@+id/overview_detail_single_stub"
2222
android:layout_width="match_parent"
2323
android:layout_height="match_parent"/>
2424

kotlin/samples/containers/android/src/main/res/layout-ldrtl/master_detail_split.xml renamed to kotlin/samples/containers/android/src/main/res/layout/overview_detail_split.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,10 @@
2121
>
2222

2323
<com.squareup.workflow.ui.WorkflowViewStub
24-
android:id="@+id/detail_stub"
24+
android:id="@+id/overview_stub"
2525
android:layout_width="0dp"
2626
android:layout_height="match_parent"
27-
android:layout_weight="70"
27+
android:layout_weight="30"
2828
/>
2929

3030
<View
@@ -34,10 +34,10 @@
3434
/>
3535

3636
<com.squareup.workflow.ui.WorkflowViewStub
37-
android:id="@+id/master_stub"
37+
android:id="@+id/detail_stub"
3838
android:layout_width="0dp"
3939
android:layout_height="match_parent"
40-
android:layout_weight="30"
40+
android:layout_weight="70"
4141
/>
4242

4343
</LinearLayout>

kotlin/samples/containers/android/src/main/res/values-land/layout.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,5 +15,5 @@
1515
~ limitations under the License.
1616
-->
1717
<resources>
18-
<item name="master_detail" type="layout">@layout/master_detail_split</item>
18+
<item name="overview_detail" type="layout">@layout/overview_detail_split</item>
1919
</resources>

kotlin/samples/containers/android/src/main/res/values-sw600dp/layout.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,5 +15,5 @@
1515
~ limitations under the License.
1616
-->
1717
<resources>
18-
<item name="master_detail" type="layout">@layout/master_detail_split</item>
18+
<item name="overview_detail" type="layout">@layout/overview_detail_split</item>
1919
</resources>

kotlin/samples/containers/android/src/main/res/values/layout.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,5 +15,5 @@
1515
~ limitations under the License.
1616
-->
1717
<resources>
18-
<item name="master_detail" type="layout">@layout/master_detail_single</item>
18+
<item name="overview_detail" type="layout">@layout/overview_detail_single</item>
1919
</resources>

kotlin/samples/containers/app-poetry/src/main/java/com/squareup/sample/poetryapp/PoemListLayoutRunner.kt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ import android.widget.TextView
2222
import androidx.appcompat.widget.Toolbar
2323
import androidx.recyclerview.widget.LinearLayoutManager
2424
import androidx.recyclerview.widget.RecyclerView
25-
import com.squareup.sample.container.masterdetail.MasterDetailConfig
26-
import com.squareup.sample.container.masterdetail.MasterDetailConfig.Master
25+
import com.squareup.sample.container.overviewdetail.OverviewDetailConfig
26+
import com.squareup.sample.container.overviewdetail.OverviewDetailConfig.Overview
2727
import com.squareup.sample.container.poetryapp.R
2828
import com.squareup.workflow.ui.LayoutRunner
2929
import com.squareup.workflow.ui.LayoutRunner.Companion.bind
@@ -66,7 +66,7 @@ class PoemListLayoutRunner(view: View) : LayoutRunner<PoemListRendering> {
6666
parent: ViewGroup,
6767
viewType: Int
6868
): ViewHolder {
69-
val selectable = environment[MasterDetailConfig] == Master
69+
val selectable = environment[OverviewDetailConfig] == Overview
7070
val layoutId = if (selectable) {
7171
R.layout.list_row_selectable
7272
} else {

0 commit comments

Comments
 (0)