Uses of Interface
org.openhab.core.sitemap.Widget

Packages that use Widget

Package	Description
org.openhab.core.io.rest.sitemap
org.openhab.core.sitemap
org.openhab.core.sitemap.registry
org.openhab.core.ui.items

Uses of Widget in org.openhab.core.io.rest.sitemap

Methods in org.openhab.core.io.rest.sitemap that return types with arguments of type Widget

Modifier and Type	Method	Description
List<Widget>	SitemapSubscriptionService.collectWidgets(String sitemapName, @Nullable String pageId)

Uses of Widget in org.openhab.core.sitemap

Subinterfaces of Widget in org.openhab.core.sitemap

Modifier and Type	Interface	Description
interface	Button	A representation of a sitemap Button widget.
interface	Buttongrid	A representation of a sitemap Buttongrid widget.
interface	Chart	A representation of a sitemap Chart widget.
interface	Colorpicker	A representation of a sitemap Colorpicker widget.
interface	Colortemperaturepicker	A representation of a sitemap Colortemperaturepicker widget.
interface	Default	A representation of a sitemap Default widget.
interface	Frame	A representation of a sitemap Frame widget.
interface	Group	A representation of a sitemap Group widget.
interface	Image	A representation of a sitemap Image widget.
interface	Input	A representation of a sitemap Input widget.
interface	LinkableWidget	A representation of a sitemap linkable widget (a widget that can have children).
interface	Mapview	A representation of a sitemap Mapview widget.
interface	NonLinkableWidget	A representation of a sitemap non-linkable widget (no children).
interface	Selection	A representation of a sitemap Selection widget.
interface	Setpoint	A representation of a sitemap Setpoint widget.
interface	Slider	A representation of a sitemap Slider widget.
interface	Switch	A representation of a sitemap Switch widget.
interface	Text	A representation of a sitemap Text widget.
interface	Video	A representation of a sitemap Video widget.
interface	Webview	A representation of a sitemap Webview widget.

Methods in org.openhab.core.sitemap that return types with arguments of type Widget

Modifier and Type	Method	Description
List<Widget>	LinkableWidget.getWidgets()	Get the child Widgets.
List<Widget>	Sitemap.getWidgets()	Returns the top level list of widgets in the sitemap.

Method parameters in org.openhab.core.sitemap with type arguments of type Widget

Modifier and Type	Method	Description
void	LinkableWidget.setWidgets(List<Widget> widgets)	Replace the child widgets with a new list of widgets.
void	Sitemap.setWidgets(List<Widget> widgets)	Replace the sitemap child widgets with a new list of widgets.

Uses of Widget in org.openhab.core.sitemap.registry

Methods in org.openhab.core.sitemap.registry that return Widget

Modifier and Type	Method	Description
@Nullable Widget	SitemapFactory.createWidget(String widgetTypeName)	Creates a new Widget instance of type widgetTypeName
@Nullable Widget	SitemapFactory.createWidget(String widgetTypeName, Parent parent)	Creates a new Widget instance of type widgetTypeName and with Parent parent

Uses of Widget in org.openhab.core.ui.items

Methods in org.openhab.core.ui.items that return Widget

Modifier and Type	Method	Description
@Nullable Widget	ItemUIProvider.getDefaultWidget(@Nullable Class<? extends Item> itemType, String itemName)	Provides a default widget for a given item (class).
@Nullable Widget	ItemUIProvider.getWidget(String itemName)	Provides a widget for a given item.
@Nullable Widget	ItemUIRegistry.getWidget(Sitemap sitemap, String id)	Retrieves the widget for a given id on a given sitemap.

Methods in org.openhab.core.ui.items that return types with arguments of type Widget

Modifier and Type	Method	Description
List<Widget>	ItemUIRegistry.getChildren(LinkableWidget w)	this should be used instead of LinkableWidget.getChildren() as there might be no children defined on the widget, but they should be dynamically determined by looking at the members of the underlying item.
List<Widget>	ItemUIRegistry.getChildren(Sitemap sitemap)	this should be used instead of Sitemap.getChildren() as the default widgets have to be resolved to a concrete widget type.

Methods in org.openhab.core.ui.items with parameters of type Widget

Modifier and Type	Method	Description
@Nullable State	ItemUIRegistry.convertState(Widget widget, Item item, State state)	Convert the given state into
@Nullable String	ItemUIRegistry.getCategory(Widget w)	Retrieves the category for a widget.
@Nullable String	ItemUIRegistry.getConditionalIcon(Widget w)	Gets the icon for the widget.
@Nullable String	ItemUIRegistry.getFormatPattern(Widget w)	Gets the format pattern for the widget value, retrieved from widget label, item label or item state description
@Nullable String	ItemUIRegistry.getIconColor(Widget w)	Gets the icon color for the widget.
@Nullable String	ItemUIRegistry.getLabel(Widget w)	Retrieves the label for a widget.
@Nullable String	ItemUIRegistry.getLabelColor(Widget w)	Gets the label color for the widget.
ItemUIRegistry.WidgetLabelSource	ItemUIRegistry.getLabelSource(Widget w)	Retrieves the label source for a widget.
@Nullable Parent	ItemUIRegistry.getParent(Widget w)	this should be used instead of Widget.eContainer() as as the concrete widgets created from default widgets have no parent.
@Nullable State	ItemUIRegistry.getState(Widget w)	Retrieves the current state of the item of a widget or UnDefType.UNDEF.
@Nullable String	ItemUIRegistry.getUnitForWidget(Widget widget)	Provide a widget specific String representation of a Unit.
@Nullable String	ItemUIRegistry.getValueColor(Widget w)	Gets the value color for the widget.
boolean	ItemUIRegistry.getVisiblity(Widget w)	Gets the widget visibility based on the item state
String	ItemUIRegistry.getWidgetId(Widget w)	Provides an id for a widget.