[BasicUI] Implement press & release button (#2536)

Related to openhab/openhab-core#3822 Depends on openhab/openhab-core#4183 Signed-off-by: Laurent Garnier <[email protected]>
openhab · May 6, 2024 · 02024c6 · 02024c6
1 parent 50f2a91
commit 02024c6
Show file tree

Hide file tree

Showing 5 changed files with 51 additions and 13 deletions.
diff --git a/...enhab.ui.basic/src/main/java/org/openhab/ui/basic/internal/render/ButtongridRenderer.java b/...enhab.ui.basic/src/main/java/org/openhab/ui/basic/internal/render/ButtongridRenderer.java
@@ -186,6 +186,7 @@ private String buildButton(String item, @Nullable String lab, String cmd, @Nulla
 
         button = button.replace("%item%", item);
         button = button.replace("%cmd%", escapeHtml(cmd));
+        button = button.replace("%release_cmd%", "");
         String buttonClass = "buttongrid-button";
 
         button = button.replace("%label%", escapeHtml(label));

diff --git a/...org.openhab.ui.basic/src/main/java/org/openhab/ui/basic/internal/render/PageRenderer.java b/...org.openhab.ui.basic/src/main/java/org/openhab/ui/basic/internal/render/PageRenderer.java
@@ -378,6 +378,7 @@ public CharSequence renderSettings() throws RenderException {
     private void buildButton(String label, String cmd, StringBuilder buttons) throws RenderException {
         buttons.append(getSnippet("button") //
                 .replace("%cmd%", escapeHtml(cmd)) //
+                .replace("%release_cmd%", "") //
                 .replace("%label%", escapeHtml(label)) //
                 .replace("%textclass%", "mdl-button-text") //
                 .replace("%icon_snippet%", "") //

diff --git a/...g.openhab.ui.basic/src/main/java/org/openhab/ui/basic/internal/render/SwitchRenderer.java b/...g.openhab.ui.basic/src/main/java/org/openhab/ui/basic/internal/render/SwitchRenderer.java
@@ -134,13 +134,14 @@ public EList<Widget> renderWidget(Widget w, StringBuilder sb, String sitemap) th
                 if (commandDescription != null) {
                     for (CommandOption option : commandDescription.getCommandOptions()) {
                         // Truncate the button label to MAX_LABEL_SIZE characters
-                        buildButton(s, option.getLabel(), option.getCommand(), null, MAX_LABEL_SIZE, item, state,
+                        buildButton(s, option.getLabel(), option.getCommand(), null, null, MAX_LABEL_SIZE, item, state,
                                 buttons);
                     }
                 }
             } else {
                 for (Mapping mapping : s.getMappings()) {
-                    buildButton(s, mapping.getLabel(), mapping.getCmd(), mapping.getIcon(), -1, item, state, buttons);
+                    buildButton(s, mapping.getLabel(), mapping.getCmd(), mapping.getReleaseCmd(), mapping.getIcon(), -1,
+                            item, state, buttons);
                 }
             }
             snippet = snippet.replace("%buttons%", buttons.toString());
@@ -153,17 +154,22 @@ public EList<Widget> renderWidget(Widget w, StringBuilder sb, String sitemap) th
         return ECollections.emptyEList();
     }
 
-    private void buildButton(Switch w, @Nullable String lab, String cmd, @Nullable String icon, int maxLabelSize,
-            @Nullable Item item, @Nullable State state, StringBuilder buttons) throws RenderException {
+    private void buildButton(Switch w, @Nullable String lab, String cmd, @Nullable String releaseCmd,
+            @Nullable String icon, int maxLabelSize, @Nullable Item item, @Nullable State state, StringBuilder buttons)
+            throws RenderException {
         String button = getSnippet("button");
 
         String command = cmd;
+        String releaseCommand = releaseCmd;
         String label = lab == null ? cmd : lab;
 
         if (item instanceof NumberItem && ((NumberItem) item).getDimension() != null) {
             String unit = getUnitForWidget(w);
             if (unit != null) {
                 command = command.replace(UnitUtils.UNIT_PLACEHOLDER, unit);
+                if (releaseCommand != null) {
+                    releaseCommand = releaseCommand.replace(UnitUtils.UNIT_PLACEHOLDER, unit);
+                }
                 label = label.replace(UnitUtils.UNIT_PLACEHOLDER, unit);
             }
         }
@@ -173,6 +179,7 @@ private void buildButton(Switch w, @Nullable String lab, String cmd, @Nullable S
         }
 
         button = button.replace("%cmd%", escapeHtml(command));
+        button = button.replace("%release_cmd%", releaseCommand == null ? "" : escapeHtml(releaseCommand));
         String buttonClass = "";
         button = button.replace("%label%", escapeHtml(label));
         if (icon == null) {

diff --git a/bundles/org.openhab.ui.basic/src/main/resources/snippets/button.html b/bundles/org.openhab.ui.basic/src/main/resources/snippets/button.html
@@ -1,5 +1,6 @@
 <button class="mdl-button mdl-button--raised mdl-js-button mdl-js-ripple-effect %class%" 
 	data-value="%cmd%"
+	data-release-value="%release_cmd%"
 >
 	<span class="%textclass%">%label%</span>
 	%icon_snippet%

diff --git a/bundles/org.openhab.ui.basic/web-src/smarthome.js b/bundles/org.openhab.ui.basic/web-src/smarthome.js
@@ -1178,7 +1178,16 @@
 			});
 		};
 
-		_t.onclick = function() {
+		function emitEvent(value) {
+			window.console.log("send " + value);
+			_t.parentNode.dispatchEvent(createEvent(
+				"control-change", {
+					item: _t.item,
+					value: value
+			}));
+		}
+
+		_t.onClick = function() {
 			/* HTMLButtonElement this */
 			var
 				value = this.getAttribute("data-value") + "";
@@ -1188,11 +1197,14 @@
 				this.classList.add(o.buttonActiveClass);
 			}
 
-			_t.parentNode.dispatchEvent(createEvent(
-				"control-change", {
-					item: _t.item,
-					value: value
-			}));
+			emitEvent(value);
+		};
+
+		_t.onRelease = function() {
+			var
+				value = this.getAttribute("data-release-value") + "";
+
+			emitEvent(value);
 		};
 
 		_t.valueMap = {};
@@ -1296,10 +1308,18 @@
 		_t.buttons.forEach.call(_t.buttons, function(button) {
 			var
 				icon,
-				value = button.getAttribute("data-value") + "";
+				value = button.getAttribute("data-value") + "",
+				releaseValue = button.getAttribute("data-release-value") + "";
 
 			_t.valueMap[value] = button;
-			button.addEventListener("click", _t.onclick);
+			if (releaseValue !== "") {
+				button.addEventListener("touchstart", _t.onClick);
+				button.addEventListener("mousedown", _t.onClick);
+				button.addEventListener("touchend", _t.onRelease);
+				button.addEventListener("mouseup", _t.onRelease);
+			} else {
+				button.addEventListener("click", _t.onClick);
+			}
 
 			icon = button.querySelector("img");
 			if (icon !== null) {
@@ -1311,9 +1331,17 @@
 		_t.destroy = function() {
 			_t.buttons.forEach(function(button) {
 				var
+					releaseValue = button.getAttribute("data-release-value") + "",
 					icon;
 
-				button.removeEventListener("click", _t.onclick);
+				if (releaseValue !== "") {
+					button.removeEventListener("touchstart", _t.onClick);
+					button.removeEventListener("mousedown", _t.onClick);
+					button.removeEventListener("touchend", _t.onRelease);
+					button.removeEventListener("mouseup", _t.onRelease);
+				} else {
+					button.removeEventListener("click", _t.onClick);
+				}
 
 				icon = button.querySelector("img");
 				if (icon !== null) {