From 9ccc90a132ef0c326cdab7347a9e0d6368476b4a Mon Sep 17 00:00:00 2001
From: Laurent Garnier <lg.hc@free.fr>
Date: Tue, 15 Aug 2023 02:26:42 +0200
Subject: [PATCH] Add a new data value in snippets

Signed-off-by: Laurent Garnier <lg.hc@free.fr>
---
 .../ui/basic/internal/render/AbstractWidgetRenderer.java    | 1 +
 .../src/main/resources/snippets/buttons.html                | 1 +
 .../src/main/resources/snippets/colorpicker.html            | 1 +
 .../src/main/resources/snippets/group.html                  | 1 +
 .../src/main/resources/snippets/icon_oh.html                | 2 +-
 .../src/main/resources/snippets/icon_oh_no_state.html       | 2 +-
 .../src/main/resources/snippets/input.html                  | 1 +
 .../src/main/resources/snippets/mapview.html                | 1 +
 .../src/main/resources/snippets/rollerblind.html            | 1 +
 .../src/main/resources/snippets/selection.html              | 1 +
 .../src/main/resources/snippets/setpoint.html               | 1 +
 .../src/main/resources/snippets/slider.html                 | 1 +
 .../src/main/resources/snippets/switch.html                 | 1 +
 .../src/main/resources/snippets/text.html                   | 1 +
 .../src/main/resources/snippets/text_link.html              | 1 +
 .../src/main/resources/snippets/webview.html                | 1 +
 bundles/org.openhab.ui.basic/web-src/smarthome.js           | 6 +++---
 17 files changed, 19 insertions(+), 5 deletions(-)

