Package org.openhab.core.items

Interface ActiveItem

All Superinterfaces:

Identifiable<String>, Item

All Known Implementing Classes:

CallItem, ColorItem, ContactItem, DateTimeItem, DimmerItem, GenericItem, GroupItem, ImageItem, LocationItem, NumberItem, PlayerItem, RollershutterItem, StringItem, SwitchItem

@NonNullByDefault
@Deprecated
public interface ActiveItem
extends Item

Deprecated.

This class is not meant as a public API - it should only be used internally from within the framework

An ActiveItem can be modified. It provides methods for adding and removing tags, adding and removing group names and setting a label and a category.

Author:

Dennis Nobel - Initial contribution

Method Summary

Modifier and Type	Method	Description
void	addGroupName(String groupItemName)	Deprecated. Assigns the according item to a group.
void	addGroupNames(String... groupItemNames)	Deprecated. Assigns the according item to the given groups.
void	addGroupNames(List<String> groupItemNames)	Deprecated. Assigns the according item to the given groups.
void	addTag(String tag)	Deprecated. Adds a tag to the item.
void	addTags(String... tags)	Deprecated. Adds tags to the item.
void	addTags(Collection<String> tags)	Deprecated. Adds tags to the item.
void	removeAllTags()	Deprecated. Clears all tags of this item.
void	removeGroupName(String groupItemName)	Deprecated. Removes the according item from a group.
void	removeTag(String tag)	Deprecated. Removes a tag from the item.
void	setCategory(@Nullable String category)	Deprecated. Sets the category of the item (can be null)
void	setLabel(@Nullable String label)	Deprecated. Sets the label of an item

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

getUID

Methods inherited from interface org.openhab.core.items.Item

getAcceptedCommandTypes, getAcceptedDataTypes, getCategory, getCommandDescription, getCommandDescription, getGroupNames, getLabel, getLastState, getLastStateChange, getLastStateUpdate, getName, getState, getStateAs, getStateDescription, getStateDescription, getTags, getType, hasTag

Method Details

setLabel

void setLabel(@Nullable String label)

Deprecated.

Sets the label of an item

Parameters:

label - label (can be null)

setCategory

void setCategory(@Nullable String category)

Deprecated.

Sets the category of the item (can be null)

Parameters:

category - category

addTag

void addTag(String tag)

Deprecated.

Adds a tag to the item.

Parameters:

tag - a tag that is to be added to item's tags.

addTags

void addTags(String... tags)

Deprecated.

Adds tags to the item.

Parameters:

tags - tags that are to be added to item's tags.

addTags

void addTags(Collection<String> tags)

Deprecated.

Adds tags to the item.

Parameters:

tags - tags that are to be added to item's tags.

removeTag

void removeTag(String tag)

Deprecated.

Removes a tag from the item.

Parameters:

tag - a tag that is to be removed from item's tags.

removeAllTags

void removeAllTags()

Deprecated.

Clears all tags of this item.

removeGroupName

void removeGroupName(String groupItemName)

Deprecated.

Removes the according item from a group.

Parameters:

groupItemName - name of the group (must not be null)

addGroupName

void addGroupName(String groupItemName)

Deprecated.

Assigns the according item to a group.

Parameters:

groupItemName - name of the group (must not be null)

addGroupNames

void addGroupNames(String... groupItemNames)

Deprecated.

Assigns the according item to the given groups.

Parameters:

groupItemNames - names of the groups (must not be null)

addGroupNames

void addGroupNames(List<String> groupItemNames)

Deprecated.

Assigns the according item to the given groups.

Parameters:

groupItemNames - names of the groups (must not be null)