forked from openhab/openhab-webui
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[BasicUI] Implement Buttongrid widget
Related to openhab/openhab-core#3441 Signed-off-by: Laurent Garnier <[email protected]>
- Loading branch information
Showing
7 changed files
with
232 additions
and
6 deletions.
There are no files selected for viewing
178 changes: 178 additions & 0 deletions
178
...enhab.ui.basic/src/main/java/org/openhab/ui/basic/internal/render/ButtongridRenderer.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,178 @@ | ||
| /** | ||
| * Copyright (c) 2010-2023 Contributors to the openHAB project | ||
| * | ||
| * See the NOTICE file(s) distributed with this work for additional | ||
| * information. | ||
| * | ||
| * This program and the accompanying materials are made available under the | ||
| * terms of the Eclipse Public License 2.0 which is available at | ||
| * http://www.eclipse.org/legal/epl-2.0 | ||
| * | ||
| * SPDX-License-Identifier: EPL-2.0 | ||
| */ | ||
| package org.openhab.ui.basic.internal.render; | ||
|
|
||
| import java.util.HashMap; | ||
| import java.util.Map; | ||
|
|
||
| import org.eclipse.emf.common.util.ECollections; | ||
| import org.eclipse.emf.common.util.EList; | ||
| import org.eclipse.jdt.annotation.NonNullByDefault; | ||
| import org.eclipse.jdt.annotation.Nullable; | ||
| import org.openhab.core.i18n.LocaleProvider; | ||
| import org.openhab.core.i18n.TranslationProvider; | ||
| import org.openhab.core.model.sitemap.sitemap.Button; | ||
| import org.openhab.core.model.sitemap.sitemap.Buttongrid; | ||
| import org.openhab.core.model.sitemap.sitemap.Widget; | ||
| import org.openhab.core.ui.items.ItemUIRegistry; | ||
| import org.openhab.ui.basic.internal.WebAppConfig; | ||
| import org.openhab.ui.basic.render.RenderException; | ||
| import org.openhab.ui.basic.render.WidgetRenderer; | ||
| import org.osgi.framework.BundleContext; | ||
| import org.osgi.service.component.annotations.Activate; | ||
| import org.osgi.service.component.annotations.Component; | ||
| import org.osgi.service.component.annotations.Reference; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| /** | ||
| * This is an implementation of the {@link WidgetRenderer} interface, which | ||
| * can produce HTML code for Buttongrid widgets. | ||
| * | ||
| * @author Laurent Garnier - Initial contribution | ||
| */ | ||
| @Component(service = WidgetRenderer.class) | ||
| @NonNullByDefault | ||
| public class ButtongridRenderer extends AbstractWidgetRenderer { | ||
|
|
||
| private final Logger logger = LoggerFactory.getLogger(ButtongridRenderer.class); | ||
|
|
||
| // private static final int MAX_LABEL_SIZE = 9; | ||
| private static final String ELLIPSIS = "\u2026"; | ||
|
|
||
| @Activate | ||
| public ButtongridRenderer(final BundleContext bundleContext, final @Reference TranslationProvider i18nProvider, | ||
| final @Reference ItemUIRegistry itemUIRegistry, final @Reference LocaleProvider localeProvider) { | ||
| super(bundleContext, i18nProvider, itemUIRegistry, localeProvider); | ||
| } | ||
|
|
||
| @Override | ||
| public boolean canRender(Widget w) { | ||
| return w instanceof Buttongrid; | ||
| } | ||
|
|
||
| @Override | ||
| public EList<Widget> renderWidget(Widget w, StringBuilder sb, String sitemap) throws RenderException { | ||
| Buttongrid grid = (Buttongrid) w; | ||
| int buttonsPerLine = grid.getColumns(); | ||
|
|
||
| if (buttonsPerLine < 1) { | ||
| logger.warn("Invalid value ({}) for \"columns\" parameter; use 1", buttonsPerLine); | ||
| buttonsPerLine = 1; | ||
| } | ||
|
|
||
| Map<Integer, Map<Integer, Button>> lines = new HashMap<>(); | ||
|
|
||
| int maxColumn = 0; | ||
| int maxLine = 0; | ||
| for (Button button : grid.getButtons()) { | ||
| int column = (button.getPosition() - 1) % buttonsPerLine + 1; | ||
| if (column > maxColumn) { | ||
| maxColumn = column; | ||
| } | ||
| int line = (button.getPosition() - 1) / buttonsPerLine + 1; | ||
| if (line > maxLine) { | ||
| maxLine = line; | ||
| } | ||
|
|
||
| Map<Integer, Button> columns = lines.get(line); | ||
| if (columns == null) { | ||
| columns = new HashMap<>(); | ||
| lines.put(line, columns); | ||
| } | ||
| columns.put(column, button); | ||
| } | ||
| if (maxLine > 20 || maxColumn > 10) { | ||
| logger.warn("Your button grid is too big ({},{})", maxLine, maxColumn); | ||
| return ECollections.emptyEList(); | ||
| } | ||
|
|
||
| String snippet = getSnippet("buttongrid"); | ||
|
|
||
| boolean showHeaderRow = grid.getLabel() != null; | ||
| snippet = snippet.replace("%header_visibility_class%", | ||
| showHeaderRow ? "%visibility_class%" : "mdl-form__row--hidden"); | ||
| snippet = snippet.replace("%header_row%", Boolean.valueOf(showHeaderRow).toString()); | ||
|
|
||
| snippet = preprocessSnippet(snippet, w, true); | ||
|
|
||
| // Process the color tags | ||
| snippet = processColor(w, snippet); | ||
|
|
||
| StringBuilder buttons = new StringBuilder(); | ||
| for (int line = 1; line <= maxLine; line++) { | ||
| buildGridLine(grid.getItem(), buttonsPerLine, lines.get(line), buttons); | ||
| } | ||
| snippet = snippet.replace("%lines%", buttons.toString()); | ||
|
|
||
| sb.append(snippet); | ||
| return ECollections.emptyEList(); | ||
| } | ||
|
|
||
| private void buildGridLine(String item, int columns, @Nullable Map<Integer, Button> buttonsInLine, | ||
| StringBuilder builder) throws RenderException { | ||
| String line = getSnippet("buttonline"); | ||
|
|
||
| StringBuilder buttons = new StringBuilder(); | ||
| for (int col = 1; col <= columns; col++) { | ||
| Button button = buttonsInLine == null ? null : buttonsInLine.get(col); | ||
| if (button != null) { | ||
| buildButton(item, button.getLabel(), button.getCmd(), button.getIcon(), 12, buttons); | ||
| } else { | ||
| buttons.append("<div class=\"buttongrid-empty-button\"></div>"); | ||
| } | ||
| } | ||
| line = line.replace("%buttons%", buttons.toString()); | ||
|
|
||
| builder.append(line); | ||
| } | ||
|
|
||
| private void buildButton(String item, @Nullable String lab, String cmd, @Nullable String icon, int maxLabelSize, | ||
| StringBuilder builder) throws RenderException { | ||
| String button = getSnippet("button"); | ||
|
|
||
| String command = cmd; | ||
| String label = lab == null ? cmd : lab; | ||
|
|
||
| if (maxLabelSize >= 1 && label.length() > maxLabelSize) { | ||
| label = label.substring(0, maxLabelSize - 1) + ELLIPSIS; | ||
| } | ||
|
|
||
| button = button.replace("%item%", item); | ||
| button = button.replace("%cmd%", escapeHtml(command)); | ||
| String buttonClass = "buttongrid-button"; | ||
| String style = ""; | ||
| if (icon == null || !config.isIconsEnabled()) { | ||
| button = button.replace("%label%", escapeHtml(label)); | ||
| button = button.replace("%icon_snippet%", ""); | ||
| } else { | ||
| button = button.replace("%label%", ""); | ||
| button = preprocessIcon(button, icon, true); | ||
| buttonClass += " mdl-button-icon"; | ||
| switch (config.getTheme()) { | ||
| case WebAppConfig.THEME_NAME_BRIGHT: | ||
| style = "style=\"color-scheme: light\""; | ||
| break; | ||
| case WebAppConfig.THEME_NAME_DARK: | ||
| style = "style=\"color-scheme: dark\""; | ||
| break; | ||
| default: | ||
| break; | ||
| } | ||
| } | ||
| button = button.replace("%buttonstyle%", style); | ||
| button = button.replace("%class%", buttonClass); | ||
|
|
||
| builder.append(button); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
20 changes: 20 additions & 0 deletions
20
bundles/org.openhab.ui.basic/src/main/resources/snippets/buttongrid.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| <div class="mdl-form__row mdl-form__row--header mdl-cell mdl-cell--12-col %header_visibility_class%"> | ||
| <span %iconstyle% class="mdl-form__icon"> | ||
| %icon_snippet% | ||
| </span> | ||
| <span %labelstyle% class="mdl-form__label"> | ||
| %label% | ||
| </span> | ||
| </div> | ||
| <div class="mdl-form__row mdl-form__row--height-auto mdl-cell mdl-cell--12-col %visibility_class%"> | ||
| <div | ||
| class="mdl-form__control mdl-form__buttons mdl-grid" | ||
| data-control-type="buttons" | ||
| data-item="%item%" | ||
| data-ignore-state="true" | ||
| data-widget-id="%widget_id%" | ||
| data-header-row="%header_row%" | ||
| > | ||
| %lines% | ||
| </div> | ||
| </div> |
3 changes: 3 additions & 0 deletions
3
bundles/org.openhab.ui.basic/src/main/resources/snippets/buttonline.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| <div class="mdl-cell mdl-cell--12-col buttongrid-line"> | ||
| %buttons% | ||
| </div> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters