com.whitestein.lsps.vaadin.ui.components

Class TreeItem

java.lang.Object

com.whitestein.lsps.vaadin.ui.components.TreeItem

All Implemented Interfaces:

Serializable

public final class TreeItem
extends Object
implements Serializable

Provides type-safe access to the ui::TreeItem record.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
Variant.RecordVariant	record The ui::TreeItem record itself, not null.

Constructor Summary

Constructors

Constructor and Description
TreeItem(Variant.RecordVariant record, UIComponent owner)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
List<TreeItem>	getChildren() Returns the children of this tree item.
Object	getData() Returns the value of the ui::TreeItem.data property.
Variant<Object>	getDataVariant()
String	getLocalizedLabel() Returns the localized label.
int	hashCode()
boolean	isExpanded() Returns the value of the ui::TreeItem.expanded property.
boolean	isLeaf() Checks if this tree item is leaf.
boolean	maybeContainsChildren() Quickly guesses if this tree item is a leaf or not.
void	setExpanded(boolean expanded)
String	toString()
static List<TreeItem>	toTreeItems(Variant.CollectionVariant<? extends Collection<RecordHolder>,RecordHolder> treeItems, UIComponent owner)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

record

public final Variant.RecordVariant record

The ui::TreeItem record itself, not null.

Constructor Detail

TreeItem

public TreeItem(Variant.RecordVariant record,
                UIComponent owner)

Method Detail

getData

public Object getData()

Returns the value of the ui::TreeItem.data property.

Returns:

the data property value, may be null.

getDataVariant

public Variant<Object> getDataVariant()

getLocalizedLabel

public String getLocalizedLabel()

Returns the localized label.

Returns:

the ui::TreeItem.label, localized, may be null.

isExpanded

public boolean isExpanded()

Returns the value of the ui::TreeItem.expanded property.

Returns:

true if node should initially be expanded. Defaults to false.

setExpanded

public void setExpanded(boolean expanded)

getChildren

public List<TreeItem> getChildren()

Returns the children of this tree item. Auto-polls tree closure if the ui::TreeItem.children property is null - in such case it also fills the ui::TreeItem.children property.

Returns:

the children, never null, may be empty if this is a leaf node. Caches the value and provides an immutable view.

maybeContainsChildren

public boolean maybeContainsChildren()

Quickly guesses if this tree item is a leaf or not. Does not run owner children closure - just inspects the value of cachedChildren and record.children to see whether we can quickly determine whether we are leaf.

Returns:

true if this node may be a leaf or may contain children, false if this node is a leaf for sure.

isLeaf

public boolean isLeaf()

Checks if this tree item is leaf. Calls getChildren() which may in turn run the "children" closure.

Returns:

true if this tree item is leaf, false if it contains children.

toTreeItems

public static List<TreeItem> toTreeItems(Variant.CollectionVariant<? extends Collection<RecordHolder>,RecordHolder> treeItems,
                                         UIComponent owner)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object