Package org.openhab.core.sitemap.registry

Interface SitemapFactory

@NonNullByDefault
public interface SitemapFactory

The SitemapFactory is used to create Sitemaps and Widgets from their type string.

Author:

Mark Herwege - Initial contribution

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BUTTON
static final String	BUTTON_GRID
static final String	CHART
static final String	COLOR_PICKER
static final String	COLOR_TEMPERATURE_PICKER
static final String	DEFAULT
static final String	FRAME
static final String	GROUP
static final String	IMAGE
static final String	INPUT
static final String	MAPVIEW
static final String	SELECTION
static final String	SETPOINT
static final String	SITEMAP
static final String	SLIDER
static final String	SWITCH
static final String	TEXT
static final String	VIDEO
static final String	WEBVIEW

Method Summary

Modifier and Type	Method	Description
Condition	createCondition()	Creates a Rule Condition instance
Mapping	createMapping()	Creates a Mapping instance
Rule	createRule()	Creates a Rule instance
Sitemap	createSitemap(String sitemapName)	Creates a new Sitemap instance with name sitemapName
@Nullable Widget	createWidget(String widgetTypeName)	Creates a new Widget instance of type widgetTypeName
@Nullable Widget	createWidget(String widgetTypeName, Parent parent)	Creates a new Widget instance of type widgetTypeName and with Parent parent
String[]	getSupportedWidgetTypes()	Returns the list of all supported WidgetTypes of this Factory.

Field Details

BUTTON

static final String BUTTON

See Also:

• Constant Field Values

BUTTON_GRID

static final String BUTTON_GRID

See Also:

• Constant Field Values

CHART

static final String CHART

See Also:

• Constant Field Values

COLOR_PICKER

static final String COLOR_PICKER

See Also:

• Constant Field Values

COLOR_TEMPERATURE_PICKER

static final String COLOR_TEMPERATURE_PICKER

See Also:

• Constant Field Values

DEFAULT

static final String DEFAULT

See Also:

• Constant Field Values

FRAME

static final String FRAME

See Also:

• Constant Field Values

GROUP

static final String GROUP

See Also:

• Constant Field Values

IMAGE

static final String IMAGE

See Also:

• Constant Field Values

INPUT

static final String INPUT

See Also:

• Constant Field Values

MAPVIEW

static final String MAPVIEW

See Also:

• Constant Field Values

SELECTION

static final String SELECTION

See Also:

• Constant Field Values

SETPOINT

static final String SETPOINT

See Also:

• Constant Field Values

SLIDER

static final String SLIDER

See Also:

• Constant Field Values

SWITCH

static final String SWITCH

See Also:

• Constant Field Values

TEXT

static final String TEXT

See Also:

• Constant Field Values

VIDEO

static final String VIDEO

See Also:

• Constant Field Values

WEBVIEW

static final String WEBVIEW

See Also:

• Constant Field Values

SITEMAP

static final String SITEMAP

See Also:

• Constant Field Values

Method Details

createSitemap

Sitemap createSitemap(String sitemapName)

Creates a new Sitemap instance with name sitemapName

Parameters:

sitemapName -

Returns:

a new Sitemap.

createWidget

@Nullable Widget createWidget(String widgetTypeName)

Creates a new Widget instance of type widgetTypeName

Parameters:

widgetTypeName -

Returns:

a new Widget of type widgetTypeName or null if no matching class is known.

createWidget

@Nullable Widget createWidget(String widgetTypeName,
 Parent parent)

Creates a new Widget instance of type widgetTypeName and with Parent parent

Parameters:

widgetTypeName -

parent -

Returns:

a new Widget of type widgetTypeName or null if no matching class is known.

createMapping

Mapping createMapping()

Creates a Mapping instance

Returns:

a new Mapping.

createRule

Rule createRule()

Creates a Rule instance

Returns:

a new Rule.

createCondition

Condition createCondition()

Creates a Rule Condition instance

Returns:

a new Rule Condition.

getSupportedWidgetTypes

String[] getSupportedWidgetTypes()

Returns the list of all supported WidgetTypes of this Factory.

Returns:

the supported WidgetTypes