Packagecom.yworks.yfiles.layout
Classpublic class Direction
InheritanceDirection Inheritance YObject Inheritance Object

Class that represents directions. Note: for each direction there exists exactly one object.


Public Properties
 PropertyDefined By
  horizontal : Boolean
[read-only] Returns true if this direction is horizontal (right or left).
Direction
  mirror : Direction
[read-only] Returns the mirror direction (turns the direction two times).
Direction
  turnCCW : Direction
[read-only] Returns the direction that follows this direction in counterclockwise order.
Direction
  turnCW : Direction
[read-only] Returns the direction that follows this direction in clockwise order.
Direction
  vertical : Boolean
[read-only] Returns true if this direction is vertical (up or down).
Direction
Public Methods
 MethodDefined By
  
Direction(init:Boolean = true)
Direction
 Inherited
equals(o:Object):Boolean
YObject
  
getClass():Class
[override]
Direction
  
getDirection():int
Returns the direction as int value.
Direction
 Inherited
hashCode():int
YObject
  
toString():String
Returns the current direction as string.
Direction
Public Constants
 ConstantDefined By
  DOWN : Direction
[static] Decodes the down direction
Direction
  LEFT : Direction
[static] Decodes the left direction
Direction
  RIGHT : Direction
[static] Decodes the right direction
Direction
  UP : Direction
[static] Decodes the up direction
Direction
Property Detail
horizontalproperty
horizontal:Boolean  [read-only]

Returns true if this direction is horizontal (right or left).


Implementation
    public function get horizontal():Boolean
mirrorproperty 
mirror:Direction  [read-only]

Returns the mirror direction (turns the direction two times).


Implementation
    public function get mirror():Direction
turnCCWproperty 
turnCCW:Direction  [read-only]

Returns the direction that follows this direction in counterclockwise order.


Implementation
    public function get turnCCW():Direction
turnCWproperty 
turnCW:Direction  [read-only]

Returns the direction that follows this direction in clockwise order.


Implementation
    public function get turnCW():Direction
verticalproperty 
vertical:Boolean  [read-only]

Returns true if this direction is vertical (up or down).


Implementation
    public function get vertical():Boolean
Constructor Detail
Direction()Constructor
public function Direction(init:Boolean = true)



Parameters
init:Boolean (default = true)
Method Detail
getClass()method
override public function getClass():Class

Returns
Class
getDirection()method 
public function getDirection():int

Returns the direction as int value.

Returns
int — 0 for UP, 1 for RIGHT, 2 for DOWN, and 3 for LEFT.
toString()method 
public function toString():String

Returns the current direction as string.

Returns
String — ^ for UP, > for RIGHT, v for DOWN, and < for LEFT.
Constant Detail
DOWNConstant
public static const DOWN:Direction

Decodes the down direction

LEFTConstant 
public static const LEFT:Direction

Decodes the left direction

RIGHTConstant 
public static const RIGHT:Direction

Decodes the right direction

UPConstant 
public static const UP:Direction

Decodes the up direction





Wed Oct 7 2015, 04:43 PM +02:00