Merge pull request #2780 from bardsoftware/dbarashev/refactor-wizard-impl

Exporter chooser page rewritten in JavaFX

Author: dbarashev

biz.ganttproject.core/src/main/java/biz/ganttproject/app/FXThread.kt

@@ -0,0 +1,77 @@
+/*
+Copyright 2026 Dmitry Barashev,  BarD Software s.r.o
+
+This file is part of GanttProject, an open-source project management tool.
+
+GanttProject is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+GanttProject is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with GanttProject.  If not, see <http://www.gnu.org/licenses/>.
+*/
+package biz.ganttproject.app
+
+import javafx.application.Platform
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.Dispatchers
+import kotlinx.coroutines.delay
+import kotlinx.coroutines.javafx.JavaFx
+import kotlinx.coroutines.launch
+
+/**
+ * A collection of utility functions for interacting with the JavaFX thread.
+ */
+object FXThread {
+  private var isJavaFxAvailable: Boolean? = null
+  fun runLater(delayMs: Long, code: ()->Unit) {
+    fxScope.launch {
+      delay(delayMs)
+      runLater { code() }
+    }
+  }
+  fun runLater(code: () -> Unit) {
+    val javafxOk = isJavaFxAvailable ?: run {
+      try {
+        Platform.runLater {}
+        true
+      } catch (ex: java.lang.IllegalStateException) {
+        false
+      }
+    }
+    isJavaFxAvailable = javafxOk
+    if (javafxOk) {
+      if (Platform.isFxApplicationThread()){
+        code()
+      } else {
+        Platform.runLater(code)
+      }
+    } else {
+      code()
+    }
+  }
+
+  fun startup(code: () -> Unit) {
+    val javafxOk = isJavaFxAvailable ?: run {
+      try {
+        Platform.runLater {}
+        true
+      } catch (ex: java.lang.IllegalStateException) {
+        false
+      }
+    }
+    if (javafxOk) {
+      Platform.runLater(code)
+    } else {
+      Platform.startup(code)
+    }
+  }
+}
+
+private val fxScope = CoroutineScope(Dispatchers.JavaFx)

biz.ganttproject.core/src/main/java/biz/ganttproject/app/InternationalizationCore.kt

