Packagecom.yworks.yfiles.layout.router
Classpublic class BusDescriptor
InheritanceBusDescriptor Inheritance YObject Inheritance Object

A descriptor for bus-related information to be associated with an edge. It consists of a bus ID defining the bus of the associated edge, two optional edge group IDs for specifying the edge grouping at the source and target side, respectively, and an optional boolean flag to mark the edge as fixed.

Every object except null can be used as valid bus ID. Every edge of ID null forms a group of its own. Also, every object except null can be used as valid edge group ID. If there is no group ID defined for an edge or if null is set, a default group ID is used. Therefore, all such edges ending at the same node belong to the same group.


Public Properties
 PropertyDefined By
  busId : Object
Specifies the bus ID.
BusDescriptor
  fixed : Boolean
Specifies whether the associated edge is fixed or not.
BusDescriptor
  sourceGroupId : Object
Specifies the new group ID for the source side of the edge.
BusDescriptor
  targetGroupId : Object
Specifies the new group ID for the target side of the edge.
BusDescriptor
Public Methods
 MethodDefined By
  
BusDescriptor(busID:Object, init:Boolean = true)
Creates a new instance of BusDescriptor for the specified bus ID which is marked as not fixed and uses the default edge group IDs.
BusDescriptor
  
equals(obj:Object):Boolean
[override] Indicates whether some other object is "equal to" this one.
BusDescriptor
  
getClass():Class
[override]
BusDescriptor
  
hashCode():int
[override]
BusDescriptor
  
newBusDescriptor1(busID:Object):BusDescriptor
[static] Creates a new instance of BusDescriptor for the specified bus ID which is marked as not fixed and uses the default edge group IDs.
BusDescriptor
  
newBusDescriptor2(busID:Object, fixed:Boolean):BusDescriptor
[static] Creates a new instance of BusDescriptor for the specified parameters and default group IDs.
BusDescriptor
  
newBusDescriptor3(busID:Object, sourceGroupID:Object, targetGroupID:Object):BusDescriptor
[static] Creates a new instance of BusDescriptor for the specified parameters and marks it as not fixed.
BusDescriptor
  
newBusDescriptor4(busID:Object, fixed:Boolean, sourceGroupID:Object, targetGroupID:Object):BusDescriptor
[static] Creates a new instance of BusDescriptor for the specified parameters.
BusDescriptor
  
toString():String
Returns a string consisting of the bus ID, the fixed flag, and both group IDs.
BusDescriptor
Protected Methods
 MethodDefined By
  
initBusDescriptor1(busID:Object):void
Initializes this object.
BusDescriptor
  
initBusDescriptor2(busID:Object, fixed:Boolean):void
Initializes this object.
BusDescriptor
  
initBusDescriptor3(busID:Object, sourceGroupID:Object, targetGroupID:Object):void
Initializes this object.
BusDescriptor
  
initBusDescriptor4(busID:Object, fixed:Boolean, sourceGroupID:Object, targetGroupID:Object):void
Initializes this object.
BusDescriptor
Property Detail
busIdproperty
busId:Object

Specifies the bus ID.


Implementation
    public function get busId():Object
    public function set busId(value:Object):void
fixedproperty 
fixed:Boolean

Specifies whether the associated edge is fixed or not.


Implementation
    public function get fixed():Boolean
    public function set fixed(value:Boolean):void
sourceGroupIdproperty 
sourceGroupId:Object

Specifies the new group ID for the source side of the edge.


Implementation
    public function get sourceGroupId():Object
    public function set sourceGroupId(value:Object):void
targetGroupIdproperty 
targetGroupId:Object

Specifies the new group ID for the target side of the edge.


Implementation
    public function get targetGroupId():Object
    public function set targetGroupId(value:Object):void
Constructor Detail
BusDescriptor()Constructor
public function BusDescriptor(busID:Object, init:Boolean = true)

Creates a new instance of BusDescriptor for the specified bus ID which is marked as not fixed and uses the default edge group IDs.

Parameters
busID:Object — the ID of the bus the associated edge belongs to
 
init:Boolean (default = true) — An internally used switch to help handle proper instance initialization in inheritance chains where classes can have multiple constructor-like factory methods. This parameter can safely be ignored/omitted when calling the constructor.
Method Detail
equals()method
override public function equals(obj:Object):Boolean

Indicates whether some other object is "equal to" this one.

Parameters

obj:Object — the reference object with which to compare.

Returns
Boolean — true if all corresponding parameters are equal; false otherwise.
getClass()method 
override public function getClass():Class

Returns
Class
hashCode()method 
override public function hashCode():int

Returns
int
initBusDescriptor1()method 
protected final function initBusDescriptor1(busID:Object):void

Initializes this object. See the documentation of the corresponding factory method newBusDescriptor1() for details.

Parameters

busID:Object

See also

newBusDescriptor1()
initBusDescriptor2()method 
protected final function initBusDescriptor2(busID:Object, fixed:Boolean):void

Initializes this object. See the documentation of the corresponding factory method newBusDescriptor2() for details.

Parameters

busID:Object
 
fixed:Boolean

See also

newBusDescriptor2()
initBusDescriptor3()method 
protected final function initBusDescriptor3(busID:Object, sourceGroupID:Object, targetGroupID:Object):void

Initializes this object. See the documentation of the corresponding factory method newBusDescriptor3() for details.

Parameters

busID:Object
 
sourceGroupID:Object
 
targetGroupID:Object

See also

newBusDescriptor3()
initBusDescriptor4()method 
protected final function initBusDescriptor4(busID:Object, fixed:Boolean, sourceGroupID:Object, targetGroupID:Object):void

Initializes this object. See the documentation of the corresponding factory method newBusDescriptor4() for details.

Parameters

busID:Object
 
fixed:Boolean
 
sourceGroupID:Object
 
targetGroupID:Object

See also

newBusDescriptor4()
newBusDescriptor1()method 
public static function newBusDescriptor1(busID:Object):BusDescriptor

Creates a new instance of BusDescriptor for the specified bus ID which is marked as not fixed and uses the default edge group IDs.

Parameters

busID:Object — the ID of the bus the associated edge belongs to

Returns
BusDescriptor
newBusDescriptor2()method 
public static function newBusDescriptor2(busID:Object, fixed:Boolean):BusDescriptor

Creates a new instance of BusDescriptor for the specified parameters and default group IDs.

Parameters

busID:Object — the ID of the bus the associated edge belongs to
 
fixed:Boolean — whether the associated edge is fixed or not

Returns
BusDescriptor
newBusDescriptor3()method 
public static function newBusDescriptor3(busID:Object, sourceGroupID:Object, targetGroupID:Object):BusDescriptor

Creates a new instance of BusDescriptor for the specified parameters and marks it as not fixed.

Parameters

busID:Object — the ID of the bus the associated edge belongs to
 
sourceGroupID:Object — the group ID of the source side
 
targetGroupID:Object — the group ID of the target side

Returns
BusDescriptor
newBusDescriptor4()method 
public static function newBusDescriptor4(busID:Object, fixed:Boolean, sourceGroupID:Object, targetGroupID:Object):BusDescriptor

Creates a new instance of BusDescriptor for the specified parameters.

Parameters

busID:Object — the ID of the bus the associated edge belongs to
 
fixed:Boolean — whether the associated edge is fixed or not
 
sourceGroupID:Object — the group ID of the source side
 
targetGroupID:Object — the group ID of the target side

Returns
BusDescriptor
toString()method 
public function toString():String

Returns a string consisting of the bus ID, the fixed flag, and both group IDs.

Returns
String — a string consisting of the bus ID, the fixed flag, and both group IDs




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