com.yworks.yfiles.layout.tree

Class TreeLayout.SubtreeShape

java.lang.Object

com.yworks.yfiles.layout.tree.TreeLayout.SubtreeShape

Enclosing class:

TreeLayout

public static final class TreeLayout.SubtreeShape
extends Object

A TreeLayout.SubtreeShape represents the position and the borders of a subtree.

INodePlacers will move TreeLayout.SubtreeShapes and use the borders to calculate distances between the subtrees. When two subtrees are placed in relation to their common root, their TreeLayout.SubtreeShapes are merged to represent the new subtree.

The borders on each side of the TreeLayout.SubtreeShape are modeled with BorderLines. The resulting area includes the borders of each node and edge in the corresponding subtree. It can also contain the bounds of labels belonging to those nodes and edges.

The TreeLayout.SubtreeShape also describes a connector defining the location to which the edge from its parent is attached. It is possible to add some bends (target points) at the end of this edge and include them in the TreeLayout.SubtreeShape. During layout calculation, the last target point is the connection point for the edge.

See Also:

getBorderLine(int), getConnectorX(), getConnectorY(), addBoundsToShape(double, double, double, double), addTargetPoint(double, double)

Method Summary

Modifier and Type	Method and Description
void	addBoundsToShape(double x, double y, double width, double height) Extends this TreeLayout.SubtreeShape instance by the given rectangle.
void	addEdgeSegments(LayoutGraph graph, Edge edge) Adds all edge segments of the given edge to this TreeLayout.SubtreeShape instance.
void	addLineSegment(double x1, double y1, double x2, double y2) Extends this TreeLayout.SubtreeShape instance by the given segment.
void	addTargetPoint(double x, double y) Adds another point to the connector.
void	appendTargetPoints(IEdgeLayout edgeLayout) Appends all target points that have previously been added to this shape to the given IEdgeLayout instance.
void	assignValuesTo(TreeLayout.SubtreeShape toShape, AbstractRotatableNodePlacer.Matrix modificationMatrix) Copies the state of this TreeLayout.SubtreeShape instance to the given shape applying a modification matrix.
TreeLayout.SubtreeShape	createCopy(AbstractRotatableNodePlacer.Matrix matrix) Creates a clone of this TreeLayout.SubtreeShape instance, modifying it using the provided modification matrix.
BorderLine	getBorderLine(int index) Returns the BorderLine instance that describes the TreeLayout.SubtreeShape at the given side.
Rectangle2D	getBounds() Gets the current bounds of this TreeLayout.SubtreeShape instance.
ConnectorDirection	getConnectorDirection() Gets the direction of the last connector segment.
double	getConnectorX() Gets the current x-coordinate of the connection point to which the layout algorithm connects the ingoing edge.
double	getConnectorY() Gets the current y-coordinate of the connection point to which the layout algorithm connects the ingoing edge.
Rectangle2D	getCoreBounds() Gets the bounds of the INodeLayout of the root node of this TreeLayout.SubtreeShape instance.
double	getMaxX() Gets the current maximum x-coordinate of this TreeLayout.SubtreeShape instance.
double	getMaxY() Gets the current maximum y-coordinate of this TreeLayout.SubtreeShape instance.
double	getMinX() Gets the current minimum x-coordinate of this TreeLayout.SubtreeShape instance.
double	getMinY() Gets the current minimum y-coordinate of this TreeLayout.SubtreeShape instance.
double	getOriginX() Gets the current x-coordinate of the origin of this TreeLayout.SubtreeShape instance.
double	getOriginY() Gets the current y-coordinate of the origin of this TreeLayout.SubtreeShape instance.
void	mergeWith(TreeLayout.SubtreeShape other) Merges the given TreeLayout.SubtreeShape instance with this TreeLayout.SubtreeShape instance.
void	move(double dx, double dy) Moves this TreeLayout.SubtreeShape instance and its connector by the given offsets.
String	toString() Returns a string representation of the TreeLayout.SubtreeShape instance.
void	updateConnectorShape() Adds the line segments of the connector to the bounds of this TreeLayout.SubtreeShape instance.

Methods inherited from class java.lang.Object

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

Method Detail

addBoundsToShape

public final void addBoundsToShape(double x,
                                   double y,
                                   double width,
                                   double height)

Extends this TreeLayout.SubtreeShape instance by the given rectangle.

The border lines are updated with this segment.

Parameters:

x - the x-coordinate of the upper-left corner of the rectangle

y - the y-coordinate of the upper-left corner of the rectangle

width - the width of the rectangle

height - the height of the rectangle

See Also:

getBorderLine(int)

addEdgeSegments

public final void addEdgeSegments(LayoutGraph graph,
                                  Edge edge)

Adds all edge segments of the given edge to this TreeLayout.SubtreeShape instance.

The border lines are updated.

Parameters:

graph - the input graph

edge - the given edge

See Also:

getBorderLine(int), addLineSegment(double, double, double, double)

addLineSegment

public final void addLineSegment(double x1,
                                 double y1,
                                 double x2,
                                 double y2)

Extends this TreeLayout.SubtreeShape instance by the given segment.

The border lines are updated with this segment.

Parameters:

x1 - the x-coordinate of the first point of the segment

y1 - the y-coordinate of the first point of the segment

x2 - the x-coordinate of the second point of the segment

y2 - the y-coordinate of the second point of the segment

See Also:

getBorderLine(int), addEdgeSegments(LayoutGraph, Edge), updateConnectorShape()

