Package org.openhab.core.sitemap

Interface ButtonDefinition

@NonNullByDefault public interface ButtonDefinition
A representation of a sitemap Buttongrid button definition. All buttons will act on the same item defined in the button grid.
Author:
Mark Herwege - Initial contribution

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getCmd()
    Get button command.
    int
    getColumn()
    Get button column in grid.
    @Nullable String
    getIcon()
    Get button icon.
    String
    getLabel()
    Get button label.
    int
    getRow()
    Get button row in grid.
    void
    setCmd(String cmd)
    Set button command.
    void
    setColumn(int column)
    Set button column in grid.
    void
    setIcon(@Nullable String icon)
    Set button icon.
    void
    setLabel(String label)
    Set button label.
    void
    setRow(int row)
    Set button row in grid.

  • Method Details

    • getRow

      int getRow()
      Get button row in grid.
      Returns:
      row

    • setRow

      void setRow(int row)
      Set button row in grid.
      Parameters:
      row -

    • getColumn

      int getColumn()
      Get button column in grid.
      Returns:
      column

    • setColumn

      void setColumn(int column)
      Set button column in grid.
      Parameters:
      column -

    • getCmd

      String getCmd()
      Get button command.
      Returns:
      cmd

    • setCmd

      void setCmd(String cmd)
      Set button command.
      Parameters:
      cmd -

    • getLabel

      String getLabel()
      Get button label.
      Returns:
      label

    • setLabel

      void setLabel(String label)
      Set button label.
      Parameters:
      label -

    • getIcon

      @Nullable String getIcon()
      Get button icon.
      Returns:
      icon

    • setIcon

      void setIcon(@Nullable String icon)
      Set button icon.
      Parameters:
      icon -