feat: add "use expression" button to JEditableCheckBox for better UX

Author: vlsi

src/core/src/main/kotlin/org/apache/jmeter/gui/JBooleanPropertyEditor.kt

@@ -41,6 +41,7 @@ public class JBooleanPropertyEditor(
         private fun createConfiguration(resourceLocalizer: ResourceLocalizer) =
             Configuration(
                 useExpression = LocalizedString("edit_as_expression_action", resourceLocalizer),
+                useExpressionTooltip = LocalizedString("edit_as_expression_tooltip", resourceLocalizer),
                 trueValue = LocalizedString("editable_checkbox.true", resourceLocalizer),
                 falseValue = LocalizedString("editable_checkbox.false", resourceLocalizer),
                 extraValues = listOf(

src/core/src/main/resources/org/apache/jmeter/resources/messages.properties

@@ -316,6 +316,7 @@ duration_assertion_title=Duration Assertion
 duration_tooltip=Elapsed time of current running Test
 edit=Edit
 edit_as_expression_action=Use Expression
+edit_as_expression_tooltip=Switch to expression mode to use variables like ${__P(property)}
 editable_checkbox.true=True
 editable_checkbox.false=False
 email_results_title=Email Results

src/core/src/main/resources/org/apache/jmeter/resources/messages_fr.properties

@@ -311,6 +311,7 @@ duration_assertion_title=Assertion Durée
 duration_tooltip=Temps passé depuis le début du test en cours
 edit=Editer
 edit_as_expression_action=Utiliser l'expression
+edit_as_expression_tooltip=Passer en mode expression pour utiliser des variables comme ${__P(property)}
 email_results_title=Résultat d'email
 en=Anglais
 enable=Activer

src/jorphan/src/main/kotlin/org/apache/jorphan/gui/JEditableCheckBox.kt

@@ -92,6 +92,8 @@ public open class JEditableCheckBox(
     public data class Configuration(
         /** Menu item title to "start editing" the checkbox value. */
         val useExpression: LocalizedString,
+        /** Tooltip for "start editing" button. */
+        val useExpressionTooltip: LocalizedString,
         /** The title to be used for "true" value in the checkbox. */
         val trueValue: LocalizedString,
         /** The title to be used for "false" value in the checkbox. */
@@ -133,6 +135,12 @@ public open class JEditableCheckBox(
         labelFor = comboBox
     }
 
+    private val expressionButton = JEllipsisButton().apply {
+        // Tooltip will be set via configuration or use default
+        toolTipText = configuration.useExpressionTooltip.toString()
+        addActionListener(useExpressionAction)
+    }
+
     @Transient
     private var changeEvent: ChangeEvent? = null
 
@@ -143,6 +151,7 @@ public open class JEditableCheckBox(
             Container().apply {
                 layout = FlowLayout(FlowLayout.LEADING, 0, 0)
                 add(checkbox)
+                add(expressionButton)
             },
             CHECKBOX_CARD
         )
@@ -165,6 +174,7 @@ public open class JEditableCheckBox(
         super.setEnabled(enabled)
         checkbox.isEnabled = enabled
         comboBox.isEnabled = enabled
+        expressionButton.isEnabled = enabled
         useExpressionAction.isEnabled = enabled
     }
 
@@ -223,6 +233,7 @@ public open class JEditableCheckBox(
 
     public fun makeSmall() {
         JFactory.small(checkbox)
+        JFactory.small(expressionButton)
         // We do not make combobox small as the expression migh be hard to read
     }
 }

src/jorphan/src/main/kotlin/org/apache/jorphan/gui/JEllipsisButton.kt

@@ -0,0 +1,28 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to you under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.jorphan.gui
+
+import javax.swing.plaf.nimbus.NimbusStyle
+
+public class JEllipsisButton : JSquareButton("⋮") {
+    init {
+        putClientProperty("JComponent.sizeVariant", NimbusStyle.SMALL_KEY)
+        putClientProperty("JButton.square", true)
+        putClientProperty("JButton.thin", true)
+    }
+}

src/jorphan/src/main/kotlin/org/apache/jorphan/gui/JSquareButton.kt

@@ -0,0 +1,29 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to you under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.jorphan.gui
+
+import org.jetbrains.annotations.Nls
+import java.awt.Dimension
+import javax.swing.JButton
+
+public open class JSquareButton(title: @Nls String) : JButton(title) {
+    override fun getPreferredSize(): Dimension {
+        val dimension = super.getPreferredSize()
+        return Dimension(dimension.height + 15, dimension.height)
+    }
+}