com.yworks.yfiles.layout

Class ComponentLayoutData

java.lang.Object

com.yworks.yfiles.layout.LayoutData

com.yworks.yfiles.layout.ComponentLayoutData

public class ComponentLayoutData
extends LayoutData

Specifies custom data for the ComponentLayout.

Constructor Summary

Constructors

Constructor and Description
ComponentLayoutData()

Method Summary

Modifier and Type	Method and Description
void	apply(LayoutGraphAdapter adapter, ILayoutAlgorithm layout, CopiedLayoutGraph layoutGraph) Applies this layout data to the specified layoutGraphAdapter.
AbortHandler	getAbortHandler() Gets the AbortHandler used during the layout.
ItemCollection<INode>	getAffectedComponents() Gets a collection of nodes that determine the components that shall be laid out.
ItemMapping<INode,Comparable>	getComponentIds() Gets the mapping from nodes to their component comparable that is used to sort the components.
ItemMapping<INode,NodeHalo>	getNodeHalos() Gets the mapping from nodes to their NodeHalo.
void	setAbortHandler(AbortHandler value) Sets the AbortHandler used during the layout.
void	setAffectedComponents(ItemCollection<INode> value) Sets a collection of nodes that determine the components that shall be laid out.
void	setComponentIds(ItemMapping<INode,Comparable> value) Sets the mapping from nodes to their component comparable that is used to sort the components.
void	setNodeHalos(ItemMapping<INode,NodeHalo> value) Sets the mapping from nodes to their NodeHalo.

Methods inherited from class java.lang.Object

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

Constructor Detail

ComponentLayoutData

public ComponentLayoutData()

Method Detail

apply

public void apply(LayoutGraphAdapter adapter,
                  ILayoutAlgorithm layout,
                  CopiedLayoutGraph layoutGraph)

Description copied from class: LayoutData

Applies this layout data to the specified layoutGraphAdapter.

Specified by:

apply in class LayoutData

Parameters:

adapter - The adapter to add the layout data to.

layout - The layout that shall use this layout data.

layoutGraph - The layout graph used for the layout calculation.

getAbortHandler

public final AbortHandler getAbortHandler()

Gets the AbortHandler used during the layout.

Returns:

The AbortHandler.

See Also:

AbortHandler.ABORT_HANDLER_DPKEY, setAbortHandler(AbortHandler)

getAffectedComponents

public final ItemCollection<INode> getAffectedComponents()

Gets a collection of nodes that determine the components that shall be laid out.

Note that components will be laid out if and only if at least one of the nodes is in this collection.

Returns:

The AffectedComponents.

See Also:

ComponentLayout.AFFECTED_COMPONENTS_DPKEY, setAffectedComponents(ItemCollection)

getComponentIds

public final ItemMapping<INode,Comparable> getComponentIds()

Gets the mapping from nodes to their component comparable that is used to sort the components.

Returns:

The ComponentIds.

See Also:

ComponentLayout.COMPONENT_ID_DPKEY, setComponentIds(ItemMapping)

getNodeHalos

public final ItemMapping<INode,NodeHalo> getNodeHalos()

Gets the mapping from nodes to their NodeHalo.

Returns:

The NodeHalos.

See Also:

NodeHalo.NODE_HALO_DPKEY, setNodeHalos(ItemMapping)

setAbortHandler

public final void setAbortHandler(AbortHandler value)

Sets the AbortHandler used during the layout.

Parameters:

value - The AbortHandler to set.

See Also:

AbortHandler.ABORT_HANDLER_DPKEY, getAbortHandler()

setAffectedComponents

public final void setAffectedComponents(ItemCollection<INode> value)

Sets a collection of nodes that determine the components that shall be laid out.

Note that components will be laid out if and only if at least one of the nodes is in this collection.

Parameters:

value - The AffectedComponents to set.

See Also:

ComponentLayout.AFFECTED_COMPONENTS_DPKEY, getAffectedComponents()

setComponentIds

public final void setComponentIds(ItemMapping<INode,Comparable> value)

Sets the mapping from nodes to their component comparable that is used to sort the components.

Parameters:

value - The ComponentIds to set.

See Also:

ComponentLayout.COMPONENT_ID_DPKEY, getComponentIds()

setNodeHalos

public final void setNodeHalos(ItemMapping<INode,NodeHalo> value)

Sets the mapping from nodes to their NodeHalo.

Parameters:

value - The NodeHalos to set.

See Also:

NodeHalo.NODE_HALO_DPKEY, getNodeHalos()