com.yworks.yfiles.layout

Class Direction

java.lang.Object

com.yworks.yfiles.layout.Direction

public final class Direction
extends Object

Direction provides four main directions and some methods to work with them.

There is exactly one immutable object for each direction.

Field Summary

Fields

Modifier and Type	Field and Description
static Direction	DOWN Decodes the down direction.
static Direction	LEFT Decodes the left direction.
static Direction	RIGHT Decodes the right direction.
static Direction	UP Decodes the up direction.

Method Summary

Modifier and Type	Method and Description
int	getDirection() Returns the direction encoded as an integer value.
Direction	getMirror() Gets the mirror direction.
Direction	getTurnCCW() Gets the direction that follows this direction in counterclockwise order.
Direction	getTurnCW() Gets the direction that follows this direction in clockwise order.
boolean	isHorizontal() Gets whether or not this direction is horizontal (RIGHT or LEFT).
boolean	isVertical() Gets whether or not this direction is vertical (UP or DOWN).
String	toString() Returns a string representation of the direction.

Methods inherited from class java.lang.Object

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

Field Detail

DOWN

public static final Direction DOWN

Decodes the down direction.

LEFT

public static final Direction LEFT

Decodes the left direction.

RIGHT

public static final Direction RIGHT

Decodes the right direction.

UP

public static final Direction UP

Decodes the up direction.

Method Detail

getDirection

public final int getDirection()

Returns the direction encoded as an integer value.

Returns:

0 for direction UP, 1 for RIGHT, 2 for DOWN, and 3 for LEFT

getMirror

public final Direction getMirror()

Gets the mirror direction.

The new direction is turned 180 degrees compared to this instance.

Throws:

IllegalArgumentException - if the current direction value is invalid

Returns:

the mirrored direction

getTurnCCW

public final Direction getTurnCCW()

Gets the direction that follows this direction in counterclockwise order.

The new direction is turned 90 degrees in counterclockwise direction compared to this instance.

Throws:

IllegalArgumentException - if the current direction value is invalid

Returns:

the turned direction

getTurnCW

public final Direction getTurnCW()

Gets the direction that follows this direction in clockwise order.

The new direction is turned 90 degrees in clockwise direction compared to this instance.

Throws:

IllegalArgumentException - if the current direction value is invalid

Returns:

the turned direction

isHorizontal

public final boolean isHorizontal()

Gets whether or not this direction is horizontal (RIGHT or LEFT).

Returns:

true if this direction is horizontal, false otherwise

isVertical

public final boolean isVertical()

Gets whether or not this direction is vertical (UP or DOWN).

Returns:

true if this direction is vertical, false otherwise

toString

public String toString()

Returns a string representation of the direction.

Overrides:

toString in class Object

Throws:

IllegalArgumentException - if the current direction value is invalid

Returns:

^ for UP, > for RIGHT, v for DOWN, and < for LEFT.