feat: support localization in JEditableCheckBox

vlsi · vlsi · commit c01ddbee0a76 · 2025-12-01T20:02:37.000+03:00
diff --git a/src/core/src/main/java/org/apache/jmeter/control/gui/TestPlanGui.java b/src/core/src/main/java/org/apache/jmeter/control/gui/TestPlanGui.java
@@ -57,17 +57,20 @@ public class TestPlanGui extends AbstractJMeterGuiComponent {
     private final JBooleanPropertyEditor functionalMode =
             new JBooleanPropertyEditor(
                     TestPlanSchema.INSTANCE.getFunctionalMode(),
-                    JMeterUtils.getResString("functional_mode"));
+                    "functional_mode",
+                    JMeterUtils::getResString);
 
     private final JBooleanPropertyEditor serializedMode =
             new JBooleanPropertyEditor(
                     TestPlanSchema.INSTANCE.getSerializeThreadgroups(),
-                    JMeterUtils.getResString("testplan.serialized"));
+                    "testplan.serialized",
+                    JMeterUtils::getResString);
 
     private final JBooleanPropertyEditor tearDownOnShutdown =
             new JBooleanPropertyEditor(
                     TestPlanSchema.INSTANCE.getTearDownOnShutdown(),
-                    JMeterUtils.getResString("teardown_on_shutdown"));
+                    "teardown_on_shutdown",
+                    JMeterUtils::getResString);
 
     /** A panel allowing the user to define variables. */
     private final ArgumentsPanel argsPanel;
