com.yworks.yfiles.layout.hierarchic

Interface IItemFactory

public interface IItemFactory

This interface is a factory for creating and destroying helper structures used in the graph during layout.

An implementation of this interface is provided by the HierarchicLayoutCore during the layout for the different sub-modules.

It is mainly for internal use.

Method Summary

Modifier and Type	Method and Description
void	convertToLabelNode(Node dummyNode) Converts a given Node to a label node.
default Node	createBendNode(ILayer layer, Edge edge) Creates a bend Node for the given Edge in the given ILayer and assigns it to the given SwimlaneDescriptor instance.
Node	createBendNode(ILayer layer, Edge edge, SwimlaneDescriptor laneDescriptor) Creates a bend Node for the given Edge in the given ILayer and assigns it to the given SwimlaneDescriptor instance.
default INodeData	createBendNodeData(Node node, Edge edge) Creates a INodeData object for a bend Node and associates it with the Node.
INodeData	createBendNodeData(Node node, Edge edge, SwimlaneDescriptor laneDescriptor) Creates a INodeData object for a bend Node and associates it with the Node.
Node	createConnectorProxyForGroup(Node groupNode, Object groupId, ILayer layer, Edge edge) Creates a dummy Node that mimics a connector to a group Node.
Node	createContentConnectorProxyForGroup(Node groupNode, Object groupId, ILayer layer, Edge e) Creates a dummy node that mimics a connector to a group node from a descendant.
Node	createDistanceNode(ILayer layer, Rectangle2D size, Edge[] edges) Creates a spacer Node for the drawing phase using the given bounds in the given ILayer.
Edge	createDummyEdge(Node newSource, Node newTarget, Edge oldEdge, boolean sourceEnd, boolean targetEnd) Creates a dummy Edge using the given data.
Node	createEdgeGroupNode(ILayer layer, Object groupId) Creates an edge group Node in the given ILayer.
INodeData	createEdgeGroupNodeData(Node node, Object groupId, boolean source) Creates a INodeData object for an edge group Node and associates it with the Node.
Edge	createGroupBorderEdge(Node source, Node target) Creates an Edge that connects two group border Nodes.
Node	createGroupBorderNode(Node groupNode, ILayer layer, NodeDataType type) Creates a group boundary Node for a group node in the given ILayer.
Node	createGroupLayerDummyNode() Create a dummy Node for a group layer.
Edge	createGroupNodeConnectorEdge(Node groupNode1, Node groupNode2, Edge representative) Creates a group node connector Edge between two group Nodes.
IEdgeData	createNormalEdgeData(Edge edge) Creates an IEdgeData object for a normal Edge and associates it with the edge.
INodeData	createNormalNodeData(Node node) Creates a INodeData object for a normal Node and associates it with the Node.
default Node	createProxyNode(Edge edge, boolean source) Creates a proxy Node for an Edge during the drawing phase, changing the Edge to end/start at the proxy and assigns it to a SwimlaneDescriptor instance.
Node	createProxyNode(Edge edge, boolean source, SwimlaneDescriptor laneDescriptor) Creates a proxy Node for an Edge during the drawing phase, changing the Edge to end/start at the proxy and assigns it to a SwimlaneDescriptor instance.
INodeData	createProxyNodeData(Node node, Node proxy, Edge edge) Creates a INodeData object for a proxy Node and associates it with the proxy node.
Edge	createRecursiveDummyEdge(Node newSource, Node newTarget, Edge oldEdge, boolean sourceEnd, boolean targetEnd) Creates a dummy edge that belongs to a recursive Edge.
Node	createRecursiveEdgeDummy(ILayer layer, Edge edge, SwimlaneDescriptor laneDescriptor) Creates a dummy Node that represents a bend node of a recursive Edge.
INodeData	createRecursiveEdgeNodeData(Node node, Edge edge, SwimlaneDescriptor laneDescriptor) Creates a INodeData for a dummy Node of a recursive Edge.
IEdgeData	createRecursiveSameLayerEdgeData(Edge edge, IEdgeData originalEdgeData, boolean isUpper) Creates an IEdgeData object for a same-layer recursive Edge and associates it with the edge.
Edge	createRedirectedGroupEdge(Node newSource, Node newTarget, Edge groupEdge) Creates a redirected Edge to replace an Edge connected to a group Node.
Edge	createReverseDummyEdge(Node newSource, Node newTarget, Edge oldEdge, boolean sourceEnd, boolean targetEnd) Creates a reversed dummy Edge using the given data.
IEdgeData	createSameLayerEdgeData(Edge edge) Creates an IEdgeData object for a same-layer Edge and associates it with the edge.
Edge	createSameLayerProxy(ILayer layer, Edge edge, Node toProxy) Creates a same-layer Edge proxy connecting a newly created proxy Node and a given proxy Node in the given ILayer.
default Node	createSameLayerSideProxy(ILayer inLayer, Node forNode, Edge edge) Creates a proxy Node for a same-layer Edge during the drawing phase that ends at the side of a node.
Node	createSameLayerSideProxy(ILayer inLayer, Node forNode, Edge edge, SwimlaneDescriptor sld) Creates a proxy Node for a same-layer Edge during the drawing phase that ends at the side of a node.
Node	createSameLayerSwitchProxy(ILayer layer, Edge edge) Creates a same-layer switch proxy Node (switching between two same-layer Edges on two different sides of the layer).
IEdgeData	createSelfLoopEdgeData(Edge edge) Creates an IEdgeData object for a self-loop Edge and associates it with the edge.
void	destroyDistanceNode(Node distanceNode) Destroys a spacer Node for the drawing phase created using createDistanceNode(ILayer, Rectangle2D, Edge[]).
void	destroyGroupConnectorLayer(ILayer layer, boolean useInEdges) Removes the given layer for proxies at groups to handle direct group content connector edges between a node in the first/last layer of the group node and the groups border.
void	destroyLabelNodeLayer(ILayer layer, boolean useInEdges) Destroys a previously created label layer.
Edge	destroyProxyNode(Node proxyNode) Destroys a proxy Node created using createProxyNode(Edge, boolean, SwimlaneDescriptor) for the drawing phase.
Edge	destroySameLayerProxy(Edge edge) Destroys a same-layer Edge proxy created using createSameLayerProxy(ILayer, Edge, Node).
void	destroySameLayerSideProxy(Node proxyNode) Destroys a proxy Node created using createProxyNode(Edge, boolean, SwimlaneDescriptor) for the drawing phase.
Edge	destroySameLayerSwitchProxy(Node node) Destroys a same-layer switch proxy Node created using createSameLayerSwitchProxy(ILayer, Edge).
EdgeList	insertEdge(Edge edge) Inserts a same-layer Edge or an Edge that may span multiple layers into the data structure and returns the resulting list of Edges that has been created if this edge spans multiple layers.
ILayer	insertGroupConnectorLayer(boolean top, int index) Inserts a layer for proxies at groups to handle direct group content connector edges between a node in the first/last layer of the group node and the groups border.
ILayer	insertGroupNodeLayer(boolean source, int index) Inserts a layer for group Nodes.
ILayer	insertLabelNodeLayer(boolean source, int index) Inserts a ILayer for labels.
void	registerSameLayerEdge(Edge edge) Registers an Edge as a same-layer Edge appropriately into all data structures.
void	setDirectlyConnectSameLayerEdge(Edge sameLayerEdge) Converts a same-layer Edge to an Edge of type EdgeDataType.DIRECT_SAME_LAYER_EDGE.
IEdgeData	setTemporaryEdgeGroups(Edge edge, Object sgId, Object tgId) Specifies an edge group constraint for an Edge and assigns it to an IEdgeData object.
IEdgeData	setTemporaryEdgeThickness(Edge edge, double thickness) Specifies the thickness for an Edge and defines it in an IEdgeData object.
IEdgeData	setTemporaryPortConstraint(Edge edge, boolean source, PortConstraint pc) Specifies a port constraint for an Edge at the given side and assigns it to an IEdgeData object.
void	unconvertToLabelNode(Node labelNode) Reverts a label node to the normal Node.

