New table fragment (#185) #368

Baret · 2021-03-11T07:05:10Z

Basic solution for #185

nanodeath · 2021-03-11T18:05:31Z

I know this is a draft, but perhaps we can squash it into one commit?

adam-arold · 2021-03-11T19:07:13Z

Go ahead! I'd use git rebase -i, that's a bit better.

adam-arold · 2021-03-11T19:08:04Z

@Baret do you think this will work with Java too?

nanodeath · 2021-03-11T19:44:21Z

Go ahead! I'd use git rebase -i, that's a bit better.

Sorry yeah, that's what I meant.

Baret · 2021-03-11T21:14:09Z

do you think this will work with Java too?

Oh well umm... I guess you should be able to pass lambdas there, too. But I will try to port the example to java and see how it feels there.

adam-arold · 2021-03-11T21:33:31Z

I'm starting to think that we should drop Java support. As others have stated Java/LibGDX and the like are pretty much dead WRT game development, but a multiplatform Kotlin setup is an interesting niche.

nanodeath · 2021-03-11T22:03:41Z

I'm starting to think that we should drop Java support. As others have stated Java/LibGDX and the like are pretty much dead WRT game development, but a multiplatform Kotlin setup is an interesting niche.

If we're humoring this we should split this discussion off into a separate issue :)

adam-arold · 2021-03-15T19:08:09Z

Yeah. Dropping Java support would just mean that from now on we no longer care about the DX of Java users, we don't need to refactor anything. 😄

Baret · 2021-03-21T19:44:17Z

Oops, I meant to write this comment in the issue here. It contains an explanation of what I intended to do here :)

BTW I am not able to see why the build fails. Can someone give me an error message or hint?

nanodeath · 2021-03-21T19:46:13Z

BTW I am not able to see why the build fails. Can someone give me an error message or hint?

e: /home/circleci/repo/zircon.core/src/commonMain/kotlin/org/hexworks/zircon/api/Columns.kt: (56, 18): Unresolved reference: format
e: /home/circleci/repo/zircon.core/src/commonMain/kotlin/org/hexworks/zircon/api/Fragments.kt: (21, 6): Unresolved reference: JvmStatic
e: /home/circleci/repo/zircon.core/src/commonMain/kotlin/org/hexworks/zircon/api/Fragments.kt: (27, 6): Unresolved reference: JvmStatic
e: /home/circleci/repo/zircon.core/src/commonMain/kotlin/org/hexworks/zircon/api/Fragments.kt: (36, 6): Unresolved reference: JvmStatic

Using @JvmStatic in commonMain? Not sure about the other one. Maybe String#format is provided by the JVM.

Baret · 2021-03-21T21:12:19Z

Oh ummm.... Oops? :D
I'm not used to write pure kotlin common code I guess. Gonna fix it up ^^

nanodeath · 2021-03-22T16:26:20Z

zircon.jvm.examples/src/main/kotlin/org/hexworks/zircon/examples/fragments/table/Gender.kt

@@ -0,0 +1,6 @@
+package org.hexworks.zircon.examples.fragments.table
+
+enum class Gender {


This might seem silly, but do you mind if we drop this particular column from the example? Seems needlessly complicating :)

If you just need an enum example, how about, um...Height { SHORT, AVERAGE, TALL }.

…ragment

nanodeath · 2021-03-23T01:58:41Z

zircon.core/src/commonMain/kotlin/org/hexworks/zircon/api/Columns.kt

