Merge pull request #12 from MEFRREEX/feature/tooltips

MEFRREEX · web-flow · commit 6d5f51a0f7c3 · 2025-06-21T11:02:34.000+04:00
feat: added api for element tooltips + refactor: remove debug command
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,6 @@
+# 3.1.0
+1. Added API for tooltips for custom elements (`ElementTooltip#getTooltip()` and `ElementTooltip#setTooltip(String tooltip)`)
+
 # 3.0.0
 1. Removed useless [constructors](https://github.com/MEFRREEX/FormConstructor/commit/a5ebafd0ae5fc3f7c9fb7a21d036b05662543814) and [methods](https://github.com/MEFRREEX/FormConstructor/commit/d080f3d4906064d439e0c6597dc6e5e6f1cb951a) from CustomForm, ModalForm
 2. Removed dependence on Nukkit forms + added FormService class
diff --git a/README.md b/README.md
@@ -103,7 +103,8 @@ form.addElement(new Header("My Header"))
     .addElement(new Divider())
     .addElement("input", new Input("Input")
         .setPlaceholder("Text")
-        .setDefaultValue("Default value"))
+        .setDefaultValue("Default value")
+        .setTooltip("Input element tooltip"))
     .addElement("slider", new Slider("Slider", 1f, 100f, 1, 1))
     .addElement("stepslider", new StepSlider("Step slider")
         .addStep("1")
@@ -112,7 +113,8 @@ form.addElement(new Header("My Header"))
     .addElement("dropdown", new Dropdown("Dropdown")
         .addElement("Element 1")
         .addElement("Element 2")
-        .addElement("Element 3"))
+        .addElement("Element 3")
+        .setTooltip("Dropdown element tooltip"))
     .addElement("dropdown1", new Dropdown("Second dropdown", elements))
     .addElement("toggle", new Toggle("Toggle"));
 
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -4,7 +4,7 @@ plugins {
 }
 
 group = "com.mefrreex.formconstructor"