Method Detail

convertToLabelNode

void convertToLabelNode(Node dummyNode)

Converts a given Node to a label node.

Parameters:

dummyNode - the given Node to be converted

createBendNode

default Node createBendNode(ILayer layer,
                            Edge edge)

Creates a bend Node for the given Edge in the given ILayer and assigns it to the given SwimlaneDescriptor instance.

Parameters:

layer - the given ILayer instance

edge - the given Edge

Returns:

the new bend Node

createBendNode

Node createBendNode(ILayer layer,
                    Edge edge,
                    SwimlaneDescriptor laneDescriptor)

Creates a bend Node for the given Edge in the given ILayer and assigns it to the given SwimlaneDescriptor instance.

Parameters:

layer - the given ILayer instance

edge - the given Edge

laneDescriptor - a given SwimlaneDescriptor instance

Returns:

the new bend Node

createBendNodeData

default INodeData createBendNodeData(Node node,
                                     Edge edge)

Creates a INodeData object for a bend Node and associates it with the Node.

The bend is assigned to the given SwimlaneDescriptor instance.

Parameters:

node - the given Node

edge - the given Edge

Returns:

a INodeData object for the given bend Node

createBendNodeData

INodeData createBendNodeData(Node node,
                             Edge edge,
                             SwimlaneDescriptor laneDescriptor)

