com.yworks.yfiles.layout.hierarchic

Interface IEdgeData

public interface IEdgeData

This interface provides layout information about the edges of the graph during the layout.

IEdgeData is a multi-purpose edge descriptor for each edge, holding information about the type of an edge, associated port constraints, port candidates, edge groups as well as the current edge state.

It is used in all phases of the HierarchicLayoutCore to store edge information.

Method Summary

Modifier and Type	Method and Description
Edge	getAssociatedEdge() Gets the Edge associated with this IEdgeData instance.
Node	getAssociatedNode() Gets the Node associated with this IEdgeData instance.
EdgeLayoutDescriptor	getEdgeLayoutDescriptor() Gets the EdgeLayoutDescriptor instance bound to the Edge associated with this IEdgeData instance.
Object	getGroup() Gets the group that is represented by the Edge associated with this IEdgeData instance.
Object	getSourceGroup() Gets the ID of the edge group at the source node to which the Edge associated with this IEdgeData instance belongs (if any).
Collection<Object>	getSourcePortCandidates() Gets the collection of PortCandidates for the source port of the Edge associated with this IEdgeData instance.
PortConstraint	getSourcePortConstraint() Gets the port constraints for the source port of the Edge associated with this IEdgeData instance.
Object	getSourcePortGroup() Gets the ID of the edge port group at the source node to which the Edge associated with this IEdgeData instance belongs (if any).
Object	getTargetGroup() Gets the ID of the edge group at the target node to which the Edge associated with this IEdgeData instance belongs (if any).
Collection<Object>	getTargetPortCandidates() Gets the collection of PortCandidates for the target port of the Edge associated with this IEdgeData instance.
PortConstraint	getTargetPortConstraint() Gets the port constraints for the target port of the Edge associated with this IEdgeData instance.
Object	getTargetPortGroup() Gets the ID of the edge port group at the target node to which the Edge associated with this IEdgeData instance belongs (if any).
double	getThickness() Gets the thickness of the Edge associated with this IEdgeData instance.
EdgeDataType	getType() Gets the type of the Edge associated with this IEdgeData instance.
boolean	isFallbackUpperSameLayerEdge() Gets whether or not the Edge associated with this IEdgeData instance should be an upper same-layer edge (if it is a same-layer edge).
boolean	isReversed() Gets whether or not the Edge associated with this IEdgeData instance has been reversed.
boolean	isUpperSameLayerEdge() Gets whether or not the Edge associated with this IEdgeData instance is an upper same-layer edge.
void	setFallbackUpperSameLayerEdge(boolean value) Sets whether or not the Edge associated with this IEdgeData instance should be an upper same-layer edge (if it is a same-layer edge).

Method Detail

getAssociatedEdge

Edge getAssociatedEdge()

Gets the Edge associated with this IEdgeData instance.

If no Edge is associated with this IEdgeData instance, null should be returned.

Returns:

the associated Edge or null no such Edge exists

getAssociatedNode

Node getAssociatedNode()

Gets the Node associated with this IEdgeData instance.

If no Node is associated with this IEdgeData instance, null should be returned.

Returns:

the associated Node or null no such Node exists

getEdgeLayoutDescriptor

EdgeLayoutDescriptor getEdgeLayoutDescriptor()

Gets the EdgeLayoutDescriptor instance bound to the Edge associated with this IEdgeData instance.

If no EdgeLayoutDescriptor is bound to the edge, null should be returned.

Returns:

an EdgeLayoutDescriptor instance or null if no EdgeLayoutDescriptor is registered

getGroup

Object getGroup()

Gets the group that is represented by the Edge associated with this IEdgeData instance.

Returns:

the group represented by the associated Edge

getSourceGroup

Object getSourceGroup()

Gets the ID of the edge group at the source node to which the Edge associated with this IEdgeData instance belongs (if any).

Information about edge grouping at the source node is obtained by a IDataProvider registered with the graph with key PortConstraintKeys.SOURCE_GROUP_ID_DPKEY.

Returns:

the ID of the group at the source node

getSourcePortCandidates

Collection<Object> getSourcePortCandidates()

Gets the collection of PortCandidates for the source port of the Edge associated with this IEdgeData instance.

Source port candidates are obtained by a IDataProvider registered with the graph with key PortCandidate.SOURCE_PORT_CANDIDATE_COLLECTION_DPKEY.

