com.yworks.yfiles.layout.hierarchic

Class IncrementalHintItemMapping

java.lang.Object

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

com.yworks.yfiles.layout.ContextItemMapping<IModelItem,Object,IIncrementalHintsFactory>

com.yworks.yfiles.layout.hierarchic.IncrementalHintItemMapping

public final class IncrementalHintItemMapping
extends ContextItemMapping<IModelItem,Object,IIncrementalHintsFactory>

Provides different ways to define a mapping from model items to incremental hints for use with HierarchicLayoutData.

Only one of the provided ways to define a mapping can be used at the same time, therefore only one of the properties of this class should be set on an instance.

Constructor Summary

Constructors

Constructor and Description
IncrementalHintItemMapping()

Method Summary

Modifier and Type	Method and Description
ItemCollection<INode>	getIncrementalLayeringNodes() Gets an item collection of nodes that are mapped to incremental layering hints.
ItemCollection<IModelItem>	getIncrementalSequencingItems() Gets an item collection of nodes that are mapped to incremental sequencing hints.
IMapper<IModelItem,Object>	provideMapper(LayoutGraphAdapter adapter, ILayoutAlgorithm layout, IIncrementalHintsFactory hintsFactory) Provides a mapper mapping the items to values.
void	setIncrementalLayeringNodes(ItemCollection<INode> value) Sets an item collection of nodes that are mapped to incremental layering hints.
void	setIncrementalSequencingItems(ItemCollection<IModelItem> value) Sets an item collection of nodes that are mapped to incremental sequencing hints.

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

getContextDelegate, setContextDelegate

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

IncrementalHintItemMapping

public IncrementalHintItemMapping()

Method Detail

getIncrementalLayeringNodes

public final ItemCollection<INode> getIncrementalLayeringNodes()

Gets an item collection of nodes that are mapped to incremental layering hints.

Returns:

The IncrementalLayeringNodes.

See Also:

setIncrementalLayeringNodes(ItemCollection)

getIncrementalSequencingItems

public final ItemCollection<IModelItem> getIncrementalSequencingItems()

Gets an item collection of nodes that are mapped to incremental sequencing hints.

Returns:

The IncrementalSequencingItems.

See Also:

setIncrementalSequencingItems(ItemCollection)

provideMapper

public IMapper<IModelItem,Object> provideMapper(LayoutGraphAdapter adapter,
                                                ILayoutAlgorithm layout,
                                                IIncrementalHintsFactory hintsFactory)

Description copied from class: ContextItemMapping

Provides a mapper mapping the items to values.

Overrides:

provideMapper in class ContextItemMapping<IModelItem,Object,IIncrementalHintsFactory>

Parameters:

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

layout - The layout using the mapper.

hintsFactory - The context object passed to the ContextDelegate.

Returns:

A mapper mapping the items to values.

setIncrementalLayeringNodes

public final void setIncrementalLayeringNodes(ItemCollection<INode> value)

Sets an item collection of nodes that are mapped to incremental layering hints.

Parameters:

value - The IncrementalLayeringNodes to set.

See Also:

getIncrementalLayeringNodes()

setIncrementalSequencingItems

public final void setIncrementalSequencingItems(ItemCollection<IModelItem> value)

Sets an item collection of nodes that are mapped to incremental sequencing hints.

Parameters:

value - The IncrementalSequencingItems to set.

See Also:

getIncrementalSequencingItems()