Creates a INodeData object for a bend Node and associates it with the Node.

The bend is assigned to the given SwimlaneDescriptor instance.

Parameters:

node - the given Node

edge - the given Edge

laneDescriptor - the given SwimlaneDescriptor instance

Returns:

a INodeData object for the given bend Node

createConnectorProxyForGroup

Node createConnectorProxyForGroup(Node groupNode,
                                  Object groupId,
                                  ILayer layer,
                                  Edge edge)

Creates a dummy Node that mimics a connector to a group Node.

Parameters:

groupNode - the given group Node

groupId - the given group ID

layer - the given ILayer instance

edge - the given Edge

Returns:

the new Node

createContentConnectorProxyForGroup

Node createContentConnectorProxyForGroup(Node groupNode,
                                         Object groupId,
                                         ILayer layer,
                                         Edge e)

Creates a dummy node that mimics a connector to a group node from a descendant.

Parameters:

groupNode - the group node to which the edge is connected

groupId - the id of the group node

layer - the layer to which the dummy node will be assigned

e - the edge that connects to the dummy node

Returns:

the dummy node

createDistanceNode

Node createDistanceNode(ILayer layer,
                        Rectangle2D size,
                        Edge[] edges)

Creates a spacer Node for the drawing phase using the given bounds in the given ILayer.

Parameters:

layer - the given ILayer instance

size - the given bounds

edges - an array of Edges

Returns:

the new spacer Node

createDummyEdge

Edge createDummyEdge(Node newSource,
                     Node newTarget,
                     Edge oldEdge,
                     boolean sourceEnd,
                     boolean targetEnd)

Creates a dummy Edge using the given data.

Parameters:

newSource - the source node of the Edge

newTarget - the target node of the Edge

oldEdge - the old Edge from which to retrieve the data

sourceEnd - true if the source node of the edge is referred, false otherwise

targetEnd - true if the target node of the edge is referred, false otherwise

Returns:

a new dummy Edge

createEdgeGroupNode

Node createEdgeGroupNode(ILayer layer,
                         Object groupId)

Creates an edge group Node in the given ILayer.

Parameters:

layer - the given ILayer instance

groupId - the ID of the edge group

Returns:

the new group Node

createEdgeGroupNodeData

INodeData createEdgeGroupNodeData(Node node,
                                  Object groupId,
                                  boolean source)

Creates a INodeData object for an edge group Node and associates it with the Node.

Parameters:

node - the given Node

groupId - the given group ID

source - true if the edge group is referred to the source node, false otherwise

Returns:

a INodeData object for the given edge group Node

createGroupBorderEdge

Edge createGroupBorderEdge(Node source,
                           Node target)

Creates an Edge that connects two group border Nodes.

Parameters:

source - the source Node

target - the target Node

Returns:

the new Edge connecting the two group Nodes

createGroupBorderNode

Node createGroupBorderNode(Node groupNode,
                           ILayer layer,
                           NodeDataType type)

Creates a group boundary Node for a group node in the given ILayer.