diff --git a/src/core/src/main/java/org/apache/jmeter/control/gui/TransactionControllerGui.java b/src/core/src/main/java/org/apache/jmeter/control/gui/TransactionControllerGui.java
@@ -39,13 +39,15 @@ public class TransactionControllerGui extends AbstractControllerGui {
     private final JBooleanPropertyEditor generateParentSample =
             new JBooleanPropertyEditor(
                     TransactionControllerSchema.INSTANCE.getGenearteParentSample(),
-                    JMeterUtils.getResString("transaction_controller_parent"));
+                    "transaction_controller_parent",
+                    JMeterUtils::getResString);
 
     /** if selected, add duration of timers to total runtime */
     private final JBooleanPropertyEditor includeTimers =
             new JBooleanPropertyEditor(
                     TransactionControllerSchema.INSTANCE.getIncludeTimers(),
-                    JMeterUtils.getResString("transaction_controller_include_timers"));
+                    "transaction_controller_parent",
+                    JMeterUtils::getResString);
 
     /**
      * Create a new TransactionControllerGui instance.
diff --git a/src/core/src/main/java/org/apache/jmeter/threads/gui/ThreadGroupGui.java b/src/core/src/main/java/org/apache/jmeter/threads/gui/ThreadGroupGui.java
@@ -65,7 +65,8 @@ public class ThreadGroupGui extends AbstractThreadGroupGui implements ItemListen
     private final JBooleanPropertyEditor scheduler =
             new JBooleanPropertyEditor(
                     ThreadGroupSchema.INSTANCE.getUseScheduler(),
-                    JMeterUtils.getResString("scheduler"));
+                    "scheduler",
+                    JMeterUtils::getResString);
 
     private final JTextField duration = new JTextField();
     private final JLabel durationLabel = labelFor(duration, "duration");
@@ -76,7 +77,8 @@ public class ThreadGroupGui extends AbstractThreadGroupGui implements ItemListen
     private final JBooleanPropertyEditor sameUserBox =
             new JBooleanPropertyEditor(
                     AbstractThreadGroupSchema.INSTANCE.getSameUserOnNextIteration(),
-                    JMeterUtils.getResString("threadgroup_same_user"));
+                    "threadgroup_same_user",
+                    JMeterUtils::getResString);
 
     public ThreadGroupGui() {
         this(true);
@@ -199,7 +201,8 @@ private void init() { // WARNING: called from ctor so must not be overridden (i.
         if (showDelayedStart) {
             delayedStart = new JBooleanPropertyEditor(
                     ThreadGroupSchema.INSTANCE.getDelayedStart(),
-                    JMeterUtils.getResString("delayed_start")); // $NON-NLS-1$
+                    "delayed_start",
+                    JMeterUtils::getResString); // $NON-NLS-1$
             threadPropsPanel.add(delayedStart, "span 2");
         }
         scheduler.addPropertyChangeListener(
diff --git a/src/core/src/main/kotlin/org/apache/jmeter/gui/JBooleanPropertyEditor.kt b/src/core/src/main/kotlin/org/apache/jmeter/gui/JBooleanPropertyEditor.kt
@@ -20,9 +20,12 @@ package org.apache.jmeter.gui
 import org.apache.jmeter.testelement.TestElement
 import org.apache.jmeter.testelement.property.BooleanProperty
 import org.apache.jmeter.testelement.schema.BooleanPropertyDescriptor
-import org.apache.jmeter.util.JMeterUtils
 import org.apache.jorphan.gui.JEditableCheckBox
+import org.apache.jorphan.locale.LocalizedString
+import org.apache.jorphan.locale.PlainValue
+import org.apache.jorphan.locale.ResourceLocalizer
 import org.apiguardian.api.API
+import org.jetbrains.annotations.NonNls
 
 /**
  * Provides editor component for boolean properties that accommodate both true/false and expression string.
@@ -31,19 +34,20 @@ import org.apiguardian.api.API
 @API(status = API.Status.EXPERIMENTAL, since = "5.6")
 public class JBooleanPropertyEditor(
     private val propertyDescriptor: BooleanPropertyDescriptor<*>,
-    label: String,
-) : JEditableCheckBox(label, DEFAULT_CONFIGURATION), Binding {
+    label: @NonNls String,
+    resourceLocalizer: ResourceLocalizer,
+) : JEditableCheckBox(label, createConfiguration(resourceLocalizer), resourceLocalizer), Binding {
     private companion object {
-        @JvmField
-        val DEFAULT_CONFIGURATION: Configuration = Configuration(
-            startEditing = JMeterUtils.getResString("editable_checkbox.use_expression"),
-            trueValue = "true",
-            falseValue = "false",
-            extraValues = listOf(
-                "\${__P(property_name)}",
-                "\${variable_name}",
+        private fun createConfiguration(resourceLocalizer: ResourceLocalizer) =
+            Configuration(
+                useExpression = LocalizedString("edit_as_expression_action", resourceLocalizer),
+                trueValue = LocalizedString("editable_checkbox.true", resourceLocalizer),
+                falseValue = LocalizedString("editable_checkbox.false", resourceLocalizer),
+                extraValues = listOf(
+                    PlainValue("\${__P(property_name)}"),
+                    PlainValue("\${variable_name}"),
+                )
             )
-        )
     }
 
     public fun reset() {
diff --git a/src/core/src/main/resources/org/apache/jmeter/resources/messages.properties b/src/core/src/main/resources/org/apache/jmeter/resources/messages.properties
@@ -315,7 +315,9 @@ duration_assertion_label=Duration in milliseconds\:
 duration_assertion_title=Duration Assertion
 duration_tooltip=Elapsed time of current running Test
 edit=Edit
-editable_checkbox.use_expression=Use Expression
+edit_as_expression_action=Use Expression
+editable_checkbox.true=True
+editable_checkbox.false=False
 email_results_title=Email Results
 en=English
 enable=Enable
diff --git a/src/core/src/main/resources/org/apache/jmeter/resources/messages_fr.properties b/src/core/src/main/resources/org/apache/jmeter/resources/messages_fr.properties
@@ -310,7 +310,7 @@ duration_assertion_label=Durée en millisecondes \:
 duration_assertion_title=Assertion Durée
 duration_tooltip=Temps passé depuis le début du test en cours
 edit=Editer
-editable_checkbox.use_expression=Utiliser l'expression
+edit_as_expression_action=Utiliser l'expression
 email_results_title=Résultat d'email
 en=Anglais
 enable=Activer
diff --git a/src/jorphan/src/main/kotlin/org/apache/jorphan/gui/JEditableCheckBox.kt b/src/jorphan/src/main/kotlin/org/apache/jorphan/gui/JEditableCheckBox.kt
@@ -17,7 +17,13 @@
 
 package org.apache.jorphan.gui
 
+import org.apache.jorphan.locale.ComboBoxValue
+import org.apache.jorphan.locale.LocalizedString
+import org.apache.jorphan.locale.PlainValue
+import org.apache.jorphan.locale.ResourceKeyed
+import org.apache.jorphan.locale.ResourceLocalizer
 import org.apiguardian.api.API
+import org.jetbrains.annotations.NonNls
 import java.awt.Container
 import java.awt.FlowLayout
 import java.awt.event.ActionEvent
@@ -28,7 +34,6 @@ import javax.swing.JComboBox
 import javax.swing.JLabel
 import javax.swing.JPanel
 import javax.swing.JPopupMenu
-import javax.swing.SwingUtilities
 import javax.swing.event.ChangeEvent
 
 /**
@@ -37,8 +42,9 @@ import javax.swing.event.ChangeEvent
  */
 @API(status = API.Status.EXPERIMENTAL, since = "5.6")
 public open class JEditableCheckBox(
-    label: String,
-    private val configuration: Configuration
+    label: @NonNls String,
+    private val configuration: Configuration,
+    resourceLocalizer: ResourceLocalizer,
 ) : JPanel() {
     public companion object {
         public const val CHECKBOX_CARD: String = "checkbox"
@@ -82,28 +88,29 @@ public open class JEditableCheckBox(
     /**
      * Supplies the parameters to [JEditableCheckBox].
      */
+    @API(status = API.Status.EXPERIMENTAL, since = "5.6.0")
     public data class Configuration(
         /** Menu item title to "start editing" the checkbox value. */
-        val startEditing: String = "Use Expression",
+        val useExpression: LocalizedString,
         /** The title to be used for "true" value in the checkbox. */
-        val trueValue: String = "true",
+        val trueValue: LocalizedString,
         /** The title to be used for "false" value in the checkbox. */
-        val falseValue: String = "false",
+        val falseValue: LocalizedString,
         /** Extra values to be added for the combobox. */
-        val extraValues: List<String> = listOf(),
+        val extraValues: List<ComboBoxValue> = listOf(),
     )
 
     private val cards = CardLayoutWithSizeOfCurrentVisibleElement()
 
-    private val useExpressionAction = object : AbstractAction(configuration.startEditing) {
+    private val useExpressionAction = object : AbstractAction(configuration.useExpression.toString()) {
         override fun actionPerformed(e: ActionEvent?) {
             cards.next(this@JEditableCheckBox)
+            comboBox.selectedItem = if (checkbox.isSelected) configuration.trueValue else configuration.falseValue
             comboBox.requestFocusInWindow()
-            fireValueChanged()
         }
     }
 
-    private val checkbox: JCheckBox = JCheckBox(label).apply {
+    private val checkbox: JCheckBox = JCheckBox(resourceLocalizer.localize(label)).apply {
         val cb = this
         componentPopupMenu = JPopupMenu().apply {
             add(useExpressionAction)
@@ -113,34 +120,16 @@ public open class JEditableCheckBox(
         }
     }
 
-    private val comboBox: JComboBox<String> = JComboBox<String>().apply {
+    private val comboBox: JComboBox<ComboBoxValue> = JComboBox<ComboBoxValue>().apply {
         isEditable = true
         configuration.extraValues.forEach {
             addItem(it)
         }
         addItem(configuration.trueValue)
         addItem(configuration.falseValue)
-        addActionListener {
-            val jComboBox = it.source as JComboBox<*>
-            SwingUtilities.invokeLater {
-                if (jComboBox.isPopupVisible) {
-                    fireValueChanged()
-                    return@invokeLater
-                }
-                when (val value = jComboBox.selectedItem as String) {
-                    configuration.trueValue, configuration.falseValue -> {
-                        checkbox.isSelected = value == configuration.trueValue
-                        cards.show(this@JEditableCheckBox, CHECKBOX_CARD)
-                        checkbox.requestFocusInWindow()
-                        fireValueChanged()
-                    }
-                }
-            }
-        }
-        // TODO: trigger value changed when the text is changed
     }
 
-    private val textFieldLabel = JLabel(label).apply {
+    private val textFieldLabel = JLabel(resourceLocalizer.localize(label)).apply {
         labelFor = comboBox
     }
 
@@ -190,19 +179,26 @@ public open class JEditableCheckBox(
     public var value: Value
         get() = when (components.indexOfFirst { it.isVisible }) {
             0 -> if (checkbox.isSelected) Value.Boolean.TRUE else Value.Boolean.FALSE
-            else -> Value.Text(comboBox.selectedItem as String)
+            else ->
+                when (val value = comboBox.selectedItem) {
+                    is ResourceKeyed ->
+                        when (value.resourceKey) {
+                            configuration.trueValue.resourceKey -> Value.Boolean.TRUE
+                            configuration.falseValue.resourceKey -> Value.Boolean.FALSE
+                            else -> Value.Text(value.resourceKey)
+                        }
+                    else -> Value.Text(value?.toString() ?: "")
+                }
         }
         set(value) {
             when (value) {
                 is Value.Boolean -> {
-                    comboBox.selectedItem = ""
                     checkbox.isSelected = value.value
                     cards.show(this, CHECKBOX_CARD)
                 }
 
                 is Value.Text -> {
-                    checkbox.isSelected = false
-                    comboBox.selectedItem = value.value
+                    comboBox.selectedItem = PlainValue(value.value)
                     cards.show(this, EDITABLE_CARD)
                 }
             }
diff --git a/src/protocol/http/src/main/java/org/apache/jmeter/protocol/http/config/gui/HttpDefaultsGui.java b/src/protocol/http/src/main/java/org/apache/jmeter/protocol/http/config/gui/HttpDefaultsGui.java
@@ -61,14 +61,17 @@ public class HttpDefaultsGui extends AbstractConfigGui {
     private UrlConfigGui urlConfigGui;
     private final JBooleanPropertyEditor retrieveEmbeddedResources = new JBooleanPropertyEditor(
             HTTPSamplerBaseSchema.INSTANCE.getRetrieveEmbeddedResources(),
-            JMeterUtils.getResString("web_testing_retrieve_images"));
+            "web_testing_retrieve_images",
+            JMeterUtils::getResString);
     private final JBooleanPropertyEditor concurrentDwn = new JBooleanPropertyEditor(
             HTTPSamplerBaseSchema.INSTANCE.getConcurrentDownload(),
-            JMeterUtils.getResString("web_testing_concurrent_download"));
+            "web_testing_concurrent_download",
+            JMeterUtils::getResString);
     private JTextField concurrentPool;
     private final JBooleanPropertyEditor useMD5 = new JBooleanPropertyEditor(
             HTTPSamplerBaseSchema.INSTANCE.getStoreAsMD5(),
-            JMeterUtils.getResString("response_save_as_md5")); // $NON-NLS-1$
+            "response_save_as_md5",
+            JMeterUtils::getResString); // $NON-NLS-1$
     private JTextField embeddedAllowRE; // regular expression used to match against embedded resource URLs to allow
     private JTextField embeddedExcludeRE; // regular expression used to match against embedded resource URLs to discard
     private JTextField sourceIpAddr; // does not apply to Java implementation
diff --git a/src/protocol/http/src/main/java/org/apache/jmeter/protocol/http/config/gui/UrlConfigGui.java b/src/protocol/http/src/main/java/org/apache/jmeter/protocol/http/config/gui/UrlConfigGui.java
@@ -380,19 +380,22 @@ protected Component getPathPanel() {
 
             useKeepAlive = new JBooleanPropertyEditor(
                     HTTPSamplerBaseSchema.INSTANCE.getUseKeepalive(),
-                    JMeterUtils.getResString("use_keepalive"));
+                    "use_keepalive",
+                    JMeterUtils::getResString);
             JFactory.small(useKeepAlive);
             useKeepAlive.setVisible(getUrlConfigDefaults().isUseKeepAliveVisible());
 
             useMultipart = new JBooleanPropertyEditor(
                     HTTPSamplerBaseSchema.INSTANCE.getUseMultipartPost(),
-                    JMeterUtils.getResString("use_multipart_for_http_post")); // $NON-NLS-1$
+                    "use_multipart_for_http_post",
+                    JMeterUtils::getResString);
             JFactory.small(useMultipart);
             useMultipart.setVisible(getUrlConfigDefaults().isUseMultipartVisible());
 
             useBrowserCompatibleMultipartMode = new JBooleanPropertyEditor(
                     HTTPSamplerBaseSchema.INSTANCE.getUseBrowserCompatibleMultipart(),
-                    JMeterUtils.getResString("use_multipart_mode_browser")); // $NON-NLS-1$
+                    "use_multipart_mode_browser",
+                    JMeterUtils::getResString);
             JFactory.small(useBrowserCompatibleMultipartMode);
             useBrowserCompatibleMultipartMode.setVisible(getUrlConfigDefaults().isUseBrowserCompatibleMultipartModeVisible());
         }
diff --git a/src/protocol/http/src/main/java/org/apache/jmeter/protocol/http/control/gui/HttpTestSampleGui.java b/src/protocol/http/src/main/java/org/apache/jmeter/protocol/http/control/gui/HttpTestSampleGui.java
@@ -63,14 +63,17 @@ public class HttpTestSampleGui extends AbstractSamplerGui {
     private UrlConfigGui urlConfigGui;
     private final JBooleanPropertyEditor retrieveEmbeddedResources = new JBooleanPropertyEditor(
             HTTPSamplerBaseSchema.INSTANCE.getRetrieveEmbeddedResources(),
-            JMeterUtils.getResString("web_testing_retrieve_images"));
+            "web_testing_retrieve_images",
+            JMeterUtils::getResString);
     private final JBooleanPropertyEditor concurrentDwn = new JBooleanPropertyEditor(
             HTTPSamplerBaseSchema.INSTANCE.getConcurrentDownload(),
-            JMeterUtils.getResString("web_testing_concurrent_download"));
+            "web_testing_concurrent_download",
+            JMeterUtils::getResString);
     private JTextField concurrentPool;
     private final JBooleanPropertyEditor useMD5 = new JBooleanPropertyEditor(
             HTTPSamplerBaseSchema.INSTANCE.getStoreAsMD5(),
-            JMeterUtils.getResString("response_save_as_md5")); // $NON-NLS-1$
+            "response_save_as_md5",
+            JMeterUtils::getResString);
     private JTextField embeddedAllowRE; // regular expression used to match against embedded resource URLs to allow
     private JTextField embeddedExcludeRE; // regular expression used to match against embedded resource URLs to exclude
     private JTextField sourceIpAddr; // does not apply to Java implementation
diff --git a/src/protocol/java/src/main/java/org/apache/jmeter/protocol/java/control/gui/BeanShellSamplerGui.java b/src/protocol/java/src/main/java/org/apache/jmeter/protocol/java/control/gui/BeanShellSamplerGui.java
@@ -49,7 +49,8 @@ public class BeanShellSamplerGui extends AbstractSamplerGui {
     private final JBooleanPropertyEditor resetInterpreter =
             new JBooleanPropertyEditor(
                     BeanShellSamplerSchema.INSTANCE.getResetInterpreter(),
-                    JMeterUtils.getResString("bsh_script_reset_interpreter"));
+                    "bsh_script_reset_interpreter",
+                    JMeterUtils::getResString);
 
     private final FilePanelEntry filename = new FilePanelEntry(JMeterUtils.getResString("bsh_script_file"),".bsh"); // script file name (if present)
 
