Harmonized filtering UI (#62)

* Make generic FilterPanel and FilterSidebar classes for use with other tools

* Additional Refactor of FilterPanel and implement consistent filtering techniques in Thread View

* Ktlint formatting pass

* Fix NPE when updateData() is called with no sorting active

* Introduce ListFilterPanel to avoid repetitive class impls.

* Fix typo

* Updates to harmonized-filtering-ui (#63)

- Eliminate some duplication
- Fix a perf issue with sorting

---------

Co-authored-by: Paul Griffith <pgriffith@ia.io>
Co-authored-by: Paul Griffith <39345262+paul-griffith@users.noreply.github.com>

Author: Joshlha

gradle/libs.versions.toml

@@ -35,6 +35,7 @@ flatlaf-jide = { group = "com.formdev", name = "flatlaf-jide-oss", version.ref =
 flatlaf-swingx = { group = "com.formdev", name = "flatlaf-swingx", version.ref = "flatlaf" }
 flatlaf-themes = { group = "com.formdev", name = "flatlaf-intellij-themes", version.ref = "flatlaf" }
 flatlaf-fonts-roboto = { group = "com.formdev", name = "flatlaf-fonts-roboto", version = "2.137" }
+flatlaf-fonts-roboto-mono = { group = "com.formdev", name = "flatlaf-fonts-roboto-mono", version = "3.000" }
 jide-common = { group = "com.formdev", name = "jide-oss", version = "3.7.12" }
 swingx = { group = "org.swinglabs.swingx", name = "swingx-all", version = "1.6.5-1" }
 rsyntaxtextarea = { group = "com.fifesoft", name = "rsyntaxtextarea", version = "3.3.4" }
@@ -64,6 +65,7 @@ flatlaf = [
     "flatlaf-swingx",
     "flatlaf-themes",
     "flatlaf-fonts-roboto",
+    "flatlaf-fonts-roboto-mono",
 ]
 kotest = [
     "kotest-junit",

src/main/kotlin/io/github/inductiveautomation/kindling/MainPanel.kt

@@ -6,6 +6,7 @@ import com.formdev.flatlaf.extras.FlatSVGIcon
 import com.formdev.flatlaf.extras.FlatUIDefaultsInspector
 import com.formdev.flatlaf.extras.components.FlatTextArea
 import com.formdev.flatlaf.fonts.roboto.FlatRobotoFont
+import com.formdev.flatlaf.fonts.roboto_mono.FlatRobotoMonoFont
 import com.formdev.flatlaf.util.SystemInfo
 import com.jidesoft.swing.StyleRange.STYLE_UNDERLINED
 import io.github.inductiveautomation.kindling.core.ClipboardTool
@@ -358,9 +359,11 @@ class MainPanel : JPanel(MigLayout("ins 6, fill")) {
 
         private fun lafSetup() {
             FlatRobotoFont.install()
+            FlatRobotoMonoFont.install()
             FlatLaf.setPreferredFontFamily(FlatRobotoFont.FAMILY)
             FlatLaf.setPreferredLightFontFamily(FlatRobotoFont.FAMILY_LIGHT)
             FlatLaf.setPreferredSemiboldFontFamily(FlatRobotoFont.FAMILY_SEMIBOLD)
+            FlatLaf.setPreferredMonospacedFontFamily(FlatRobotoMonoFont.FAMILY)
             applyTheme(false)
 
             UIManager.getDefaults().apply {

src/main/kotlin/io/github/inductiveautomation/kindling/cache/CacheView.kt

@@ -20,7 +20,9 @@ import io.github.inductiveautomation.kindling.utils.Action
 import io.github.inductiveautomation.kindling.utils.EDT_SCOPE
 import io.github.inductiveautomation.kindling.utils.FileFilter
 import io.github.inductiveautomation.kindling.utils.FlatScrollPane
+import io.github.inductiveautomation.kindling.utils.HorizontalSplitPane
 import io.github.inductiveautomation.kindling.utils.ReifiedJXTable
+import io.github.inductiveautomation.kindling.utils.VerticalSplitPane
 import io.github.inductiveautomation.kindling.utils.getLogger
 import io.github.inductiveautomation.kindling.utils.getValue
 import io.github.inductiveautomation.kindling.utils.jFrame
@@ -41,8 +43,6 @@ import java.sql.PreparedStatement
 import java.util.zip.GZIPInputStream
 import javax.swing.Icon
 import javax.swing.JLabel
-import javax.swing.JSplitPane
-import javax.swing.SwingConstants
 import javax.swing.table.DefaultTableModel
 import kotlin.io.path.CopyActionResult
 import kotlin.io.path.ExperimentalPathApi
@@ -234,19 +234,14 @@ class CacheView(private val path: Path) : ToolPanel() {
         )
     }
 
-    private val mainSplitPane = JSplitPane(
-        SwingConstants.HORIZONTAL,
-        JSplitPane(
-            SwingConstants.VERTICAL,
+    private val mainSplitPane = HorizontalSplitPane(
+        VerticalSplitPane(
             FlatScrollPane(table),
             details,
-        ).apply {
-            resizeWeight = 0.5
-        },
+        ),
         FlatScrollPane(schemaList),
-    ).apply {
-        resizeWeight = 0.75
-    }
+        resizeWeight = 0.75,
+    )
 
     private fun Serializable.toDetail(): Detail = when (this) {
         is BasicHistoricalRecord -> toDetail()

src/main/kotlin/io/github/inductiveautomation/kindling/core/Filtering.kt

@@ -0,0 +1,39 @@
+package io.github.inductiveautomation.kindling.core
+
+import io.github.inductiveautomation.kindling.utils.Column
+import io.github.inductiveautomation.kindling.utils.add
+import java.util.EventListener
+import javax.swing.JComponent
+import javax.swing.JPopupMenu
+import javax.swing.event.EventListenerList
+
+fun interface Filter<T> {
+    /**
+     * Return true if this filter should display this item.
+     */
+    fun filter(item: T): Boolean
+}
+
+fun interface FilterChangeListener : EventListener {
+    fun filterChanged()
+}
+
+abstract class FilterPanel<T> : Filter<T> {
+    abstract val tabName: String
+    abstract fun isFilterApplied(): Boolean
+    abstract val component: JComponent
+
+    protected val listeners = EventListenerList()
+
+    fun addFilterChangeListener(listener: FilterChangeListener) {
+        listeners.add(listener)
+    }
+
+    abstract fun reset()
+
+    abstract fun customizePopupMenu(
+        menu: JPopupMenu,
+        column: Column<out T, *>,
+        event: T,
+    )
+}

src/main/kotlin/io/github/inductiveautomation/kindling/idb/generic/GenericView.kt

@@ -3,6 +3,8 @@ package io.github.inductiveautomation.kindling.idb.generic
 import io.github.inductiveautomation.kindling.core.ToolPanel
 import io.github.inductiveautomation.kindling.utils.Action
 import io.github.inductiveautomation.kindling.utils.FlatScrollPane
+import io.github.inductiveautomation.kindling.utils.HorizontalSplitPane
+import io.github.inductiveautomation.kindling.utils.VerticalSplitPane
 import io.github.inductiveautomation.kindling.utils.attachPopupMenu
 import io.github.inductiveautomation.kindling.utils.javaType
 import io.github.inductiveautomation.kindling.utils.menuShortcutKeyMaskEx
@@ -20,7 +22,6 @@ import javax.swing.JButton
 import javax.swing.JMenuItem
 import javax.swing.JPanel
 import javax.swing.JPopupMenu
-import javax.swing.JSplitPane
 import javax.swing.JTextArea
 import javax.swing.KeyStroke
 import javax.swing.tree.DefaultTreeModel
@@ -151,21 +152,17 @@ class GenericView(connection: Connection) : ToolPanel("ins 0, fill, hidemode 3")
         }
 
         add(
-            JSplitPane(
-                JSplitPane.HORIZONTAL_SPLIT,
+            HorizontalSplitPane(
                 FlatScrollPane(tree).apply {
                     preferredSize = Dimension(200, 10)
                 },
-                JSplitPane(
-                    JSplitPane.VERTICAL_SPLIT,
+                VerticalSplitPane(
                     FlatScrollPane(queryPanel),
                     results,
-                ).apply {
-                    resizeWeight = 0.2
-                },
-            ).apply {
-                resizeWeight = 0.1
-            },
+                    resizeWeight = 0.2,
+                ),
+                resizeWeight = 0.1,
+            ),
             "push, grow",
         )
     }

src/main/kotlin/io/github/inductiveautomation/kindling/log/LevelPanel.kt

@@ -2,38 +2,17 @@ package io.github.inductiveautomation.kindling.log
 
 import io.github.inductiveautomation.kindling.utils.Action
 import io.github.inductiveautomation.kindling.utils.Column
-import io.github.inductiveautomation.kindling.utils.FilterList
+import io.github.inductiveautomation.kindling.utils.FilterListPanel
 import io.github.inductiveautomation.kindling.utils.FilterModel
-import io.github.inductiveautomation.kindling.utils.FlatScrollPane
-import io.github.inductiveautomation.kindling.utils.add
-import io.github.inductiveautomation.kindling.utils.getAll
-import javax.swing.JComponent
 import javax.swing.JPopupMenu
-import javax.swing.event.EventListenerList
-
-internal class LevelPanel(rawData: List<LogEvent>) : LogFilterPanel {
-    private val filterList: FilterList = FilterList()
-    override val component: JComponent = FlatScrollPane(filterList)
-
-    private val listenerList = EventListenerList()
 
+internal class LevelPanel(rawData: List<LogEvent>) : FilterListPanel<LogEvent>("Level") {
     init {
         filterList.setModel(FilterModel(rawData.groupingBy { it.level?.name }.eachCount()))
         filterList.selectAll()
-
-        filterList.checkBoxListSelectionModel.addListSelectionListener { e ->
-            if (!e.valueIsAdjusting) {
-                listenerList.getAll<FilterChangeListener>().forEach(FilterChangeListener::filterChanged)
-            }
-        }
     }
 
-    override val tabName: String = "Level"
-    override fun isFilterApplied() = filterList.checkBoxListSelectedValues.size != filterList.model.size - 1
-    override fun filter(event: LogEvent): Boolean = event.level?.name in filterList.checkBoxListSelectedValues
-    override fun addFilterChangeListener(listener: FilterChangeListener) {
-        listenerList.add(listener)
-    }
+    override fun filter(item: LogEvent): Boolean = item.level?.name in filterList.checkBoxListSelectedValues
 
     override fun customizePopupMenu(menu: JPopupMenu, column: Column<out LogEvent, *>, event: LogEvent) {
         val level = event.level
@@ -52,6 +31,4 @@ internal class LevelPanel(rawData: List<LogEvent>) : LogFilterPanel {
             )
         }
     }
-
-    override fun reset() = filterList.selectAll()
 }