@@ -0,0 +1,227 @@
+/*
+Copyright 2019-2026 Dmitry Barashev, BarD Software s.r.o
+
+This file is part of GanttProject, an opensource project management tool.
+
+GanttProject is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+GanttProject is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with GanttProject.  If not, see <http://www.gnu.org/licenses/>.
+*/
+package biz.ganttproject.app
+
+import biz.ganttproject.core.option.validatorI18N
+import javafx.beans.property.SimpleObjectProperty
+import javafx.beans.property.SimpleStringProperty
+import javafx.beans.value.ObservableValue
+import java.text.MessageFormat
+import java.util.*
+
+/**
+ * Localized string is an observable localized string with parameters.
+ * The typical use case is:
+ * 1. Client code creates string from key, e.g. "hello", and passes argument "World"
+ * 2. Internationalization code here searches for "hello" key in the localizer (it is usually a resource bundle)
+ *    and finds e.g. "Hello {0}" pattern
+ * 3. Pattern is applied to the arguments and we get "Hello World" which becomes a new value of observable
+ * 4. Client code then updates the arguments and passes "GanttProject". The process repeats and new observable
+ *    value "Hello GanttProject" is submitted.
+ *
+ * Normally instances are created with a factory in Localizer.
+ */
+class LocalizedString(
+    private val key: String,
+    private val i18n: Localizer,
+    val observable: SimpleStringProperty = SimpleStringProperty(),
+    private var args: List<Any> = emptyList()) : ObservableValue<String> by observable {
+  init {
+    observable.value = build()
+  }
+
+  fun clear() {
+    observable.value = ""
+  }
+
+  fun update(vararg args: String): LocalizedString {
+    this.args = args.toList()
+    observable.value = build()
+    return this
+  }
+
+  fun update(vararg args: Any): LocalizedString {
+    this.args = args.toList()
+    observable.value = build()
+    return this
+  }
+
+  internal fun update() {
+    observable.value = build()
+  }
+
+  private fun build(): String = i18n.formatText(key, *(args.toTypedArray()))
+}
+
+/**
+ * Creates localized observable strings, formats messages with parameters and manages current translation.
+ */
+interface Localizer {
+  /**
+   * Creates a new localized string from the given message key.
+   */
+  fun create(key: String): LocalizedString
+
+  /**
+   * Applies pattern by the given key to the given arguments. By default, it calls formatTextOrNull
+   * and returns key itself if the latter returns null
+   */
+  fun formatText(key: String, vararg args: Any): String {
+    return formatTextOrNull(key, *args) ?: key
+  }
+
+  /**
+   * Searches for message by the given key and applies it to the given arguments.
+   * Returns null if message is not found.
+   */
+  fun formatTextOrNull(key: String, vararg args: Any): String?
+}
+
+/**
+ * This is a dummy localizer which can be used as a stub.
+ */
+object DummyLocalizer : Localizer {
+  override fun create(key: String): LocalizedString {
+    return LocalizedString(key, this)
+  }
+
+  override fun formatTextOrNull(key: String, vararg args: Any): String? {
+    return null
+  }
+}
+
+var DEFAULT_TRANSLATION_LOCALIZER: Localizer = DummyLocalizer
+
+/**
+ * This localizer allows for flexible use of shared resource bundles.
+ * When searching for a message by the given message key, it first prepends the rootKey prefix to the
+ * message key. If prefixed localizer is set, it is consulted first. This way we can just
+ * use shorter message keys for a group of logically related keys (e.g. use root key "exitDialog" and
+ * keys "title", "message", "ok" instead of "exitDialog.title", "exitDialog.message" and "exitDialog.ok").
+ *
+ * If root localizer is not set or returns no message, the message is searched by prefixed key in the local
+ * resource bundle of this localizer. In case of success it is formatted with MessageFormat, otherwise
+ * base localizer is consulted with original message key. This way we can use a pool of common messages
+ * which is shared between more specific localizers. E.g., for a set of dialogs where submit and cancel
+ * buttons are usually labeled with "OK" and "Cancel", we can create a shared base localizer L0 with keys
+ * "ok" and "cancel". For a dialog which requests user to accept some terms, we can create a localizer L1
+ * with root key "acceptTerms", key "acceptTerms.ok"="Accept" and L0 as a base localizer.
+ *
+ * When submit and cancel buttons in accept terms dialog are constructed, they will call localizer L1
+ * and pass "ok" and "cancel" keys. L1 will find "acceptTerms.ok" in its own bundle and will pass "cancel"
+ * to the base localizer.
+ *
+ * @author dbarashev@bardsoftware.com
+ */
+open class DefaultLocalizer(
+    private val rootKey: String = "",
+    private val baseLocalizer: Localizer = DEFAULT_TRANSLATION_LOCALIZER,
+    private val prefixedLocalizer: Localizer? = null,
+    private val currentTranslation: SimpleObjectProperty<Translation?> = SimpleObjectProperty(null)) : Localizer {
+
+  override fun create(key: String): LocalizedString {
+    return LocalizedString(key, this).also {
+      currentTranslation.addListener { _, oldValue, newValue ->
+        FXThread.runLater {
+          if (oldValue?.locale != newValue?.locale) {
+            it.update()
+          }
+        }
+      }
+    }
+  }
+
+  override fun formatTextOrNull(key: String, vararg args: Any): String? {
+    val prefixedKey = if (this.rootKey != "") "${this.rootKey}.$key" else key
+    this.prefixedLocalizer?.formatTextOrNull(prefixedKey, *args)?.let {
+      return it
+    }
+    return try {
+      this.currentTranslation.value?.let { tr ->
+        tr.mapKey(prefixedKey)?.let { value ->
+          MessageFormat.format(value, *args)
+        } ?: this.baseLocalizer.formatTextOrNull(key, *args)
+      }
+    } catch (ex: MissingResourceException) {
+      null
+    }
+  }
+
+  /**
+   * Creates a new localizer which uses this one as "prefixed" with the given prefix.
+   */
+  fun createWithRootKey(rootKey: String, baseLocalizer: Localizer = DummyLocalizer): DefaultLocalizer =
+      DefaultLocalizer(rootKey, baseLocalizer, this, this.currentTranslation)
+}
+
+/**
+ * Localizer that appends a prefix to all keys and searches for the prefixed key in the `base` localizer.
+ * Uses a `fallback` localizer if the prefixed key is not found in the base localizer.
+ */
+class PrefixedLocalizer(
+  private val prefix: String, private val base: Localizer, private val fallback: Localizer = DummyLocalizer
+): Localizer {
+  override fun create(key: String): LocalizedString = LocalizedString(key, this)
+
+  override fun formatTextOrNull(key: String, vararg args: Any): String? {
+    return this.base.formatTextOrNull("$prefix.$key", *args) ?: this.fallback.formatTextOrNull(key, *args)
+  }
+
+  override fun toString(): String {
+    return "PrefixedLocalizer(prefix='$prefix', base=$base)"
+  }
+}
+
+class IfNullLocalizer(private val base: Localizer, private val fallback: Localizer): Localizer {
+  override fun create(key: String): LocalizedString = LocalizedString(key, this)
+
+  override fun formatTextOrNull(key: String, vararg args: Any): String? {
+    return this.base.formatTextOrNull(key, *args) ?: this.fallback.formatTextOrNull(key, *args)
+  }
+}
+/**
+ * This localizer searches for key values in a map. The map values are lambdas which
+ * allows for values calculation.
+ */
+class MappingLocalizer(val key2lambda: Map<String, ()->LocalizedString?>, val unhandledKey: (String)->LocalizedString?) : Localizer {
+  override fun create(key: String) = LocalizedString(key, this)
+
+  override fun formatTextOrNull(key: String, vararg args: Any): String? =
+    key2lambda[key]?.invoke()?.update(*args)?.value ?: unhandledKey(key)?.update(*args)?.value
+}
+
+/**
+ * Localizer which always uses the given resource bundle.
+ */
+class SingleTranslationLocalizer(val bundle: Translation) : DefaultLocalizer(currentTranslation = SimpleObjectProperty(bundle), baseLocalizer = DummyLocalizer)
+
+
+val ourCurrentTranslation: SimpleObjectProperty<Translation?> = SimpleObjectProperty(null)
+var RootLocalizer : DefaultLocalizer = DefaultLocalizer(currentTranslation = ourCurrentTranslation).also {
+  validatorI18N = it::formatText
+}
+
+fun createDefaultLocalizer(fallback: Localizer): DefaultLocalizer {
+  return DefaultLocalizer(baseLocalizer = fallback, currentTranslation = ourCurrentTranslation)
+}
+
+/**
+ * Structure representing a translation with a locale and mapping function that maps translation keys to translations.
+ */
+data class Translation(val locale: Locale, val mapKey: (String) -> String?)