Parameters:

groupNode - the given group Node

layer - the given ILayer

type - one of NodeDataType.GROUP_BEGIN or NodeDataType.GROUP_END

Returns:

the new group boundary Node

createGroupLayerDummyNode

Node createGroupLayerDummyNode()

Create a dummy Node for a group layer.

Returns:

a new dummy Node

createGroupNodeConnectorEdge

Edge createGroupNodeConnectorEdge(Node groupNode1,
                                  Node groupNode2,
                                  Edge representative)

Creates a group node connector Edge between two group Nodes.

Parameters:

groupNode1 - the first group node

groupNode2 - the first group node

representative - the given representative Edge

Returns:

a new connector Edge between two group Nodes

createNormalEdgeData

IEdgeData createNormalEdgeData(Edge edge)

Creates an IEdgeData object for a normal Edge and associates it with the edge.

Parameters:

edge - the given Edge

Returns:

an IEdgeData object for the given Edge

createNormalNodeData

INodeData createNormalNodeData(Node node)

Creates a INodeData object for a normal Node and associates it with the Node.

Parameters:

node - the given Node

Returns:

a INodeData object for the given Node

createProxyNode

default Node createProxyNode(Edge edge,
                             boolean source)

Creates a proxy Node for an Edge during the drawing phase, changing the Edge to end/start at the proxy and assigns it to a SwimlaneDescriptor instance.

Parameters:

edge - the given Edge

source - true if the node is the source node of the edge, false otherwise

Returns:

the new proxy Node

createProxyNode

Node createProxyNode(Edge edge,
                     boolean source,
                     SwimlaneDescriptor laneDescriptor)

Creates a proxy Node for an Edge during the drawing phase, changing the Edge to end/start at the proxy and assigns it to a SwimlaneDescriptor instance.

Parameters:

edge - the given Edge

source - true if the node is the source node of the edge, false otherwise

laneDescriptor - a given SwimlaneDescriptor instance

Returns:

the new proxy Node

createProxyNodeData

INodeData createProxyNodeData(Node node,
                              Node proxy,
                              Edge edge)

Creates a INodeData object for a proxy Node and associates it with the proxy node.

Parameters:

node - the given Node

proxy - the given proxy node

edge - the given Edge

Returns:

a INodeData object for the given proxy node

createRecursiveDummyEdge

Edge createRecursiveDummyEdge(Node newSource,
                              Node newTarget,
                              Edge oldEdge,
                              boolean sourceEnd,
                              boolean targetEnd)

Creates a dummy edge that belongs to a recursive Edge.

Parameters:

newSource - the source node of the Edge

newTarget - the target node of the Edge

oldEdge - the old Edge from which to retrieve the data

sourceEnd - true if the source node of the edge is referred, false otherwise

targetEnd - true if the target node of the edge is referred, false otherwise

Returns:

a new dummy Edge

createRecursiveEdgeDummy

Node createRecursiveEdgeDummy(ILayer layer,
                              Edge edge,
                              SwimlaneDescriptor laneDescriptor)

Creates a dummy Node that represents a bend node of a recursive Edge.

Parameters:

layer - the given ILayer to which the dummy Node is assigned

edge - the given Edge to which the dummy Node belongs

laneDescriptor - the given SwimlaneDescriptor instance

Returns:

the new Node

createRecursiveEdgeNodeData

INodeData createRecursiveEdgeNodeData(Node node,
                                      Edge edge,
                                      SwimlaneDescriptor laneDescriptor)

Creates a INodeData for a dummy Node of a recursive Edge.

Parameters:

node - the given Node

edge - the given Edge to which the dummy Node belongs

laneDescriptor - the given SwimlaneDescriptor instance

Returns:

the new INodeData instance

createRecursiveSameLayerEdgeData

IEdgeData createRecursiveSameLayerEdgeData(Edge edge,
                                           IEdgeData originalEdgeData,
                                           boolean isUpper)

Creates an IEdgeData object for a same-layer recursive Edge and associates it with the edge.

Parameters:

edge - the given Edge

originalEdgeData - the IEdgeData object of the original edge

isUpper - true is the recursive edge is an upper same layer edge, false otherwise