addTargetPoint

public final void addTargetPoint(double x,
                                 double y)

Adds another point to the connector.

The points will appear as bend of the incoming edge. Points are added in reverse direction of the edge. Hence, the last target point is further away from the target node than the points before.

Parameters:

x - the current x-coordinate of the point

y - the current y-coordinate of the point

appendTargetPoints

public final void appendTargetPoints(IEdgeLayout edgeLayout)

Appends all target points that have previously been added to this shape to the given IEdgeLayout instance.

This method is used by INodePlacer instances for the final edge paths.

Parameters:

edgeLayout - the IEdgeLayout that will be modified

See Also:

addTargetPoint(double, double)

assignValuesTo

public final void assignValuesTo(TreeLayout.SubtreeShape toShape,
                                 AbstractRotatableNodePlacer.Matrix modificationMatrix)

Copies the state of this TreeLayout.SubtreeShape instance to the given shape applying a modification matrix.

Parameters:

toShape - the given shape that gets the assigned values

modificationMatrix - the matrix that may add geometrical modifications

createCopy

public final TreeLayout.SubtreeShape createCopy(AbstractRotatableNodePlacer.Matrix matrix)

Creates a clone of this TreeLayout.SubtreeShape instance, modifying it using the provided modification matrix.

Parameters:

matrix - the matrix that defines the modification for the new instance

Returns:

the clone of this TreeLayout.SubtreeShape instance

See Also:

AbstractRotatableNodePlacer.Matrix.DEFAULT

getBorderLine

public final BorderLine getBorderLine(int index)

Returns the BorderLine instance that describes the TreeLayout.SubtreeShape at the given side.

Throws:

IllegalArgumentException - if the given index is invalid

Parameters:

index - one of the predefined borderline directions

Returns:

the BorderLine instance for the given side

getBounds

public final Rectangle2D getBounds()

Gets the current bounds of this TreeLayout.SubtreeShape instance.

Returns:

the bounds of the subtree

getConnectorDirection

public final ConnectorDirection getConnectorDirection()

Gets the direction of the last connector segment.

Returns:

one of ConnectorDirection.NORTH,ConnectorDirection.EAST,ConnectorDirection.SOUTH or ConnectorDirection.WEST

getConnectorX

public final double getConnectorX()

Gets the current x-coordinate of the connection point to which the layout algorithm connects the ingoing edge.

The connection point can change when target points are added to the TreeLayout.SubtreeShape instance.

Returns:

the x-coordinate of the connection point

See Also:

addTargetPoint(double, double), appendTargetPoints(IEdgeLayout)

getConnectorY

public final double getConnectorY()

Gets the current y-coordinate of the connection point to which the layout algorithm connects the ingoing edge.

The connection point can change when target points are added to the TreeLayout.SubtreeShape instance.

Returns:

the y-coordinate of the connection point

See Also:

addTargetPoint(double, double), appendTargetPoints(IEdgeLayout)

getCoreBounds

public final Rectangle2D getCoreBounds()

Gets the bounds of the INodeLayout of the root node of this TreeLayout.SubtreeShape instance.

Returns:

the bounds of the root node

getMaxX

public final double getMaxX()

Gets the current maximum x-coordinate of this TreeLayout.SubtreeShape instance.

Returns:

the maximum x-coordinate of this TreeLayout.SubtreeShape

getMaxY

public final double getMaxY()

Gets the current maximum y-coordinate of this TreeLayout.SubtreeShape instance.

Returns:

the maximum y-coordinate of this TreeLayout.SubtreeShape

getMinX

public final double getMinX()

Gets the current minimum x-coordinate of this TreeLayout.SubtreeShape instance.

Returns:

the minimum x-coordinate of this TreeLayout.SubtreeShape

getMinY

public final double getMinY()

Gets the current minimum y-coordinate of this TreeLayout.SubtreeShape instance.

Returns:

the minimum y-coordinate of this TreeLayout.SubtreeShape

getOriginX

public final double getOriginX()

Gets the current x-coordinate of the origin of this TreeLayout.SubtreeShape instance.

The origin is defined as the upper left corner of the INodeLayout of the local root of this shape.

Returns:

the x-coordinate of the shape's origin

getOriginY

public final double getOriginY()

Gets the current y-coordinate of the origin of this TreeLayout.SubtreeShape instance.

The origin is defined as the upper left corner of the INodeLayout of the local root of this shape.

Returns:

the y-coordinate of the shape's origin

mergeWith

public final void mergeWith(TreeLayout.SubtreeShape other)

Merges the given TreeLayout.SubtreeShape instance with this TreeLayout.SubtreeShape instance.

The border lines are updated.

Parameters:

other - the TreeLayout.SubtreeShape to be merged with this TreeLayout.SubtreeShape

move

public final void move(double dx,
                       double dy)

Moves this TreeLayout.SubtreeShape instance and its connector by the given offsets.

Border lines are updated.

This is a cheap operation and does not depend on the size or complexity of the shape or connector.

Parameters:

dx - the delta x-offset by which this shape will be moved

dy - the delta y-offset by which this shape will be moved

toString

public String toString()

Returns a string representation of the TreeLayout.SubtreeShape instance.

Overrides:

toString in class Object

Returns:

a string representation of the TreeLayout.SubtreeShape instance

updateConnectorShape

public final void updateConnectorShape()

Adds the line segments of the connector to the bounds of this TreeLayout.SubtreeShape instance.

The line segments result from the target points.

See Also:

addTargetPoint(double, double)