Search this API

y.layout.router.polyline
Class PartitionCell.PartitionCellBorder

java.lang.Object
  extended by y.layout.router.polyline.PartitionCell.PartitionCellBorder
Enclosing class:
PartitionCell

public static class PartitionCell.PartitionCellBorder
extends java.lang.Object

This class is a type-safe enumeration used for defining the border of a PartitionCell.

See Also:
PartitionCell.createBorderInterval(PartitionCellBorder)
 
Your browser does not support SVG content.

Field Summary
static PartitionCell.PartitionCellBorder EAST
          A type constant that defines the right border of a PartitionCell.
static PartitionCell.PartitionCellBorder NORTH
          A type constant that defines the upper border of a PartitionCell.
static PartitionCell.PartitionCellBorder SOUTH
          A type constant that defines the bottom border of a PartitionCell.
static PartitionCell.PartitionCellBorder WEST
          A type constant that defines the left border of a PartitionCell.
 
Method Summary
 PartitionCell.PartitionCellBorder getMirrorBorder()
          Returns the type of the border that is on the opposite side of the border defined by this type.
static PartitionCell.PartitionCellBorder valueOfEnterDirection(Direction direction)
          Returns the type of the border that is passed through when entering a PartitionCell in the given direction.
static PartitionCell.PartitionCellBorder valueOfExitDirection(Direction direction)
          Returns the type of the border that is passed through when exiting a PartitionCell in the given direction.
static PartitionCell.PartitionCellBorder valueOfPortCandidate(PortCandidate pc)
          Returns the type of the border that is defined by the given PortCandidate.
static PartitionCell.PartitionCellBorder valueOfPortConstraint(PortConstraint pc)
          Returns the type of the border that is defined by the given PortConstraint.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

NORTH

public static final PartitionCell.PartitionCellBorder NORTH
A type constant that defines the upper border of a PartitionCell.

See Also:
PartitionCell.createBorderInterval(PartitionCellBorder)

SOUTH

public static final PartitionCell.PartitionCellBorder SOUTH
A type constant that defines the bottom border of a PartitionCell.

See Also:
PartitionCell.createBorderInterval(PartitionCellBorder)

EAST

public static final PartitionCell.PartitionCellBorder EAST
A type constant that defines the right border of a PartitionCell.

See Also:
PartitionCell.createBorderInterval(PartitionCellBorder)

WEST

public static final PartitionCell.PartitionCellBorder WEST
A type constant that defines the left border of a PartitionCell.

See Also:
PartitionCell.createBorderInterval(PartitionCellBorder)
Method Detail

valueOfExitDirection

public static PartitionCell.PartitionCellBorder valueOfExitDirection(Direction direction)
Returns the type of the border that is passed through when exiting a PartitionCell in the given direction.

Parameters:
direction - the direction in which a PartitionCell has been exited
Returns:
the type of the border that is passed through when exiting a PartitionCell
See Also:
PartitionCell

valueOfEnterDirection

public static PartitionCell.PartitionCellBorder valueOfEnterDirection(Direction direction)
Returns the type of the border that is passed through when entering a PartitionCell in the given direction.

Parameters:
direction - the direction in which a PartitionCell has been entered
Returns:
the type of the border that is passed through when entering a PartitionCell
See Also:
PartitionCell

valueOfPortConstraint

public static PartitionCell.PartitionCellBorder valueOfPortConstraint(PortConstraint pc)
Returns the type of the border that is defined by the given PortConstraint. The border type corresponds to the side of the given PortConstraint.

Parameters:
pc - the port constraint for which the border type is returned
Returns:
the type of the border that is defined by the given port constraint
See Also:
PortConstraint

valueOfPortCandidate

public static PartitionCell.PartitionCellBorder valueOfPortCandidate(PortCandidate pc)
Returns the type of the border that is defined by the given PortCandidate. The border type corresponds to the direction of the given PortCandidate.

Parameters:
pc - the port candidate for which the border type is returned
Returns:
the type of the border that is defined by the given port candidate
See Also:
PortCandidate

getMirrorBorder

public PartitionCell.PartitionCellBorder getMirrorBorder()
Returns the type of the border that is on the opposite side of the border defined by this type.

Returns:
the type of the border that is on the opposite side of the border defined by this type

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