Returns:

an IEdgeData object for the recursive same-layer Edge

createRedirectedGroupEdge

Edge createRedirectedGroupEdge(Node newSource,
                               Node newTarget,
                               Edge groupEdge)

Creates a redirected Edge to replace an Edge connected to a group Node.

Parameters:

newSource - the source node of the Edge

newTarget - the target node of the Edge

groupEdge - the given group Edge

Returns:

a new redirected Edge

createReverseDummyEdge

Edge createReverseDummyEdge(Node newSource,
                            Node newTarget,
                            Edge oldEdge,
                            boolean sourceEnd,
                            boolean targetEnd)

Creates a reversed dummy Edge using the given data.

Parameters:

newSource - the source node of the Edge

newTarget - the target node of the Edge

oldEdge - the old Edge from which to retrieve the data

sourceEnd - true if the source node of the edge is referred, false otherwise

targetEnd - true if the target node of the edge is referred, false otherwise

Returns:

a new reversed dummy Edge

createSameLayerEdgeData

IEdgeData createSameLayerEdgeData(Edge edge)

Creates an IEdgeData object for a same-layer Edge and associates it with the edge.

Parameters:

edge - the given Edge

Returns:

an IEdgeData object for the same-layer Edge

createSameLayerProxy

Edge createSameLayerProxy(ILayer layer,
                          Edge edge,
                          Node toProxy)

Creates a same-layer Edge proxy connecting a newly created proxy Node and a given proxy Node in the given ILayer.

Parameters:

layer - the given ILayer

edge - the given Edge

toProxy - the given proxy Node

Returns:

a new redefined same-layer Edge

createSameLayerSideProxy

default Node createSameLayerSideProxy(ILayer inLayer,
                                      Node forNode,
                                      Edge edge)

Creates a proxy Node for a same-layer Edge during the drawing phase that ends at the side of a node.

Parameters:

inLayer - the given ILayer instance

forNode - the given Node

edge - the given Edge

Returns:

the new proxy Node

createSameLayerSideProxy

Node createSameLayerSideProxy(ILayer inLayer,
                              Node forNode,
                              Edge edge,
                              SwimlaneDescriptor sld)

Creates a proxy Node for a same-layer Edge during the drawing phase that ends at the side of a node.

Parameters:

inLayer - the given ILayer instance

forNode - the given Node

edge - the given Edge

sld - a given SwimlaneDescriptor instance

Returns:

the new proxy Node

createSameLayerSwitchProxy

Node createSameLayerSwitchProxy(ILayer layer,
                                Edge edge)

Creates a same-layer switch proxy Node (switching between two same-layer Edges on two different sides of the layer).

Parameters:

layer - the given ILayer

edge - the given Edge

Returns:

the new same-layer switch proxy Node

createSelfLoopEdgeData

IEdgeData createSelfLoopEdgeData(Edge edge)

Creates an IEdgeData object for a self-loop Edge and associates it with the edge.

Parameters:

edge - the given Edge

Returns:

an IEdgeData object for a self-loop Edge

destroyDistanceNode

void destroyDistanceNode(Node distanceNode)

Destroys a spacer Node for the drawing phase created using createDistanceNode(ILayer, Rectangle2D, Edge[]).

Parameters:

distanceNode - the Node to be destroyed

destroyGroupConnectorLayer

void destroyGroupConnectorLayer(ILayer layer,
                                boolean useInEdges)

Removes the given layer for proxies at groups to handle direct group content connector edges between a node in the first/last layer of the group node and the groups border.

Parameters:

layer - the layer to destroy

useInEdges - whether the incoming edges should be used as the resulting edges

See Also:

EdgeLayoutDescriptor.setDirectGroupContentEdgeRoutingEnabled(boolean)

destroyLabelNodeLayer

void destroyLabelNodeLayer(ILayer layer,
                           boolean useInEdges)

Destroys a previously created label layer.

Parameters:

layer - the layer to destroy

useInEdges - whether the incoming edges should be used as the resulting edges

destroyProxyNode

Edge destroyProxyNode(Node proxyNode)

Destroys a proxy Node created using createProxyNode(Edge, boolean, SwimlaneDescriptor) for the drawing phase.