+    ): TableColumn<M, *, Label> =
+        textColumn(name, width) {
+            format
+                .format(


Hey, so String#format is purely a JVM construct, looking at this SO question. My recommendation would be to just drop this method completely and perhaps expose a (M) -> String method in the API instead? Something to let the user either use Kotlin's string templates directly, or to access a ObservableValue.

nanodeath · 2021-03-23T01:59:18Z

zircon.core/src/commonMain/kotlin/org/hexworks/zircon/api/Fragments.kt

 import org.hexworks.zircon.api.builder.fragment.TilesetSelectorBuilder
 import org.hexworks.zircon.api.component.ColorTheme
 import org.hexworks.zircon.api.component.Fragment
 import org.hexworks.zircon.api.fragment.Selector
 import org.hexworks.zircon.api.resource.TilesetResource
-import kotlin.jvm.JvmStatic


Turns out this line is required in order for this file to build 😄 if you put it back in it should work fine.

Umm great find, why didn't IntelliJ tell me? :'(

No lie, I'm surprised that putting what looks like JVM-specific code in commonMain works at all. I guess it's just a no-op in the other targets.

Yes, the kotlin.jvm package instantly looks suspicious ;)

I have organizing the imports at commit enabled which makes this import disappear... annoying -.-

nanodeath · 2021-03-23T02:02:10Z

zircon.core/src/commonMain/kotlin/org/hexworks/zircon/api/fragment/Table.kt

+ *
+ * @param M the type of the underlying model representing this table's data.
+ */
+interface Table<M: Any>: Fragment {


Table<M: Any>

I see the missing space here as a recurring issue in this change. I'd double-check you're using the official code guidelines in IntelliJ, because the recommendation is to format this as Table<M : Any>. Minor, for sure, but it's good to be consistent.

Yup I totally agree. I just got used to refrain from formatting whole files. That leads to some lines sneaking through with ugly parts ;)

zircon.core/src/commonMain/kotlin/org/hexworks/zircon/api/Columns.kt

+    /**
+     * Creates a [TableColumn] that represents it's cell values with a [Label]. The text of the label
+     * is the toString() of the value provided by [valueAccessor].
+     *


Not creative enough to find a good enum of people... ^^

Baret · 2021-03-24T16:33:46Z

Ok, I finally got it into a state where it builds and I can say: have a review please :)

nanodeath · 2021-03-25T03:35:34Z

....core/src/commonMain/kotlin/org/hexworks/zircon/internal/fragment/impl/table/DefaultTable.kt

+                // TODO: Improve this loop to not loop over all elements
+                data.forEach { model ->
+                    val newRow = newRowFor(model)
+                    if(remainingHeight > 0) {
+                        currentRows.add(addComponent(newRow))
+                    }
+                    remainingHeight -= newRow.height + rowSpacing
+                }


Why not just use a conventional for loop and break when remainingHeight <= 0?

...n.core/src/commonMain/kotlin/org/hexworks/zircon/internal/fragment/impl/table/TableColumn.kt

nanodeath · 2021-03-25T03:38:34Z

...n.core/src/commonMain/kotlin/org/hexworks/zircon/internal/fragment/impl/table/TableColumn.kt

+ * @param V the type of the value of each cell in this column
+ * @param C type of the [Component] used to represent each cell
+ */
+open class TableColumn<M : Any, V : Any, C : Component>(


Does this need to be open?

I wanted to give the users of the API as much flexibility as possible. You should not be restricted to only use the predefined TableColumns or this constructor. Maybe you have your own fancy implementation and want to use it over and over again so I thought it should be possible to extend this class.

nanodeath · 2021-03-25T03:39:53Z

...on.jvm.examples/src/main/kotlin/org/hexworks/zircon/examples/fragments/table/TableExample.kt

+/**
+ * This example shows the usage of the table fragment.
+ */
+object TableExample {


Can we attach a screenshot of what this looks like to the review somewhere? And/or a gif?

attached it to the issue as I think it is more "historically relevant" as this PR: #185 (comment)

nanodeath · 2021-03-25T03:41:29Z

zircon.jvm.examples/src/main/kotlin/org/hexworks/zircon/examples/fragments/table/tableData.kt

+
+// Some names, most of which are credited to https://github.com/imsky/wordlists
+
+private val firstNames: List<String> =


Ehhh...is this really necessary? How many do we really need?

zircon.core/src/commonMain/kotlin/org/hexworks/zircon/api/Columns.kt

....core/src/commonMain/kotlin/org/hexworks/zircon/internal/fragment/impl/table/DefaultTable.kt

nanodeath · 2021-03-25T03:48:56Z

....core/src/commonMain/kotlin/org/hexworks/zircon/internal/fragment/impl/table/DefaultTable.kt

+        require(data.isNotEmpty()) {
+            "A table may not be empty! Please feed it some data to display."
+        }


Might be nice to lift this requirement. Would that be possible?

I thought "sure, why not!", but when I just tried it I realized that there is selectedElement: Property<M>. With an empty list we would need to handle that and I don't know how complicated that would become. I think Property can not contain nullable values...

Hm...maybe the caller would have to provide a "null object pattern" object then? Not really a fan, but might be the only way?

I don't see it being terribly common but this does seem like something callers would expect to work.

I agree with @nanodeath . Imagine that you have filter fields above your table and the table itself has an ObservableList so when you type something the list is updated accordingly. It might happen that there are no items that correspond to your query and the table will be empty.

Selection is also a different concept. You can have a table that has n elements but none of them are selected.

See my comment above for a workaround for this problem that would also alleviate the need for nulls and null objects.

adam-arold

This looks good, @Baret ! I've left some comments in the code for some possible improvements. I can't wait to push Merge on this!

adam-arold · 2021-04-06T20:33:01Z

zircon.core/src/commonMain/kotlin/org/hexworks/zircon/api/Fragments.kt

@@ -39,4 +40,7 @@ object Fragments {
        theme: ColorTheme
    ): ColorThemeSelectorBuilder = ColorThemeSelectorBuilder.newBuilder(width, theme)

+    fun <M: Any> table(data: List<M>): TableBuilder<M> =


Is there a reason for not using ObservableList here?

adam-arold · 2021-04-06T20:33:57Z

zircon.core/src/commonMain/kotlin/org/hexworks/zircon/api/TableColumns.kt

+/**
+ * This object provides different presets for [TableColumn]s.
+ */
+object TableColumns {


Can you please add @Beta to this and all other new classes?

Done with 500e8cb

adam-arold · 2021-04-06T20:35:14Z

zircon.core/src/commonMain/kotlin/org/hexworks/zircon/api/TableColumns.kt

+     *  When the value returned is an [ObservableValue] or a [Property] the textProperty of the label
+     *  will update accordingly.
+     */
+    fun <M : Any, V : Any> textColumn(name: String, width: Int, valueAccessor: (M) -> V): TableColumn<M, V, Label> =


Would it make sense to have a version of textColumn that explicitly has an ObservableValue as its valueAccessor? Just for good DX.

I am not fully satisfied with the name, but added TableColumns.textColumnObservable() with 7937969

adam-arold · 2021-04-06T20:35:50Z

zircon.core/src/commonMain/kotlin/org/hexworks/zircon/api/builder/fragment/TableBuilder.kt

+import org.hexworks.zircon.internal.fragment.impl.table.DefaultTable
+import org.hexworks.zircon.internal.fragment.impl.table.TableColumn
+
+class TableBuilder<M : Any>(private val data: List<M>): FragmentBuilder<Table<M>, TableBuilder<M>> {


Same as above: can we use an ObservableList?

I already wanted to do this but somehow forgot. The basics are there with 19518d0 but I feel like I want to further improve it ^^
At least I want to change the TableExample to start out with a table not fully filled and a + and - button to add and remove table entries to demonstrate the observable data.

adam-arold · 2021-04-06T20:38:29Z

....core/src/commonMain/kotlin/org/hexworks/zircon/internal/fragment/impl/table/DefaultTable.kt

+        require(data.isNotEmpty()) {
+            "A table may not be empty! Please feed it some data to display."
+        }


I agree with @nanodeath . Imagine that you have filter fields above your table and the table itself has an ObservableList so when you type something the list is updated accordingly. It might happen that there are no items that correspond to your query and the table will be empty.

Selection is also a different concept. You can have a table that has n elements but none of them are selected.

See my comment above for a workaround for this problem that would also alleviate the need for nulls and null objects.

adam-arold · 2021-04-06T20:39:57Z

zircon.core/src/commonMain/kotlin/org/hexworks/zircon/api/fragment/Table.kt

+    /**
+     * The element representing the currently selected row as [ObservableValue].
+     */
+    val selectedRowValue: ObservableValue<M>


You can kill two birds with one stone and modify this to be an ObservableList and name it selectedRowsValue. Then an empty list means no selection and you can also have multiple selected rows. You can change selectedRow accordingly.

adam-arold · 2021-04-06T20:41:39Z

....core/src/commonMain/kotlin/org/hexworks/zircon/internal/fragment/impl/table/DefaultTable.kt

+            )
+    }
+
+    private fun dataPanel(panelSize: Size): VBox {


What's a dataPanel? It is not clear from this.

adam-arold · 2021-04-06T20:43:57Z

zircon.jvm.examples/src/main/kotlin/org/hexworks/zircon/examples/playground/TableOld.kt

@@ -4,7 +4,7 @@ import org.hexworks.zircon.api.Components
 import org.hexworks.zircon.api.component.Fragment
 import org.hexworks.zircon.api.data.Size

-class Table<M : Any>(
+class TableOld<M : Any>(


Poor old table. Will it ever be young again?

I will carry it to its grave ⚰
Just forgot to do it yet.

Done with 9870759

because I feel like it defines the table API instead of being an internal implementation. It is intended to be extended by zircon users

…ragment

adam-arold

LGTM!

Baret added 9 commits February 20, 2021 18:08

Basic table implementation

54e166c

First visible example

0f99a74

Created TableBuilder and Columns

c2d8911

created formatted text column

86b8b86

Added icon column

220f9f7

Added panel to show the selected person

baf63fe

DefaultTable updates the selected row on click

84dfc30

Table uses databinding when cell value is observable

6bd5ae6

Added doc for Columns.icon()

bca7c9d

Baret marked this pull request as ready for review March 15, 2021 19:32

nanodeath reviewed Mar 22, 2021

View reviewed changes

Merge remote-tracking branch 'upstream/master' into issue-185-table-f…

ffafc2b

…ragment

nanodeath suggested changes Mar 23, 2021

View reviewed changes

Baret added 6 commits March 23, 2021 21:08

Added back JvmStatic import, formatting

894f3fa

Renamed gender to height

a181f8b

Not creative enough to find a good enum of people... ^^

Removed textColumnFormatted()

1d363bc

Added text for height

cfece6d

Update wage label on change

448c030

Got rid of String.format

95c621a

Baret added 2 commits March 24, 2021 17:03

Do not organize my imports! Dammit

ad84e67

Updated label bindings

2afd289

nanodeath suggested changes Mar 25, 2021

View reviewed changes

Baret added 4 commits March 25, 2021 11:45

Renamed Columns to TableColumns

4eff194

Improved readability in textColumn()

7b339d6

Use withRelativeHeight()

09ebb7c

Tried to simplify the loop in dataPanel() and failed xD

af28c9e

adam-arold reviewed Apr 6, 2021

View reviewed changes

Baret added 7 commits April 7, 2021 21:48

Added @beta to new classes

500e8cb

Moved TableColumn to api package

28c98ed

because I feel like it defines the table API instead of being an internal implementation. It is intended to be extended by zircon users

Merge remote-tracking branch 'upstream/master' into issue-185-table-f…

1233174

…ragment

Removed old table prototype

9870759

basic implementation of data as ObservableList

19518d0

added textColumnObservable

7937969

Improved some docs

503f91a

adam-arold approved these changes Apr 13, 2021

View reviewed changes

adam-arold merged commit 581773e into Hexworks:master Apr 13, 2021

Baret mentioned this pull request May 1, 2021

Make TableFragment scrollable #383

Open

		@@ -0,0 +1,6 @@
		package org.hexworks.zircon.examples.fragments.table

		enum class Gender {


		// Some names, most of which are credited to https://github.com/imsky/wordlists

		private val firstNames: List<String> =

New table fragment (#185) #368

New table fragment (#185) #368

Conversation

Baret commented Mar 11, 2021

nanodeath commented Mar 11, 2021

adam-arold commented Mar 11, 2021

adam-arold commented Mar 11, 2021

nanodeath commented Mar 11, 2021

Baret commented Mar 11, 2021

adam-arold commented Mar 11, 2021

nanodeath commented Mar 11, 2021

adam-arold commented Mar 15, 2021

Baret commented Mar 21, 2021

nanodeath commented Mar 21, 2021

Baret commented Mar 21, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

This comment was marked as resolved.

Baret commented Mar 24, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Baret Mar 28, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

adam-arold left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

adam-arold left a comment

Choose a reason for hiding this comment

Baret Mar 28, 2021 •

edited

Loading