Returns:

a collection of PortCandidate for the source port

getSourcePortConstraint

PortConstraint getSourcePortConstraint()

Gets the port constraints for the source port of the Edge associated with this IEdgeData instance.

PortConstraints are obtained by a IDataProvider registered with the graph with key PortConstraintKeys.SOURCE_PORT_CONSTRAINT_DPKEY.

Returns:

a PortConstraint instance for the source port

getSourcePortGroup

Object getSourcePortGroup()

Gets the ID of the edge port group at the source node to which the Edge associated with this IEdgeData instance belongs (if any).

Information about edge port grouping at the source node is obtained by a IDataProvider registered with the graph with key PortConstraintKeys.SOURCE_PORT_GROUP_ID_DPKEY.

Returns:

the ID of the port group at the source node

getTargetGroup

Object getTargetGroup()

Gets the ID of the edge group at the target node to which the Edge associated with this IEdgeData instance belongs (if any).

Information about edge grouping at the target node is obtained by a IDataProvider registered with the graph with key PortConstraintKeys.TARGET_GROUP_ID_DPKEY.

Returns:

the ID of the group at the target node

getTargetPortCandidates

Collection<Object> getTargetPortCandidates()

Gets the collection of PortCandidates for the target port of the Edge associated with this IEdgeData instance.

Target port candidates are obtained by a IDataProvider registered with the graph with key PortCandidate.TARGET_PORT_CANDIDATE_COLLECTION_DPKEY.

Returns:

a collection of PortCandidate for the target port

getTargetPortConstraint

PortConstraint getTargetPortConstraint()

Gets the port constraints for the target port of the Edge associated with this IEdgeData instance.

PortConstraints are obtained by a IDataProvider registered with the graph with key PortConstraintKeys.TARGET_PORT_CONSTRAINT_DPKEY.

Returns:

a PortConstraint instance for the target port

getTargetPortGroup

Object getTargetPortGroup()

Gets the ID of the edge port group at the target node to which the Edge associated with this IEdgeData instance belongs (if any).

Information about edge port grouping at the target node is obtained by a IDataProvider registered with the graph with key PortConstraintKeys.TARGET_PORT_GROUP_ID_DPKEY.

Returns:

the ID of the group at the target node

getThickness

double getThickness()

Gets the thickness of the Edge associated with this IEdgeData instance.

The thickness is considered when calculating minimum distances so that there are no overlaps between edges and other graph elements.

The thickness must have a non-negative value.

Returns:

the thickness for the edge

getType

EdgeDataType getType()

Gets the type of the Edge associated with this IEdgeData instance.

Returns:

the type of the associated Edge

isFallbackUpperSameLayerEdge

boolean isFallbackUpperSameLayerEdge()

Gets whether or not the Edge associated with this IEdgeData instance should be an upper same-layer edge (if it is a same-layer edge).

An upper same-layer edge is an edge connecting two nodes of the same layer with polyline segments (not directly, with a straight-line) and is routed above the layer.

If enabled the edge will be routed above the layer, otherwise below it.

Returns:

true if the same-layer edge should be routed above the layer, false otherwise

See Also:

setFallbackUpperSameLayerEdge(boolean)

isReversed

boolean isReversed()

Gets whether or not the Edge associated with this IEdgeData instance has been reversed.

Returns:

true if the associated Edge has been reversed, false otherwise

isUpperSameLayerEdge

boolean isUpperSameLayerEdge()

Gets whether or not the Edge associated with this IEdgeData instance is an upper same-layer edge.

An upper same-layer edge is an edge connecting two nodes of the same layer with polyline segments (not directly, with a straight-line) and is routed above the layer.

Returns:

true if the associated Edge is an upper same-layer edge, false otherwise

setFallbackUpperSameLayerEdge

void setFallbackUpperSameLayerEdge(boolean value)

Sets whether or not the Edge associated with this IEdgeData instance should be an upper same-layer edge (if it is a same-layer edge).

An upper same-layer edge is an edge connecting two nodes of the same layer with polyline segments (not directly, with a straight-line) and is routed above the layer.

If enabled the edge will be routed above the layer, otherwise below it.

Parameters:

value - true if the same-layer edge should be routed above the layer, false otherwise

See Also:

isFallbackUpperSameLayerEdge()