Parameters:

proxyNode - the proxy Node to be destroyed

destroySameLayerProxy

Edge destroySameLayerProxy(Edge edge)

Destroys a same-layer Edge proxy created using createSameLayerProxy(ILayer, Edge, Node).

Parameters:

edge - the Edge whose proxy will be destroyed

Returns:

the redefined Edge after the removal of the proxy Node

destroySameLayerSideProxy

void destroySameLayerSideProxy(Node proxyNode)

Destroys a proxy Node created using createProxyNode(Edge, boolean, SwimlaneDescriptor) for the drawing phase.

Parameters:

proxyNode - the proxy Node to be destroyed

destroySameLayerSwitchProxy

Edge destroySameLayerSwitchProxy(Node node)

Destroys a same-layer switch proxy Node created using createSameLayerSwitchProxy(ILayer, Edge).

Parameters:

node - the Node to be destroyed

Returns:

the redefined Edge after the removal of the same-layer switch proxy Node

insertEdge

EdgeList insertEdge(Edge edge)

Inserts a same-layer Edge or an Edge that may span multiple layers into the data structure and returns the resulting list of Edges that has been created if this edge spans multiple layers.

Parameters:

edge - the given Edge

Returns:

the resulting list of Edges that has been created if this edge spans multiple layers

insertGroupConnectorLayer

ILayer insertGroupConnectorLayer(boolean top,
                                 int index)

Inserts a layer for proxies at groups to handle direct group content connector edges between a node in the first/last layer of the group node and the groups border.

Parameters:

top - true if this layer is placed above a group nodes, false if placed below

index - the index where the layer is inserted

Returns:

the new layer

See Also:

EdgeLayoutDescriptor.setDirectGroupContentEdgeRoutingEnabled(boolean)

insertGroupNodeLayer

ILayer insertGroupNodeLayer(boolean source,
                            int index)

Inserts a layer for group Nodes.

Parameters:

source - true if the group refers to the source node of an edge, false otherwise

index - the index at which the specified layer is to be inserted

Returns:

a layer instance

insertLabelNodeLayer

ILayer insertLabelNodeLayer(boolean source,
                            int index)

Inserts a ILayer for labels.

Parameters:

source - true if the source node of the edge, false otherwise

index - the index at which the specified ILayer is to be inserted

Returns:

a layer instance

registerSameLayerEdge

void registerSameLayerEdge(Edge edge)

Registers an Edge as a same-layer Edge appropriately into all data structures.

Parameters:

edge - the given Edge to be registered

setDirectlyConnectSameLayerEdge

void setDirectlyConnectSameLayerEdge(Edge sameLayerEdge)

Converts a same-layer Edge to an Edge of type EdgeDataType.DIRECT_SAME_LAYER_EDGE.

Parameters:

sameLayerEdge - the given same-layer Edge

setTemporaryEdgeGroups

IEdgeData setTemporaryEdgeGroups(Edge edge,
                                 Object sgId,
                                 Object tgId)

Specifies an edge group constraint for an Edge and assigns it to an IEdgeData object.

Parameters:

edge - the given Edge

sgId - the ID of the edge group at the source node

tgId - the ID of the edge group at the target node

Returns:

an IEdgeData object

setTemporaryEdgeThickness

IEdgeData setTemporaryEdgeThickness(Edge edge,
                                    double thickness)

Specifies the thickness for an Edge and defines it in an IEdgeData object.

Parameters:

edge - the given Edge

thickness - the new edge thickness

Returns:

an IEdgeData object with an adjusted EdgeLayoutDescriptor

setTemporaryPortConstraint

IEdgeData setTemporaryPortConstraint(Edge edge,
                                     boolean source,
                                     PortConstraint pc)

Specifies a port constraint for an Edge at the given side and assigns it to an IEdgeData object.

Parameters:

edge - the given Edge

source - true of the port constraint is defined on the source node of the Edge, false otherwise

pc - the given PortConstraint instance

Returns:

an IEdgeData object

unconvertToLabelNode

void unconvertToLabelNode(Node labelNode)

Reverts a label node to the normal Node.

Parameters:

labelNode - the given label node to be converted