biz.ganttproject.core/src/main/java/biz/ganttproject/core/option/DefaultEnumerationOption.java

@@ -32,6 +32,12 @@ public DefaultEnumerationOption(String id, T[] values) {
     reloadValues(Arrays.asList(values));
   }
 
+  public DefaultEnumerationOption(String id, List<T> values) {
+    super(id);
+    myValues = new ArrayList<>();
+    reloadValues(values);
+  }
+
   protected void reloadValues(List<T> values) {
     List<String> oldValues = new ArrayList<>(myValues);
     myValues.clear();

biz.ganttproject.core/src/main/java/biz/ganttproject/core/option/GPOption.java

@@ -52,4 +52,7 @@ public interface GPOption<T> {
   @Nullable ValueValidator<T> getValidator();
 
   void setValidator(ValueValidator<T> validator);
+
+  default void visitPropertyPaneBuilder(PropertyPaneBuilder builder) {
+  }
 }

biz.ganttproject.core/src/main/java/biz/ganttproject/core/option/ObservableProperty.kt

@@ -101,8 +101,10 @@ class ObservableString(
 class ObservableBoolean(id: String, initValue: Boolean = false)
   : ObservableProperty<Boolean>(id,initValue)
 
-class ObservableEnum<E : Enum<E>>(id: String, initValue: E, val allValues: Array<E>)
-  : ObservableProperty<E>(id,initValue)
+class ObservableEnum<E : Enum<E>>(id: String, initValue: E, val allValues: List<E>)
+  : ObservableProperty<E>(id,initValue) {
+  constructor(id: String, initValue: E, allValues: Array<E>) : this(id, initValue, allValues.toList())
+}
 
 class ObservableChoice<T>(id: String, initValue: T, val allValues: List<T>, val converter: StringConverter<T>)
   : ObservableProperty<T>(id, initValue)