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 Summary

Modifier and Type	Method	Description
@Nullable String	getIcon()	Returns the sitemap icon.
@Nullable String	getLabel()	Returns the sitemap label.
String	getName()	Returns the sitemap name.
void	setIcon(@Nullable String icon)	Sets the sitemap icon.
void	setLabel(@Nullable String label)	Sets the sitemap label.
void	setName(String name)	Sets the sitemap name.

Methods inherited from interface org.openhab.core.common.registry.Identifiable

getUID

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

getWidgets, setWidgets

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.