Package org.openhab.core.sitemap

Interface Sitemap

All Superinterfaces:
Identifiable<String>, Parent
@NonNullByDefault public interface Sitemap extends Identifiable<String>, Parent
A representation of a 'Sitemap'.
Author:
Mark Herwege - Initial contribution

  • Method Details

    • getName

      String getName()
      Returns the sitemap name.
      Returns:
      sitemap name.

    • setName

      void setName(String name)
      Sets the sitemap name.
      Parameters:
      name - the new sitemap name.

    • getLabel

      @Nullable String getLabel()
      Returns the sitemap label.
      Returns:
      sitemap label.

    • setLabel

      void setLabel(@Nullable String label)
      Sets the sitemap label.
      Parameters:
      label - the new sitemap label.

    • getIcon

      @Nullable String getIcon()
      Returns the sitemap icon.
      Returns:
      sitemap icon.

    • setIcon

      void setIcon(@Nullable String icon)
      Sets the sitemap icon.
      Parameters:
      icon - the new sitemap icon.

    • getWidgets

      List<Widget> getWidgets()
      Returns the top level list of widgets in the sitemap. The returned list is a modifiable list.
      Returns:
      list of widgets.

    • setWidgets

      void setWidgets(List<Widget> widgets)
      Replace the sitemap child widgets with a new list of widgets.
      Parameters:
      widgets -