com.yworks.yfiles.layout

Class SingleItemCollection<V>

java.lang.Object

com.yworks.yfiles.layout.ItemCollection<V>

com.yworks.yfiles.layout.SingleItemCollection<V>

Type Parameters:

V - The type of the items in the collection.

public class SingleItemCollection<V>
extends ItemCollection<V>

Provides different ways to define the items in a collection for use with LayoutData, especially if the collection contains only one item.

Only one of the provided ways to define a collection can be used at the same time, therefore only one of the properties Item, Items, Mapper, and Delegate should be set on each instance.

This class supports LayoutData implementations and does not usually have to be used explicitly.

Constructor Summary

Constructors

Constructor and Description
SingleItemCollection()

Method Summary

Modifier and Type	Method and Description
V	getItem() Gets the single item this item collection contains.
IMapper<V,Boolean>	provideMapper(LayoutGraphAdapter adapter, ILayoutAlgorithm layout) Provides a mapper describing which elements are contained in this ItemCollection.
void	setItem(V value) Sets the single item this item collection contains.

Methods inherited from class com.yworks.yfiles.layout.ItemCollection

getDelegate, getItems, getMapper, setDelegate, setItems, setMapper, setSource

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SingleItemCollection

public SingleItemCollection()

Method Detail

getItem

public final V getItem()

Gets the single item this item collection contains.

Returns:

The Item.

See Also:

setItem(java.lang.Object)

provideMapper

public IMapper<V,Boolean> provideMapper(LayoutGraphAdapter adapter,
                                        ILayoutAlgorithm layout)

Provides a mapper describing which elements are contained in this ItemCollection.

Overrides:

provideMapper in class ItemCollection<V>

Parameters:

adapter - The graph adapter the mapper shall be provided for.

layout - The layout using the item collection.

setItem

public final void setItem(V value)

Sets the single item this item collection contains.

Parameters:

value - The Item to set.

See Also:

getItem()