com.yworks.yfiles.layout

Class ItemCollection<TItem>

java.lang.Object

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

Type Parameters:

TItem - The type of the items in the collection.

Direct Known Subclasses:

DpKeyItemCollection, SingleItemCollection

public class ItemCollection<TItem>
extends Object

Provides different ways to define the items in a collection for use with LayoutData.

Only one of the provided ways to define a collection can be used at the same time, therefore only one of the properties 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
ItemCollection()

Method Summary

Modifier and Type	Method and Description
Predicate<TItem>	getDelegate() Gets a delegate from the items to a boolean value.
Collection<TItem>	getItems() Gets a collection of items.
IMapper<TItem,Boolean>	getMapper() Gets a mapping from the items to a boolean value.
IMapper<TItem,Boolean>	provideMapper(LayoutGraphAdapter adapter, ILayoutAlgorithm layout) Provides a mapper describing which elements are contained in this ItemCollection.
void	setDelegate(Predicate<TItem> value) Sets a delegate from the items to a boolean value.
void	setItems(Collection<TItem> value) Sets a collection of items.
void	setMapper(IMapper<TItem,Boolean> value) Sets a mapping from the items to a boolean value.
void	setSource(Iterable<TItem> value) Sets an enumerable of items.

Methods inherited from class java.lang.Object

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

Constructor Detail

ItemCollection

public ItemCollection()

Method Detail

getDelegate

public final Predicate<TItem> getDelegate()

Gets a delegate from the items to a boolean value.

The returned boolean value describes whether an item is contained in the collection.

Returns:

The Delegate.

See Also:

setDelegate(Predicate)

getItems

public final Collection<TItem> getItems()

Gets a collection of items.

This collection contains exactly the items in the given collection.

Returns:

The Items.

See Also:

setItems(Collection)

getMapper

public final IMapper<TItem,Boolean> getMapper()

Gets a mapping from the items to a boolean value.

The mapped boolean value specifies whether an item is contained in the collection.

Returns:

The Mapper.

See Also:

setMapper(IMapper)

provideMapper

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

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

Parameters:

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

layout - The layout using the item collection.

setDelegate

public final void setDelegate(Predicate<TItem> value)

Sets a delegate from the items to a boolean value.

The returned boolean value describes whether an item is contained in the collection.

Parameters:

value - The Delegate to set.

See Also:

getDelegate()

setItems

public final void setItems(Collection<TItem> value)

Sets a collection of items.

This collection contains exactly the items in the given collection.

Parameters:

value - The Items to set.

See Also:

getItems()

setMapper

public final void setMapper(IMapper<TItem,Boolean> value)

Sets a mapping from the items to a boolean value.

The mapped boolean value specifies whether an item is contained in the collection.

Parameters:

value - The Mapper to set.

See Also:

getMapper()

setSource

public final void setSource(Iterable<TItem> value)

Sets an enumerable of items.

This collection contains exactly the items in the given enumerable.

Parameters:

value - The Source to set.