com.yworks.yfiles.layout

Class ContextItemMapping<TItem,TValue,TContext>

java.lang.Object

com.yworks.yfiles.layout.ItemMapping<TItem,TValue>

com.yworks.yfiles.layout.ContextItemMapping<TItem,TValue,TContext>

Type Parameters:

TItem - The type of the items that are mapped.

TValue - The type of the values the items are mapped to.

TContext - The type of the context passed to the ContextDelegate

Direct Known Subclasses:

IncrementalHintItemMapping

public class ContextItemMapping<TItem,TValue,TContext>
extends ItemMapping<TItem,TValue>

Provides different ways to define a mapping from items to values that takes a context object into consideration, too.

Only one of the provided ways to define a mapping can be used at the same time, therefore only one of the properties ContextDelegate, Delegate, Mapper, and Constant 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
ContextItemMapping()

Method Summary

Modifier and Type	Method and Description
BiFunction<TItem,TContext,TValue>	getContextDelegate() Gets a delegate from the items and a context object to the values.
IMapper<TItem,TValue>	provideMapper(LayoutGraphAdapter adapter, ILayoutAlgorithm layout, TContext context) Provides a mapper mapping the items to values.
void	setContextDelegate(BiFunction<TItem,TContext,TValue> value) Sets a delegate from the items and a context object to the values.

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

getConstant, getDelegate, getMapper, provideMapper, setConstant, setDelegate, setMapper

Methods inherited from class java.lang.Object

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

Constructor Detail

ContextItemMapping

public ContextItemMapping()

Method Detail

getContextDelegate

public final BiFunction<TItem,TContext,TValue> getContextDelegate()

Gets a delegate from the items and a context object to the values.

Returns:

The ContextDelegate.

See Also:

setContextDelegate(BiFunction)

provideMapper

public IMapper<TItem,TValue> provideMapper(LayoutGraphAdapter adapter,
                                           ILayoutAlgorithm layout,
                                           TContext context)

Provides a mapper mapping the items to values.

Parameters:

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

layout - The layout using the mapper.

context - The context object passed to the ContextDelegate.

Returns:

A mapper mapping the items to values.

setContextDelegate

public final void setContextDelegate(BiFunction<TItem,TContext,TValue> value)

Sets a delegate from the items and a context object to the values.

Parameters:

value - The ContextDelegate to set.

See Also:

getContextDelegate()