diff --git a/bundles/org.openhab.ui.basic/src/main/java/org/openhab/ui/basic/internal/render/AbstractWidgetRenderer.java b/bundles/org.openhab.ui.basic/src/main/java/org/openhab/ui/basic/internal/render/AbstractWidgetRenderer.java
index a00b63055d..3815f99069 100644
--- a/bundles/org.openhab.ui.basic/src/main/java/org/openhab/ui/basic/internal/render/AbstractWidgetRenderer.java
+++ b/bundles/org.openhab.ui.basic/src/main/java/org/openhab/ui/basic/internal/render/AbstractWidgetRenderer.java
@@ -128,6 +128,7 @@ protected String preprocessSnippet(String originalSnippet, Widget w, boolean ign
         snippet = snippet.replace("%cells%", String.valueOf(12 / config.getNbColsDesktop()));
         snippet = snippet.replace("%cells_tablet%", String.valueOf(8 / config.getNbColsTablet()));
         snippet = snippet.replace("%widget_id%", itemUIRegistry.getWidgetId(w));
+        snippet = snippet.replace("%icon_with_state%", Boolean.valueOf(!ignoreStateForIcon).toString());
         snippet = snippet.replace("%item%", w.getItem() != null ? w.getItem() : "");
         // Optimization: avoid calling 3 times itemUIRegistry.getLabel(w)
         String text = itemUIRegistry.getLabel(w);
diff --git a/bundles/org.openhab.ui.basic/src/main/resources/snippets/buttons.html b/bundles/org.openhab.ui.basic/src/main/resources/snippets/buttons.html
index 8ad90b5fd9..198a56e386 100644
--- a/bundles/org.openhab.ui.basic/src/main/resources/snippets/buttons.html
+++ b/bundles/org.openhab.ui.basic/src/main/resources/snippets/buttons.html
@@ -15,6 +15,7 @@
 		data-has-value="%has_value%"
 		data-count="%count%"
 		data-widget-id="%widget_id%"
+		data-icon-with-state="%icon_with_state%"
 	>
 		%buttons%
 	</div>
diff --git a/bundles/org.openhab.ui.basic/src/main/resources/snippets/colorpicker.html b/bundles/org.openhab.ui.basic/src/main/resources/snippets/colorpicker.html
index d0af3637ff..767ef95fd8 100644
--- a/bundles/org.openhab.ui.basic/src/main/resources/snippets/colorpicker.html
+++ b/bundles/org.openhab.ui.basic/src/main/resources/snippets/colorpicker.html
@@ -11,6 +11,7 @@
 		data-item="%item%"
 		data-value="%state%"
 		data-widget-id="%widget_id%"
+		data-icon-with-state="%icon_with_state%"
 	>
 		<button class="mdl-button mdl-button--raised mdl-js-button mdl-js-ripple-effect mdl-form__colorpicker--up">
 			<!-- keyboard_arrow_up -->
diff --git a/bundles/org.openhab.ui.basic/src/main/resources/snippets/group.html b/bundles/org.openhab.ui.basic/src/main/resources/snippets/group.html
index 64c190c1dd..5a22bb451e 100644
--- a/bundles/org.openhab.ui.basic/src/main/resources/snippets/group.html
+++ b/bundles/org.openhab.ui.basic/src/main/resources/snippets/group.html
@@ -13,6 +13,7 @@
 		data-item="%item%"
 		data-has-value="%has_value%"
 		data-widget-id="%widget_id%"
+		data-icon-with-state="%icon_with_state%"
 	>
 		<!-- chevron_right -->
 		<i class="material-icons">&#xE5CC;</i>
diff --git a/bundles/org.openhab.ui.basic/src/main/resources/snippets/icon_oh.html b/bundles/org.openhab.ui.basic/src/main/resources/snippets/icon_oh.html
index de19af50bb..53b690ab8d 100644
--- a/bundles/org.openhab.ui.basic/src/main/resources/snippets/icon_oh.html
+++ b/bundles/org.openhab.ui.basic/src/main/resources/snippets/icon_oh.html
@@ -1 +1 @@
-<img data-icon="%icon_set%:%icon_name%" data-static="false" src="../icon/%icon_name_in_url%?state=%state_in_url%&iconset=%icon_set_in_url%&format=%icon_type%&anyFormat=true" />
\ No newline at end of file
+<img data-icon="%icon_set%:%icon_name%" src="../icon/%icon_name_in_url%?state=%state_in_url%&iconset=%icon_set_in_url%&format=%icon_type%&anyFormat=true" />
\ No newline at end of file
diff --git a/bundles/org.openhab.ui.basic/src/main/resources/snippets/icon_oh_no_state.html b/bundles/org.openhab.ui.basic/src/main/resources/snippets/icon_oh_no_state.html
index f568573b32..2effa429a4 100644
--- a/bundles/org.openhab.ui.basic/src/main/resources/snippets/icon_oh_no_state.html
+++ b/bundles/org.openhab.ui.basic/src/main/resources/snippets/icon_oh_no_state.html
@@ -1 +1 @@
-<img data-icon="%icon_set%:%icon_name%" data-static="true" src="../icon/%icon_name_in_url%?iconset=%icon_set_in_url%&format=%icon_type%&anyFormat=true" />
\ No newline at end of file
+<img data-icon="%icon_set%:%icon_name%" src="../icon/%icon_name_in_url%?iconset=%icon_set_in_url%&format=%icon_type%&anyFormat=true" />
\ No newline at end of file
diff --git a/bundles/org.openhab.ui.basic/src/main/resources/snippets/input.html b/bundles/org.openhab.ui.basic/src/main/resources/snippets/input.html
index 14293ea9ba..da929ddf6f 100644
--- a/bundles/org.openhab.ui.basic/src/main/resources/snippets/input.html
+++ b/bundles/org.openhab.ui.basic/src/main/resources/snippets/input.html
@@ -14,6 +14,7 @@
 			data-control-type="input"
 			data-item="%item%"
 			data-widget-id="%widget_id%"
+			data-icon-with-state="%icon_with_state%"
 			data-item-type="%data_type%"
 			data-input-hint="%input_hint%"
 			data-item-state="%item_state%"
diff --git a/bundles/org.openhab.ui.basic/src/main/resources/snippets/mapview.html b/bundles/org.openhab.ui.basic/src/main/resources/snippets/mapview.html
index dffb31cc72..854ecb268f 100644
--- a/bundles/org.openhab.ui.basic/src/main/resources/snippets/mapview.html
+++ b/bundles/org.openhab.ui.basic/src/main/resources/snippets/mapview.html
@@ -11,6 +11,7 @@
 		class="mdl-form__control mdl-form__webview"
 		data-control-type="mapview"
 		data-widget-id="%widget_id%"
+		data-icon-with-state="%icon_with_state%"
 		data-map-url="%map_url%"
 		data-map-zoom="%map_zoom%"
 	>
diff --git a/bundles/org.openhab.ui.basic/src/main/resources/snippets/rollerblind.html b/bundles/org.openhab.ui.basic/src/main/resources/snippets/rollerblind.html
index 7d4a4e191e..24e502a865 100644
--- a/bundles/org.openhab.ui.basic/src/main/resources/snippets/rollerblind.html
+++ b/bundles/org.openhab.ui.basic/src/main/resources/snippets/rollerblind.html
@@ -14,6 +14,7 @@
 		data-item="%item%"
 		data-has-value="%has_value%"
 		data-widget-id="%widget_id%"
+		data-icon-with-state="%icon_with_state%"
 	>
 		<button class="mdl-button mdl-button--raised mdl-js-button mdl-js-ripple-effect mdl-form__rollerblind--up">
 			<!-- keyboard_arrow_up -->
diff --git a/bundles/org.openhab.ui.basic/src/main/resources/snippets/selection.html b/bundles/org.openhab.ui.basic/src/main/resources/snippets/selection.html
index f441d8c306..d5045a8aa3 100644
--- a/bundles/org.openhab.ui.basic/src/main/resources/snippets/selection.html
+++ b/bundles/org.openhab.ui.basic/src/main/resources/snippets/selection.html
@@ -15,6 +15,7 @@
 		data-has-value="%has_value%"
 		data-value-map="%value_map%"
 		data-widget-id="%widget_id%"
+		data-icon-with-state="%icon_with_state%"
 	>
 		<!-- arrow_drop_down -->
 		<i class="material-icons">&#xE5C5;</i>
diff --git a/bundles/org.openhab.ui.basic/src/main/resources/snippets/setpoint.html b/bundles/org.openhab.ui.basic/src/main/resources/snippets/setpoint.html
index 341c7045f9..eef2039d82 100644
--- a/bundles/org.openhab.ui.basic/src/main/resources/snippets/setpoint.html
+++ b/bundles/org.openhab.ui.basic/src/main/resources/snippets/setpoint.html
@@ -17,6 +17,7 @@
 		data-value="%state%"
 		data-unit="%unit%"
 		data-widget-id="%widget_id%"
+		data-icon-with-state="%icon_with_state%"
 	>
 		<button class="mdl-button mdl-button--raised mdl-js-button mdl-js-ripple-effect mdl-form__setpoint--up">
 			<!-- keyboard_arrow_up -->
diff --git a/bundles/org.openhab.ui.basic/src/main/resources/snippets/slider.html b/bundles/org.openhab.ui.basic/src/main/resources/snippets/slider.html
index 0202f49d4f..ac7b4b1c45 100644
--- a/bundles/org.openhab.ui.basic/src/main/resources/snippets/slider.html
+++ b/bundles/org.openhab.ui.basic/src/main/resources/snippets/slider.html
@@ -15,6 +15,7 @@
 		data-unit="%unit%"
 		data-has-value="%has_value%"
 		data-widget-id="%widget_id%"
+		data-icon-with-state="%icon_with_state%"
 	>
 		<input
 			data-freq="%frequency%"
diff --git a/bundles/org.openhab.ui.basic/src/main/resources/snippets/switch.html b/bundles/org.openhab.ui.basic/src/main/resources/snippets/switch.html
index 8a99fcf9f1..fa0e6d4677 100644
--- a/bundles/org.openhab.ui.basic/src/main/resources/snippets/switch.html
+++ b/bundles/org.openhab.ui.basic/src/main/resources/snippets/switch.html
@@ -14,6 +14,7 @@
 		data-item="%item%"
 		data-has-value="%has_value%"
 		data-widget-id="%widget_id%"
+		data-icon-with-state="%icon_with_state%"
 		for="oh-checkbox-%item%"
 	>
 		<input type="checkbox" %checked% id="oh-checkbox-%item%" class="mdl-switch__input" />
diff --git a/bundles/org.openhab.ui.basic/src/main/resources/snippets/text.html b/bundles/org.openhab.ui.basic/src/main/resources/snippets/text.html
index 68540b7195..4eddf1c040 100644
--- a/bundles/org.openhab.ui.basic/src/main/resources/snippets/text.html
+++ b/bundles/org.openhab.ui.basic/src/main/resources/snippets/text.html
@@ -11,6 +11,7 @@
 		data-item="%item%"
 		data-has-value="%has_value%"
 		data-widget-id="%widget_id%"
+		data-icon-with-state="%icon_with_state%"
 	>
 		%value%
 	</div>
diff --git a/bundles/org.openhab.ui.basic/src/main/resources/snippets/text_link.html b/bundles/org.openhab.ui.basic/src/main/resources/snippets/text_link.html
index 18b0ce14f2..b60cd79327 100644
--- a/bundles/org.openhab.ui.basic/src/main/resources/snippets/text_link.html
+++ b/bundles/org.openhab.ui.basic/src/main/resources/snippets/text_link.html
@@ -13,6 +13,7 @@
 		data-item="%item%"
 		data-has-value="%has_value%"
 		data-widget-id="%widget_id%"
+		data-icon-with-state="%icon_with_state%"
 	>
 		<!-- chevron_right -->
 		<i class="material-icons">&#xE5CC;</i>
diff --git a/bundles/org.openhab.ui.basic/src/main/resources/snippets/webview.html b/bundles/org.openhab.ui.basic/src/main/resources/snippets/webview.html
index aab1f5e96d..8f4cfa5b00 100644
--- a/bundles/org.openhab.ui.basic/src/main/resources/snippets/webview.html
+++ b/bundles/org.openhab.ui.basic/src/main/resources/snippets/webview.html
@@ -11,6 +11,7 @@
 		class="mdl-form__control mdl-form__webview"
 		data-control-type="webview"
 		data-widget-id="%widget_id%"
+		data-icon-with-state="%icon_with_state%"
 	>
 		<iframe src="%url%" height="%height%"></iframe>
 	</div>
diff --git a/bundles/org.openhab.ui.basic/web-src/smarthome.js b/bundles/org.openhab.ui.basic/web-src/smarthome.js
index c5e2fd0c91..abc99baa7d 100644
--- a/bundles/org.openhab.ui.basic/web-src/smarthome.js
+++ b/bundles/org.openhab.ui.basic/web-src/smarthome.js
@@ -356,6 +356,7 @@
 		_t.formRow = parentNode.parentNode;
 		_t.item = _t.parentNode.getAttribute(o.itemAttribute);
 		_t.id = _t.parentNode.getAttribute(o.idAttribute);
+		_t.iconWithState = _t.parentNode.getAttribute(o.iconWithStateAttribute) === "true";
 		_t.iconContainer = _t.parentNode.parentNode.querySelector(o.formIcon);
 		_t.icon = _t.parentNode.parentNode.querySelector(o.formIconImg);
 		_t.visible = !_t.formRow.classList.contains(o.formRowHidden);
@@ -375,7 +376,6 @@
 		}
 
 		if (_t.icon !== null) {
-			_t.staticIcon = _t.icon.getAttribute(o.staticAttribute) === "true";
 			splittedIconAttr = _t.icon.getAttribute(o.iconAttribute).split(":");
 			_t.iconSet = splittedIconAttr[0];
 			_t.iconName = splittedIconAttr[1];
@@ -433,7 +433,7 @@
 				src;
 
 			// Some widgets don't have icons
-			if (_t.icon !== null && !_t.staticIcon) {
+			if (_t.icon !== null && _t.iconWithState) {
 				if (state.length < 200) {
 					src = "/icon/" + encodeURIComponent(_t.iconName) +
 						"?state=" + encodeURIComponent(state) +
@@ -2736,7 +2736,7 @@
 	idAttribute: "data-widget-id",
 	iconAttribute: "data-icon",
 	iconTypeAttribute: "data-icon-type",
-	staticAttribute: "data-static",
+	iconWithStateAttribute: "data-icon-with-state",
 	inlineSvgAttribute: "data-inline-svg",
 	primaryColorAttribute: "data-primary-color",
 	secondaryColorAttribute: "data-secondary-color",