[1988] Core support for the helpTextProvider

Bug: #1988 Signed-off-by: Pierre-Charles David <pierre-charles.david@obeo.fr>
eclipse-sirius · May 31, 2023 · 10a0143 · 10a0143
1 parent 390180f
commit 10a0143
Show file tree

Hide file tree

Showing 62 changed files with 581 additions and 41 deletions.
diff --git a/...us-components-forms/src/main/java/org/eclipse/sirius/components/forms/AbstractWidget.java b/...us-components-forms/src/main/java/org/eclipse/sirius/components/forms/AbstractWidget.java
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2019, 2022 Obeo.
+ * Copyright (c) 2019, 2023 Obeo.
  * This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v2.0
  * which accompanies this distribution, and is available at
@@ -13,6 +13,7 @@
 package org.eclipse.sirius.components.forms;
 
 import java.util.List;
+import java.util.function.Supplier;
 
 import org.eclipse.sirius.components.forms.validation.Diagnostic;
 
@@ -30,6 +31,8 @@ public abstract class AbstractWidget {
 
     protected List<Diagnostic> diagnostics;
 
+    protected Supplier<String> helpTextProvider;
+
     public String getId() {
         return this.id;
     }
@@ -42,6 +45,14 @@ public String getIconURL() {
         return this.iconURL;
     }
 
+    public boolean isHasHelpText() {
+        return this.helpTextProvider != null;
+    }
+
+    public Supplier<String> getHelpTextProvider() {
+        return this.helpTextProvider;
+    }
+
     public List<Diagnostic> getDiagnostics() {
         return this.diagnostics;
     }

diff --git a/...end/sirius-components-forms/src/main/java/org/eclipse/sirius/components/forms/Button.java b/...end/sirius-components-forms/src/main/java/org/eclipse/sirius/components/forms/Button.java
@@ -96,6 +96,8 @@ public static final class Builder {
 
         private List<Diagnostic> diagnostics;
 
+        private Supplier<String> helpTextProvider;
+
         private Builder(String id) {
             this.id = Objects.requireNonNull(id);
         }
@@ -135,6 +137,11 @@ public Builder diagnostics(List<Diagnostic> diagnostics) {
             return this;
         }
 
+        public Builder helpTextProvider(Supplier<String> helpTextProvider) {
+            this.helpTextProvider = Objects.requireNonNull(helpTextProvider);
+            return this;
+        }
+
         public Button build() {
             Button button = new Button();
             button.id = Objects.requireNonNull(this.id);
@@ -145,6 +152,7 @@ public Button build() {
             button.pushButtonHandler = Objects.requireNonNull(this.pushButtonHandler);
             button.style = this.style; // Optional on purpose
             button.diagnostics = Objects.requireNonNull(this.diagnostics);
+            button.helpTextProvider = this.helpTextProvider;
             return button;
         }
     }

diff --git a/...irius-components-forms/src/main/java/org/eclipse/sirius/components/forms/ChartWidget.java b/...irius-components-forms/src/main/java/org/eclipse/sirius/components/forms/ChartWidget.java
@@ -15,6 +15,7 @@
 import java.text.MessageFormat;
 import java.util.List;
 import java.util.Objects;
+import java.util.function.Supplier;
 
 import org.eclipse.sirius.components.annotations.Immutable;
 import org.eclipse.sirius.components.charts.IChart;
@@ -64,6 +65,8 @@ public static final class Builder {
 
         private List<Diagnostic> diagnostics;
 
+        private Supplier<String> helpTextProvider;
+
         private Builder(String id) {
             this.id = Objects.requireNonNull(id);
         }
@@ -87,14 +90,18 @@ public Builder diagnostics(List<Diagnostic> diagnostics) {
             this.diagnostics = Objects.requireNonNull(diagnostics);
             return this;
         }
-
+        public Builder helpTextProvider(Supplier<String> helpTextProvider) {
+            this.helpTextProvider = Objects.requireNonNull(helpTextProvider);
+            return this;
+        }
         public ChartWidget build() {
             ChartWidget chartWidget = new ChartWidget();
             chartWidget.id = Objects.requireNonNull(this.id);
             chartWidget.label = Objects.requireNonNull(this.label);
             chartWidget.iconURL = this.iconURL;
             chartWidget.chart = Objects.requireNonNull(this.chart);
             chartWidget.diagnostics = Objects.requireNonNull(this.diagnostics);
+            chartWidget.helpTextProvider = this.helpTextProvider;
             return chartWidget;
         }
     }

diff --git a/...d/sirius-components-forms/src/main/java/org/eclipse/sirius/components/forms/Checkbox.java b/...d/sirius-components-forms/src/main/java/org/eclipse/sirius/components/forms/Checkbox.java
@@ -16,6 +16,7 @@
 import java.util.List;
 import java.util.Objects;
 import java.util.function.Function;
+import java.util.function.Supplier;
 
 import org.eclipse.sirius.components.annotations.Immutable;
 import org.eclipse.sirius.components.forms.validation.Diagnostic;
@@ -81,6 +82,8 @@ public static final class Builder {
 
         private List<Diagnostic> diagnostics;
 
+        private Supplier<String> helpTextProvider;
+
         private Builder(String id) {
             this.id = Objects.requireNonNull(id);
         }
@@ -114,7 +117,10 @@ public Builder diagnostics(List<Diagnostic> diagnostics) {
             this.diagnostics = Objects.requireNonNull(diagnostics);
             return this;
         }
-
+        public Builder helpTextProvider(Supplier<String> helpTextProvider) {
+            this.helpTextProvider = Objects.requireNonNull(helpTextProvider);
+            return this;
+        }
         public Checkbox build() {
             Checkbox checkbox = new Checkbox();
             checkbox.id = Objects.requireNonNull(this.id);
@@ -124,6 +130,7 @@ public Checkbox build() {
             checkbox.newValueHandler = Objects.requireNonNull(this.newValueHandler);
             checkbox.style = this.style; // Optional on purpose
             checkbox.diagnostics = Objects.requireNonNull(this.diagnostics);
+            checkbox.helpTextProvider = this.helpTextProvider;
             return checkbox;
         }
     }

diff --git a/...kend/sirius-components-forms/src/main/java/org/eclipse/sirius/components/forms/Image.java b/...kend/sirius-components-forms/src/main/java/org/eclipse/sirius/components/forms/Image.java
@@ -15,6 +15,7 @@
 import java.text.MessageFormat;
 import java.util.List;
 import java.util.Objects;
+import java.util.function.Supplier;
 
 import org.eclipse.sirius.components.annotations.Immutable;
 import org.eclipse.sirius.components.forms.validation.Diagnostic;
@@ -72,6 +73,8 @@ public static final class Builder {
 
         private List<Diagnostic> diagnostics;
 
+        private Supplier<String> helpTextProvider;
+
         private Builder(String id) {
             this.id = Objects.requireNonNull(id);
         }
@@ -100,7 +103,10 @@ public Builder diagnostics(List<Diagnostic> diagnostics) {
             this.diagnostics = Objects.requireNonNull(diagnostics);
             return this;
         }
-
+        public Builder helpTextProvider(Supplier<String> helpTextProvider) {
+            this.helpTextProvider = Objects.requireNonNull(helpTextProvider);
+            return this;
+        }
         public Image build() {
             Image image = new Image();
             image.id = Objects.requireNonNull(this.id);
@@ -109,6 +115,7 @@ public Image build() {
             image.url = Objects.requireNonNull(this.url);
             image.maxWidth = this.maxWidth;
             image.diagnostics = Objects.requireNonNull(this.diagnostics);
+            image.helpTextProvider = this.helpTextProvider;
             return image;
         }
     }

diff --git a/...irius-components-forms/src/main/java/org/eclipse/sirius/components/forms/LabelWidget.java b/...irius-components-forms/src/main/java/org/eclipse/sirius/components/forms/LabelWidget.java
@@ -15,6 +15,7 @@
 import java.text.MessageFormat;
 import java.util.List;
 import java.util.Objects;
+import java.util.function.Supplier;
 
 import org.eclipse.sirius.components.annotations.Immutable;
 import org.eclipse.sirius.components.forms.validation.Diagnostic;
@@ -78,6 +79,8 @@ public static final class Builder {
 
         private List<Diagnostic> diagnostics;
 
+        private Supplier<String> helpTextProvider;
+
         private Builder(String id) {
             this.id = Objects.requireNonNull(id);
         }
@@ -106,7 +109,10 @@ public Builder diagnostics(List<Diagnostic> diagnostics) {
             this.diagnostics = Objects.requireNonNull(diagnostics);
             return this;
         }
-
+        public Builder helpTextProvider(Supplier<String> helpTextProvider) {
+            this.helpTextProvider = Objects.requireNonNull(helpTextProvider);
+            return this;
+        }
         public LabelWidget build() {
             LabelWidget labelWidget = new LabelWidget();
             labelWidget.id = Objects.requireNonNull(this.id);
@@ -115,6 +121,7 @@ public LabelWidget build() {
             labelWidget.value = Objects.requireNonNull(this.value);
             labelWidget.style = this.style; // Optional on purpose
             labelWidget.diagnostics = Objects.requireNonNull(this.diagnostics);
+            labelWidget.helpTextProvider = this.helpTextProvider;
             return labelWidget;
         }
     }

diff --git a/...ckend/sirius-components-forms/src/main/java/org/eclipse/sirius/components/forms/Link.java b/...ckend/sirius-components-forms/src/main/java/org/eclipse/sirius/components/forms/Link.java
@@ -15,6 +15,7 @@
 import java.text.MessageFormat;
 import java.util.List;
 import java.util.Objects;
+import java.util.function.Supplier;
 
 import org.eclipse.sirius.components.annotations.Immutable;
 import org.eclipse.sirius.components.forms.validation.Diagnostic;
@@ -72,6 +73,8 @@ public static final class Builder {
 
         private List<Diagnostic> diagnostics;
 
+        private Supplier<String> helpTextProvider;
+
         private Builder(String id) {
             this.id = Objects.requireNonNull(id);
         }
@@ -100,7 +103,10 @@ public Builder diagnostics(List<Diagnostic> diagnostics) {
             this.diagnostics = Objects.requireNonNull(diagnostics);
             return this;
         }
-
+        public Builder helpTextProvider(Supplier<String> helpTextProvider) {
+            this.helpTextProvider = Objects.requireNonNull(helpTextProvider);
+            return this;
+        }
         public Link build() {
             Link link = new Link();
             link.id = Objects.requireNonNull(this.id);
@@ -109,6 +115,7 @@ public Link build() {
             link.url = Objects.requireNonNull(this.url);
             link.style = this.style; // Optional on purpose
             link.diagnostics = Objects.requireNonNull(this.diagnostics);
+            link.helpTextProvider = this.helpTextProvider;
             return link;
         }
     }

diff --git a/...ckend/sirius-components-forms/src/main/java/org/eclipse/sirius/components/forms/List.java b/...ckend/sirius-components-forms/src/main/java/org/eclipse/sirius/components/forms/List.java
@@ -14,6 +14,7 @@
 
 import java.text.MessageFormat;
 import java.util.Objects;
+import java.util.function.Supplier;
 
 import org.eclipse.sirius.components.annotations.Immutable;
 import org.eclipse.sirius.components.forms.validation.Diagnostic;
@@ -70,6 +71,8 @@ public static final class Builder {
 
         private java.util.List<Diagnostic> diagnostics;
 
+        private Supplier<String> helpTextProvider;
+
         private Builder(String id) {
             this.id = Objects.requireNonNull(id);
         }
@@ -98,7 +101,10 @@ public Builder diagnostics(java.util.List<Diagnostic> diagnostics) {
             this.diagnostics = Objects.requireNonNull(diagnostics);
             return this;
         }
-
+        public Builder helpTextProvider(Supplier<String> helpTextProvider) {
+            this.helpTextProvider = Objects.requireNonNull(helpTextProvider);
+            return this;
+        }
         public List build() {
             List list = new List();
             list.id = Objects.requireNonNull(this.id);
@@ -107,6 +113,7 @@ public List build() {
             list.style = this.style; // Optional on purpose
             list.items = Objects.requireNonNull(this.items);
             list.diagnostics = Objects.requireNonNull(this.diagnostics);
+            list.helpTextProvider = this.helpTextProvider;
             return list;
         }
     }

diff --git a/...irius-components-forms/src/main/java/org/eclipse/sirius/components/forms/MultiSelect.java b/...irius-components-forms/src/main/java/org/eclipse/sirius/components/forms/MultiSelect.java
@@ -16,6 +16,7 @@
 import java.util.List;
 import java.util.Objects;
 import java.util.function.Function;
+import java.util.function.Supplier;
 
 import org.eclipse.sirius.components.annotations.Immutable;
 import org.eclipse.sirius.components.forms.validation.Diagnostic;
@@ -90,6 +91,8 @@ public static final class Builder {
 
         private List<Diagnostic> diagnostics;
 
+        private Supplier<String> helpTextProvider;
+
         private Builder(String id) {
             this.id = Objects.requireNonNull(id);
         }
@@ -129,6 +132,11 @@ public Builder diagnostics(List<Diagnostic> diagnostics) {
             return this;
         }
 
+        public Builder helpTextProvider(Supplier<String> helpTextProvider) {
+            this.helpTextProvider = Objects.requireNonNull(helpTextProvider);
+            return this;
+        }
+
         public MultiSelect build() {
             MultiSelect select = new MultiSelect();
             select.id = Objects.requireNonNull(this.id);
@@ -139,6 +147,7 @@ public MultiSelect build() {
             select.newValuesHandler = Objects.requireNonNull(this.newValuesHandler);
             select.style = this.style; // Optional on purpose
             select.diagnostics = Objects.requireNonNull(this.diagnostics);
+            select.helpTextProvider = this.helpTextProvider;
             return select;
         }
     }

diff --git a/...kend/sirius-components-forms/src/main/java/org/eclipse/sirius/components/forms/Radio.java b/...kend/sirius-components-forms/src/main/java/org/eclipse/sirius/components/forms/Radio.java
@@ -16,6 +16,7 @@
 import java.util.List;
 import java.util.Objects;
 import java.util.function.Function;
+import java.util.function.Supplier;
 
 import org.eclipse.sirius.components.annotations.Immutable;
 import org.eclipse.sirius.components.forms.validation.Diagnostic;
@@ -81,6 +82,8 @@ public static final class Builder {
 
         private List<Diagnostic> diagnostics;
 
+        private Supplier<String> helpTextProvider;
+
         private Builder(String id) {
             this.id = Objects.requireNonNull(id);
         }
@@ -115,6 +118,11 @@ public Builder diagnostics(List<Diagnostic> diagnostics) {
             return this;
         }
 
+        public Builder helpTextProvider(Supplier<String> helpTextProvider) {
+            this.helpTextProvider = Objects.requireNonNull(helpTextProvider);
+            return this;
+        }
+
         public Radio build() {
             Radio radio = new Radio();
             radio.id = Objects.requireNonNull(this.id);
@@ -124,6 +132,7 @@ public Radio build() {
             radio.newValueHandler = Objects.requireNonNull(this.newValueHandler);
             radio.style = this.style; // Optional on purpose
             radio.diagnostics = Objects.requireNonNull(this.diagnostics);
+            radio.helpTextProvider = this.helpTextProvider;
             return radio;
         }
     }