-version = "3.0.0"
+version = "3.1.0"
 
 java {
     toolchain {
diff --git a/src/main/java/com/formconstructor/FormConstructor.java b/src/main/java/com/formconstructor/FormConstructor.java
@@ -1,27 +1,11 @@
 package com.formconstructor;
 
-import cn.nukkit.Player;
-import cn.nukkit.Server;
-import cn.nukkit.command.Command;
-import cn.nukkit.command.CommandSender;
 import cn.nukkit.plugin.PluginBase;
-import com.formconstructor.form.CustomForm;
-import com.formconstructor.form.ModalForm;
-import com.formconstructor.form.SimpleForm;
-import com.formconstructor.form.element.SelectableElement;
-import com.formconstructor.form.element.custom.*;
-import com.formconstructor.form.element.general.Divider;
-import com.formconstructor.form.element.general.Header;
-import com.formconstructor.form.element.simple.Button;
-import com.formconstructor.form.element.simple.ImageType;
 import com.formconstructor.handler.FormResponseHandler;
 import com.formconstructor.service.FormService;
 import com.formconstructor.service.FormServiceImpl;
 import lombok.Getter;
 
-import java.util.List;
-import java.util.concurrent.atomic.AtomicInteger;
-
 @Getter
 public class FormConstructor extends PluginBase {
 
@@ -39,23 +23,5 @@ public void onLoad() {
     public void onEnable() {
         this.formService = new FormServiceImpl();
         this.getServer().getPluginManager().registerEvents(new FormResponseHandler(), this);
-        this.getServer().getCommandMap().register("", new Command("test") {
-            @Override
-            public boolean execute(CommandSender sender, String commandLabel, String[] args) {
-                SimpleForm form = new SimpleForm("Sample title");
-
-                AtomicInteger counter = new AtomicInteger();
-
-// For example, let's create a task that will increment the counter by 1 every second
-                Server.getInstance().getScheduler().scheduleRepeatingTask(() -> {
-                    form.setContent("Count is " + counter.get()); // Set form content
-                    form.sendUpdate((Player) sender); // Send a form update
-                    counter.getAndIncrement();
-                }, 20);
-
-                form.send((Player) sender);
-                return false;
-            }
-        });
     }
 }
diff --git a/src/main/java/com/formconstructor/form/element/ElementTooltip.java b/src/main/java/com/formconstructor/form/element/ElementTooltip.java
@@ -0,0 +1,21 @@
+package com.formconstructor.form.element;
+
+/**
+ * This class indicates that the element can contain a tooltip.
+ */
+public interface ElementTooltip {
+
+    /**
+     * Get element tooltip.
+     *
+     * @return Tooltip
+     */
+    String getTooltip();
+
+    /**
+     * Set element tooltip.
+     *
+     * @param tooltip Tooltip to set
+     */
+    Element setTooltip(String tooltip);
+}
diff --git a/src/main/java/com/formconstructor/form/element/custom/Dropdown.java b/src/main/java/com/formconstructor/form/element/custom/Dropdown.java
@@ -2,6 +2,7 @@
 
 import com.formconstructor.form.element.ElementCustom;
 import com.formconstructor.form.element.ElementIdentifiable;
+import com.formconstructor.form.element.ElementTooltip;
 import com.formconstructor.form.element.ElementType;
 import com.formconstructor.form.element.SelectableElement;
 import com.google.gson.annotations.SerializedName;
@@ -13,7 +14,7 @@
 import java.util.List;
 
 @Getter
-public class Dropdown extends ElementIdentifiable implements ElementCustom {
+public class Dropdown extends ElementIdentifiable implements ElementCustom, ElementTooltip {
 
     @SerializedName("default")
     private int defaultIndex;
@@ -25,6 +26,8 @@ public class Dropdown extends ElementIdentifiable implements ElementCustom {
 
     private transient int selectedIndex = -1;
 
+    private String tooltip = "";
+
     public Dropdown() {
         this("");
     }
@@ -85,6 +88,17 @@ public SelectableElement getValue() {
         return elements.isEmpty() ? null : elements.get(selectedIndex);
     }
 
+    @Override
+    public String getTooltip() {
+        return tooltip;
+    }
+
+    @Override
+    public Dropdown setTooltip(String tooltip) {
+        this.tooltip = tooltip;
+        return this;
+    }
+
     @Override
     public boolean respond(Object data) {
         this.selectedIndex = ((Double) data).intValue();
diff --git a/src/main/java/com/formconstructor/form/element/custom/Input.java b/src/main/java/com/formconstructor/form/element/custom/Input.java
@@ -2,6 +2,7 @@
 
 import com.formconstructor.form.element.ElementCustom;
 import com.formconstructor.form.element.ElementIdentifiable;
+import com.formconstructor.form.element.ElementTooltip;
 import com.formconstructor.form.element.ElementType;
 import com.formconstructor.form.element.custom.validator.ValidationField;
 import com.formconstructor.form.element.custom.validator.Validator;
@@ -13,7 +14,7 @@
 import java.util.List;
 
 @Getter
-public class Input extends ElementIdentifiable implements ElementCustom, ValidationField {
+public class Input extends ElementIdentifiable implements ElementCustom, ElementTooltip, ValidationField {
 
     private String placeholder;
 
@@ -26,6 +27,8 @@ public class Input extends ElementIdentifiable implements ElementCustom, Validat
 
     private transient List<Validator> validators;
 
+    private String tooltip = "";
+
     public Input() {
         this("");
     }
@@ -70,6 +73,17 @@ public Input setTrim(boolean trim) {
         return this;
     }
 
+    @Override
+    public String getTooltip() {
+        return tooltip;
+    }
+
+    @Override
+    public Input setTooltip(String tooltip) {
+        this.tooltip = tooltip;
+        return this;
+    }
+
     @Override
     public void validate() {
         validators.forEach(validator -> validator.validate(value));
diff --git a/src/main/java/com/formconstructor/form/element/custom/Slider.java b/src/main/java/com/formconstructor/form/element/custom/Slider.java
@@ -2,12 +2,13 @@
 
 import com.formconstructor.form.element.ElementCustom;
 import com.formconstructor.form.element.ElementIdentifiable;
+import com.formconstructor.form.element.ElementTooltip;
 import com.formconstructor.form.element.ElementType;
 import com.google.gson.annotations.SerializedName;
 import lombok.Getter;
 
 @Getter
-public class Slider extends ElementIdentifiable implements ElementCustom {
+public class Slider extends ElementIdentifiable implements ElementCustom, ElementTooltip {
 
     @SerializedName("default")
     private float defaultValue;
@@ -18,6 +19,8 @@ public class Slider extends ElementIdentifiable implements ElementCustom {
 
     private transient float value = -1;
 
+    private String tooltip = "";
+
     public Slider() {
         this("");
     }
@@ -69,6 +72,17 @@ public Slider setDefaultValue(float defaultValue) {
         return this;
     }
 
+    @Override
+    public String getTooltip() {
+        return tooltip;
+    }
+
+    @Override
+    public Slider setTooltip(String tooltip) {
+        this.tooltip = tooltip;
+        return this;
+    }
+
     @Override
     public boolean respond(Object data) {
         this.value = ((Double) data).floatValue();
diff --git a/src/main/java/com/formconstructor/form/element/custom/StepSlider.java b/src/main/java/com/formconstructor/form/element/custom/StepSlider.java
@@ -2,6 +2,7 @@
 
 import com.formconstructor.form.element.ElementCustom;
 import com.formconstructor.form.element.ElementIdentifiable;
+import com.formconstructor.form.element.ElementTooltip;
 import com.formconstructor.form.element.ElementType;
 import com.formconstructor.form.element.SelectableElement;
 import com.google.gson.annotations.SerializedName;
@@ -13,7 +14,7 @@
 import java.util.List;
 
 @Getter
-public class StepSlider extends ElementIdentifiable implements ElementCustom {
+public class StepSlider extends ElementIdentifiable implements ElementCustom, ElementTooltip {
 
     @SerializedName("default")
     private int defaultIndex;
@@ -26,6 +27,8 @@ public class StepSlider extends ElementIdentifiable implements ElementCustom {
 
     private transient int selectedIndex = -1;
 
+    private String tooltip = "";
+
     public StepSlider() {
         this("");
     }
@@ -86,6 +89,17 @@ public SelectableElement getValue() {
         return (elements.isEmpty() || (elements.size() == 1 && selectedIndex == 1)) ? null : elements.get(selectedIndex);
     }
 
+    @Override
+    public String getTooltip() {
+        return tooltip;
+    }
+
+    @Override
+    public StepSlider setTooltip(String tooltip) {
+        this.tooltip = tooltip;
+        return this;
+    }
+
     @Override
     public boolean respond(Object data) {
         this.selectedIndex = ((Double) data).intValue();
diff --git a/src/main/java/com/formconstructor/form/element/custom/Toggle.java b/src/main/java/com/formconstructor/form/element/custom/Toggle.java
@@ -2,16 +2,19 @@
 
 import com.formconstructor.form.element.ElementCustom;
 import com.formconstructor.form.element.ElementIdentifiable;
+import com.formconstructor.form.element.ElementTooltip;
 import com.formconstructor.form.element.ElementType;
 import com.google.gson.annotations.SerializedName;
 
-public class Toggle extends ElementIdentifiable implements ElementCustom {
+public class Toggle extends ElementIdentifiable implements ElementCustom, ElementTooltip {
 
     @SerializedName("default") 
     private final boolean defaultValue;
 
     private transient boolean value;
 
+    private String tooltip = "";
+
     public Toggle() {
         this("");
     }
@@ -38,6 +41,17 @@ public boolean getValue() {
         return value;
     }
 
+    @Override
+    public String getTooltip() {
+        return tooltip;
+    }
+
+    @Override
+    public Toggle setTooltip(String tooltip) {
+        this.tooltip = tooltip;
+        return this;
+    }
+
     @Override
     public boolean respond(Object data) {
         this.value = (boolean) data;

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@ plugins {`
`4`	`4`	`}`
`5`	`5`
`6`	`6`	`group = "com.mefrreex.formconstructor"`
`7`		`-version = "3.0.0"`
	`7`	`+version = "3.1.0"`
`8`	`8`
`9`	`9`	`java {`
`10`	`10`	`toolchain {`