Search this API

y.layout
Interface PortConstraintKeys

All Known Implementing Classes:
HierarchicGroupLayouter, HierarchicLayouter, PortConstraint

public interface PortConstraintKeys

PortConstraintKeys are used for associating DataProviders that contain constraints for the edges of the input graph.

These constraints can either be PortConstraints or edge groups. PortConstraints force the edges to start/end on specified sides of the node. They may also restrict ports of edges to certain coordinates. Edge groups will bundle edges at a common source or target. They will start at the same coordinates and may share parts of their edge routes.

Layout algorithms that support PortConstraints or edge groups will access the DataProviders using the provided keys.

 

Field Summary
static java.lang.Object SOURCE_GROUPID_KEY
          A DataProvider key for assigning source group information for edges of the input graph Edges sharing a source group identifier will share a common bus near the source or at a common source node if possible.
static java.lang.Object SOURCE_PORT_CONSTRAINT_KEY
          A DataProvider key for providing source constraints for edges in the input graph
static java.lang.Object SOURCE_PORT_GROUP_ID_DPKEY
          A DataProvider key for assigning port group ids to the edges' source.
static java.lang.Object TARGET_GROUPID_KEY
          A DataProvider key for assigning target group information for edges of the input graph Edges sharing a target group identifier will share a common bus near the target or at a common target node if possible.
static java.lang.Object TARGET_PORT_CONSTRAINT_KEY
          A DataProvider key for providing target constraints for edges in the input graph
static java.lang.Object TARGET_PORT_GROUP_ID_DPKEY
          A DataProvider key for assigning port group ids to the edges' target.
 

Field Detail

SOURCE_PORT_CONSTRAINT_KEY

static final java.lang.Object SOURCE_PORT_CONSTRAINT_KEY
A DataProvider key for providing source constraints for edges in the input graph


TARGET_PORT_CONSTRAINT_KEY

static final java.lang.Object TARGET_PORT_CONSTRAINT_KEY
A DataProvider key for providing target constraints for edges in the input graph


SOURCE_GROUPID_KEY

static final java.lang.Object SOURCE_GROUPID_KEY
A DataProvider key for assigning source group information for edges of the input graph

Edges sharing a source group identifier will share a common bus near the source or at a common source node if possible.

 
The IncrementalHierarchicLayouter and the EdgeRouter are able to group incoming and outgoing edges. Therefore, the source group identifier of the outgoing edges of a node has to match with the target group identifier of the incoming edges.

TARGET_GROUPID_KEY

static final java.lang.Object TARGET_GROUPID_KEY
A DataProvider key for assigning target group information for edges of the input graph

Edges sharing a target group identifier will share a common bus near the target or at a common target node if possible.

 
The IncrementalHierarchicLayouter and the EdgeRouter are able to group incoming and outgoing edges. Therefore, the target group identifier of the incoming edges of a node has to match with the source group identifier of the outgoing edges.

SOURCE_PORT_GROUP_ID_DPKEY

static final java.lang.Object SOURCE_PORT_GROUP_ID_DPKEY
A DataProvider key for assigning port group ids to the edges' source.

All edges with the same port id at a node will share the same port location. However, they will be routed independently.

 
Currently, only the IncrementalHierarchicLayouter and the EdgeRouter support port grouping.

TARGET_PORT_GROUP_ID_DPKEY

static final java.lang.Object TARGET_PORT_GROUP_ID_DPKEY
A DataProvider key for assigning port group ids to the edges' target.

All edges with the same port id at a node will share the same port location. However, they will be routed independently.

 
Currently, only the IncrementalHierarchicLayouter and the EdgeRouter support port grouping.

© Copyright 2000-2021,
yWorks GmbH.
All rights reserved.