Package org.openhab.core.sitemap

Interface Button

All Superinterfaces:

NonLinkableWidget, Widget

@NonNullByDefault
public interface Button
extends NonLinkableWidget

A representation of a sitemap Button widget. Button widgets should have a parent Buttongrid widget.

Author:

Mark Herwege - Initial contribution

Method Summary

Modifier and Type	Method	Description
String	getCmd()	Get button command, will be executed when the button is clicked.
int	getColumn()	Get button column in grid.
@Nullable String	getReleaseCmd()	Get button release command, will be executed when the button is released.
int	getRow()	Get button row in grid.
boolean	isStateless()	True if the button is stateless, by default a button is stateful.
void	setCmd(String cmd)	Set button command.
void	setColumn(int column)	Set button column in grid.
void	setReleaseCmd(@Nullable String releaseCmd)	Set the button release command.
void	setRow(int row)	Set button row in grid.
void	setStateless(@Nullable Boolean stateless)	Set stateless parameter for button.

Methods inherited from interface org.openhab.core.sitemap.Widget

getIcon, getIconColor, getIconRules, getItem, getLabel, getLabelColor, getParent, getValueColor, getVisibility, getWidgetType, isStaticIcon, setIcon, setIconColor, setIconRules, setItem, setLabel, setLabelColor, setParent, setStaticIcon, setValueColor, setVisibility

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 -

isStateless

boolean isStateless()

True if the button is stateless, by default a button is stateful.

Returns:

stateless

setStateless

void setStateless(@Nullable Boolean stateless)

Set stateless parameter for button.

Parameters:

stateless -

getCmd

String getCmd()

Get button command, will be executed when the button is clicked.

Returns:

cmd

setCmd

void setCmd(String cmd)

Set button command.

Parameters:

cmd -

getReleaseCmd

@Nullable String getReleaseCmd()

Get button release command, will be executed when the button is released.

Returns:

releaseCmd

setReleaseCmd

void setReleaseCmd(@Nullable String releaseCmd)

Set the button release command.

Parameters:

releaseCmd -