Package org.openhab.core.ui.tiles

Interface Tile

All Known Implementing Classes:
ExternalServiceTile
@NonNullByDefault public interface Tile
A tile can be registered by a UI as a service in order to appear on the main openHAB UI.
Author:
Kai Kreuzer - initial contribution, Yannick Schaus - refactored into core, remove references to dashboard

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getImageUrl()
    The url to point to for the tile.
    String
    getName()
    The name that should appear on the tile
    @Nullable String
    getOverlay()
    An HTML5 overlay icon to use for the tile, e.g.
    String
    getUrl()
    The url to point to (if it is a local UI, it should be a relative path starting with "../")

  • Method Details

    • getName

      String getName()
      The name that should appear on the tile
      Returns:
      name of the tile

    • getUrl

      String getUrl()
      The url to point to (if it is a local UI, it should be a relative path starting with "../")
      Returns:
      the url

    • getImageUrl

      String getImageUrl()
      The url to point to for the tile. (if it is a local UI, it should be a relative path starting with "../")
      Returns:
      the tile url

    • getOverlay

      @Nullable String getOverlay()
      An HTML5 overlay icon to use for the tile, e.g. "html5", "android" or "apple".
      Returns:
      the overlay to use